Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthConfig ¶
AuthConfig defines registry authentication credentials.
type Config ¶
type Config struct { Cache libcompose.Stringorslice Platform string Branches Constraint Workspace Workspace Clone Containers Pipeline Containers Services Containers Networks Networks Volumes Volumes Labels libcompose.SliceorMap DependsOn []string `yaml:"depends_on,omitempty"` RunsOn []string `yaml:"runs_on,omitempty"` SkipClone bool `yaml:"skip_clone"` }
Config defines a pipeline configuration.
func ParseBytes ¶
ParseBytes parses the configuration from bytes b.
func ParseString ¶
ParseString parses the configuration from string s.
type Constraint ¶
Constraint defines a runtime constraint.
func (*Constraint) Excludes ¶
func (c *Constraint) Excludes(v string) bool
Excludes returns true if the string matches the exclude patterns.
func (*Constraint) Includes ¶
func (c *Constraint) Includes(v string) bool
Includes returns true if the string matches the include patterns.
func (*Constraint) Match ¶
func (c *Constraint) Match(v string) bool
Match returns true if the string matches the include patterns and does not match any of the exclude patterns.
func (*Constraint) UnmarshalYAML ¶
func (c *Constraint) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML unmarshals the constraint.
type ConstraintMap ¶
ConstraintMap defines a runtime constraint map.
func (*ConstraintMap) Match ¶
func (c *ConstraintMap) Match(params map[string]string) bool
Match returns true if the params matches the include key values and does not match any of the exclude key values.
func (*ConstraintMap) UnmarshalYAML ¶
func (c *ConstraintMap) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML unmarshals the constraint map.
type Constraints ¶
type Constraints struct { Ref Constraint Repo Constraint Instance Constraint Platform Constraint Environment Constraint Event Constraint Branch Constraint Status Constraint Matrix ConstraintMap Local types.BoolTrue }
Constraints defines a set of runtime constraints.
type Container ¶
type Container struct { AuthConfig AuthConfig `yaml:"auth_config,omitempty"` CapAdd []string `yaml:"cap_add,omitempty"` CapDrop []string `yaml:"cap_drop,omitempty"` Command libcompose.Command `yaml:"command,omitempty"` Commands libcompose.Stringorslice `yaml:"commands,omitempty"` CPUQuota libcompose.StringorInt `yaml:"cpu_quota,omitempty"` CPUSet string `yaml:"cpuset,omitempty"` Detached bool `yaml:"detach,omitempty"` Devices []string `yaml:"devices,omitempty"` Tmpfs []string `yaml:"tmpfs,omitempty"` DNS libcompose.Stringorslice `yaml:"dns,omitempty"` DNSSearch libcompose.Stringorslice `yaml:"dns_search,omitempty"` Entrypoint libcompose.Command `yaml:"entrypoint,omitempty"` Environment libcompose.SliceorMap `yaml:"environment,omitempty"` ExtraHosts []string `yaml:"extra_hosts,omitempty"` Group string `yaml:"group,omitempty"` Image string `yaml:"image,omitempty"` Isolation string `yaml:"isolation,omitempty"` Labels libcompose.SliceorMap `yaml:"labels,omitempty"` MemLimit libcompose.MemStringorInt `yaml:"mem_limit,omitempty"` MemSwapLimit libcompose.MemStringorInt `yaml:"memswap_limit,omitempty"` MemSwappiness libcompose.MemStringorInt `yaml:"mem_swappiness,omitempty"` Name string `yaml:"name,omitempty"` NetworkMode string `yaml:"network_mode,omitempty"` IpcMode string `yaml:"ipc_mode,omitempty"` Networks libcompose.Networks `yaml:"networks,omitempty"` Privileged bool `yaml:"privileged,omitempty"` Pull bool `yaml:"pull,omitempty"` ShmSize libcompose.MemStringorInt `yaml:"shm_size,omitempty"` Ulimits libcompose.Ulimits `yaml:"ulimits,omitempty"` Volumes libcompose.Volumes `yaml:"volumes,omitempty"` Secrets Secrets `yaml:"secrets,omitempty"` Sysctls libcompose.SliceorMap `yaml:"sysctls,omitempty"` Constraints Constraints `yaml:"when,omitempty"` Vargs map[string]interface{} `yaml:",inline"` }
Container defines a container.
type Containers ¶
type Containers struct {
Containers []*Container
}
Containers denotes an ordered collection of containers.
func (*Containers) UnmarshalYAML ¶
func (c *Containers) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements the Unmarshaller interface.
type Network ¶
type Network struct { Name string `yaml:"name,omitempty"` Driver string `yaml:"driver,omitempty"` DriverOpts map[string]string `yaml:"driver_opts,omitempty"` }
Network defines a container network.
type Networks ¶
type Networks struct {
Networks []*Network
}
Networks defines a collection of networks.
func (*Networks) UnmarshalYAML ¶
UnmarshalYAML implements the Unmarshaller interface.
type Secrets ¶
type Secrets struct {
Secrets []*Secret
}
Secrets defines a collection of secrets.
func (*Secrets) UnmarshalYAML ¶
UnmarshalYAML implements the Unmarshaller interface.
type Volume ¶
type Volume struct { Name string `yaml:"name,omitempty"` Driver string `yaml:"driver,omitempty"` DriverOpts map[string]string `yaml:"driver_opts,omitempty"` }
Volume defines a container volume.
type Volumes ¶
type Volumes struct {
Volumes []*Volume
}
Volumes defines a collection of volumes.
func (*Volumes) UnmarshalYAML ¶
UnmarshalYAML implements the Unmarshaller interface.