Documentation
¶
Index ¶
- func Combine(fns ...func(*engine.Spec)) func(*engine.Spec)
- func Exclude(names []string) func(*engine.Spec)
- func Include(names []string) func(*engine.Spec)
- func ResumeAt(name string) func(*engine.Spec)
- func WithAuths(auths []*engine.DockerAuth) func(*engine.Spec)
- func WithAuthsFunc(f AuthsFunc) func(*engine.Spec)
- func WithEnviron(envs map[string]string) func(*engine.Spec)
- func WithLables(labels map[string]string) func(*engine.Spec)
- func WithLimits(memlimit, cpulimit int64) func(*engine.Spec)
- func WithNetrc(machine, username, password string) func(*engine.Spec)
- func WithNetworks(networks []string) func(*engine.Spec)
- func WithProxy() func(*engine.Spec)
- func WithSecretFunc(f SecretFunc) func(*engine.Spec)
- func WithSecrets(secrets map[string]string) func(*engine.Spec)
- func WithVolumeSlice(volumes []string) func(*engine.Spec)
- func WithVolumes(volumes map[string]string) func(*engine.Spec)
- type AuthsFunc
- type SecretFunc
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Exclude ¶
Exclude is a transform function that limits the pipeline execution to a whitelist of named steps.
func Include ¶
Include is a transform function that limits the pipeline execution to a whitelist of named steps.
func ResumeAt ¶
ResumeAt is a transform function that modifies the exuction to resume at a named step.
func WithAuths ¶
func WithAuths(auths []*engine.DockerAuth) func(*engine.Spec)
WithAuths is a transform function that adds a set of global registry credentials to the container.
func WithAuthsFunc ¶
WithAuthsFunc is a transform function that provides the sepcification with registry authentication credentials via a callback function.
func WithEnviron ¶
WithEnviron is a transform function that adds a set of environment variables to each container.
func WithLables ¶
WithLables is a transform function that adds a set of labels to each resource.
func WithLimits ¶
WithLimits is a transform function that applies resource limits to the container processes.
func WithNetrc ¶
WithNetrc is a helper function that creates a netrc file and mounts the file to all container steps.
func WithNetworks ¶
WithNetworks is a transform function that attaches a list of user-defined Docker networks to each step.
func WithProxy ¶
WithProxy is a transform function that adds the http_proxy environment variables to every container.
func WithSecretFunc ¶
func WithSecretFunc(f SecretFunc) func(*engine.Spec)
WithSecretFunc is a transform function that resolves all named secrets through a callback function, and adds the secrets to the specification.
func WithSecrets ¶
WithSecrets is a transform function that adds a set of global secrets to the container.
func WithVolumeSlice ¶
WithVolumeSlice is a transform function that adds a set of global volumes to the container that are defined in --volume=host:container format.
Types ¶
type AuthsFunc ¶
type AuthsFunc func() []*engine.DockerAuth
AuthsFunc is a callback function used to request registry credentials to pull private images.
type SecretFunc ¶
SecretFunc is a callback function used to request named secret, required by a pipeline step.
Source Files