Documentation ¶
Index ¶
- type Cacher
- type Compiler
- type Option
- func WithCacher(cacher Cacher) Option
- func WithEnviron(env map[string]string) Option
- func WithEscalated(images ...string) Option
- func WithLocal(local bool) Option
- func WithMetadata(metadata frontend.Metadata) Option
- func WithNetrc(username, password, machine string) Option
- func WithNetworks(networks ...string) Option
- func WithOption(option Option, b bool) Option
- func WithPrefix(prefix string) Option
- func WithProxy() Option
- func WithRegistry(registries ...Registry) Option
- func WithResourceLimit(swap, mem, shmsize, cpuQuota, cpuShares int64, cpuSet string) Option
- func WithS3Cacher(access, secret, region, bucket string) Option
- func WithSecret(secrets ...Secret) Option
- func WithVolumeCacher(base string) Option
- func WithVolumes(volumes ...string) Option
- func WithWorkspace(base, path string) Option
- func WithWorkspaceFromURL(base, link string) Option
- type Registry
- type ResourceLimit
- type Secret
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Cacher ¶
type Cacher interface { Restore(repo, branch string, mounts []string) *yaml.Container Rebuild(repo, branch string, mounts []string) *yaml.Container }
Cacher defines a compiler transform that can be used to implement default caching for a repository.
type Compiler ¶
type Compiler struct {
// contains filtered or unexported fields
}
Compiler compiles the yaml
type Option ¶
type Option func(*Compiler)
Option configures a compiler option.
func WithCacher ¶
WithCacher configures the compiler with default cache settings.
func WithEnviron ¶
WithEnviron configures the compiler with environment variables added by default to every container in the pipeline.
func WithEscalated ¶
WithEscalated configures the compiler to automatically execute images as privileged containers if the match the given list.
func WithLocal ¶
WithLocal configures the compiler with the local flag. The local flag indicates the pipeline execution is running in a local development environment with a mounted local working directory.
func WithMetadata ¶
WithMetadata configutes the compiler with the repostiory, build and system metadata. The metadata is used to remove steps from the compiled pipeline configuration that should be skipped. The metadata is also added to each container as environment variables.
func WithNetrc ¶
WithNetrc configures the compiler with netrc authentication credentials added by default to every container in the pipeline.
func WithNetworks ¶
WithNetworks configures the compiler with additionnal networks to be connected to build containers
func WithOption ¶
WithOption configures the compiler with the given option if boolean b evaluates to true.
func WithPrefix ¶
WithPrefix configures the compiler with the prefix. The prefix is used to prefix container, volume and network names to avoid collision at runtime.
func WithProxy ¶
func WithProxy() Option
WithProxy configures the compiler with HTTP_PROXY, HTTPS_PROXY, and NO_PROXY environment variables added by default to every container in the pipeline.
func WithRegistry ¶
WithRegistry configures the compiler with registry credentials that should be used to download images.
func WithResourceLimit ¶
WithResourceLimit configures the compiler with default resource limits that are applied each container in the pipeline.
func WithS3Cacher ¶
WithS3Cacher configures the compiler with default amazon s3 caching enabled.
func WithSecret ¶
WithSecret configures the compiler with external secrets to be injected into the container at runtime.
func WithVolumeCacher ¶
WithVolumeCacher configures the compiler with default local volume caching enabled.
func WithVolumes ¶
WithVolumes configutes the compiler with default volumes that are mounted to each container in the pipeline.
func WithWorkspace ¶
WithWorkspace configures the compiler with the workspace base and path. The workspace base is a volume created at runtime and mounted into all containers in the pipeline. The base and path are joined to provide the working directory for all build and plugin steps in the pipeline.
func WithWorkspaceFromURL ¶
WithWorkspaceFromURL configures the compiler with the workspace base and path based on the repository url.