config

package
v0.15.18 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 29, 2017 License: Apache-2.0 Imports: 6 Imported by: 20

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config 

type Config struct {
	Version             string                       `yaml:"version,omitempty"`
	Services            map[string]*ServiceConfig    `yaml:"services,omitempty"`
	Containers          map[string]*ServiceConfig    `yaml:"containers,omitempty"`
	Dependencies        map[string]*DependencyConfig `yaml:"dependencies,omitempty"`
	Volumes             map[string]*VolumeConfig     `yaml:"volumes,omitempty"`
	Networks            map[string]*NetworkConfig    `yaml:"networks,omitempty"`
	Secrets             map[string]*SecretConfig     `yaml:"secrets,omitempty"`
	Hosts               map[string]*HostConfig       `yaml:"hosts,omitempty"`
	KubernetesResources map[string]interface{}       `yaml:"kubernetes_resources,omitempty"`
	SidekickInfo        *SidekickInfo                `yaml:"-"`
}

func NewConfig added in v0.15.0 

func NewConfig() *Config

func (*Config) Complete added in v0.15.0 

func (c *Config) Complete()

type Dependencies added in v0.15.18 

type Dependencies map[string]Dependency

func (*Dependencies) UnmarshalYAML added in v0.15.18 

func (d *Dependencies) UnmarshalYAML(unmarshal func(interface{}) error) error

type Dependency added in v0.15.18 

type Dependency struct {
	Condition string `yaml:"condition,omitempty"`
	Container bool   `yaml:"container,omitempty"`
}

type DependencyConfig added in v0.14.0 

type DependencyConfig struct {
	Name     string `yaml:"name,omitempty"`
	Template string `yaml:"template,omitempty"`
	Version  string `yaml:"version,omitempty"`
}

type HostConfig added in v0.14.2 

type HostConfig struct {
	Count    int    `yaml:"count,omitempty"`
	Template string `yaml:"template,omitempty"`
	// Fancy trick to catch any other fields
	Dynamic map[string]interface{} `yaml:",inline"`
}

type Ipam 

type Ipam struct {
	Driver string       `yaml:"driver,omitempty"`
	Config []IpamConfig `yaml:"config,omitempty"`
}

Ipam holds v2 network IPAM information

type IpamConfig 

type IpamConfig struct {
	Subnet     string            `yaml:"subnet,omitempty"`
	IPRange    string            `yaml:"ip_range,omitempty"`
	Gateway    string            `yaml:"gateway,omitempty"`
	AuxAddress map[string]string `yaml:"aux_addresses,omitempty"`
}

IpamConfig holds v2 network IPAM configuration information

type LBConfig added in v0.14.0 

type LBConfig struct {
	Certs            []string            `json:"certs,omitempty" yaml:"certs,omitempty"`
	DefaultCert      string              `json:"default_cert,omitempty" yaml:"default_cert,omitempty"`
	PortRules        []PortRule          `json:"port_rules,omitempty" yaml:"port_rules,omitempty"`
	Config           string              `json:"config,omitempty" yaml:"config,omitempty"`
	StickinessPolicy *LBStickinessPolicy `json:"stickiness_policy,omitempty" yaml:"stickiness_policy,omitempty"`
}

type LBStickinessPolicy added in v0.14.0 

type LBStickinessPolicy struct {
	Name     string `json:"name,omitempty" yaml:"name,omitempty"`
	Cookie   string `json:"cookie,omitempty" yaml:"cookie,omitempty"`
	Domain   string `json:"domain,omitempty" yaml:"domain,omitempty"`
	Indirect bool   `json:"indirect,omitempty" yaml:"indirect,omitempty"`
	Nocache  bool   `json:"nocache,omitempty" yaml:"nocache,omitempty"`
	Postonly bool   `json:"postonly,omitempty" yaml:"postonly,omitempty"`
	Mode     string `json:"mode,omitempty" yaml:"mode,omitempty"`
}

type Log 

type Log struct {
	Driver  string            `yaml:"driver,omitempty"`
	Options map[string]string `yaml:"options,omitempty"`
}

Log holds v2 logging information

type NetworkConfig 

type NetworkConfig struct {
	Driver     string            `yaml:"driver,omitempty"`
	DriverOpts map[string]string `yaml:"driver_opts,omitempty"`
	External   yaml.External     `yaml:"external,omitempty"`
	Ipam       Ipam              `yaml:"ipam,omitempty"`
}

NetworkConfig holds v2 network configuration

type PortRule added in v0.14.0 

type PortRule struct {
	SourcePort  int    `json:"source_port,omitempty" yaml:"source_port,omitempty"`
	Protocol    string `json:"protocol,omitempty" yaml:"protocol,omitempty"`
	Path        string `json:"path,omitempty" yaml:"path,omitempty"`
	Hostname    string `json:"hostname,omitempty" yaml:"hostname,omitempty"`
	Service     string `json:"service,omitempty" yaml:"service,omitempty"`
	Container   string `json:"container,omitempty" yaml:"container,omitempty"`
	TargetPort  int    `json:"target_port,omitempty" yaml:"target_port,omitempty"`
	Priority    int    `json:"priority,omitempty" yaml:"priority,omitempty"`
	BackendName string `json:"backend_name,omitempty" yaml:"backend_name,omitempty"`
	Selector    string `json:"selector,omitempty" yaml:"selector,omitempty"`
}

TODO: json tags needed?

type RancherConfig added in v0.14.1 

type RancherConfig struct {
	Certs                    []string                         `yaml:"certs,omitempty"`
	DefaultCert              string                           `yaml:"default_cert,omitempty"`
	LbConfig                 *LBConfig                        `yaml:"lb_config,omitempty"`
	LegacyLoadBalancerConfig *legacyClient.LoadBalancerConfig `yaml:"load_balancer_config,omitempty"`

	CreateOnly  bool                        `yaml:"create_only,omitempty"`
	ExternalIps []string                    `yaml:"external_ips,omitempty"`
	HealthCheck *client.InstanceHealthCheck `yaml:"health_check,omitempty"`
	RetainIp    bool                        `yaml:"retain_ip,omitempty"`
	// rancher vm fields
	Vcpu     yaml.StringorInt            `yaml:"vcpu,omitempty"`
	Userdata string                      `yaml:"userdata,omitempty"`
	Memory   yaml.MemStringorInt         `yaml:"memory,omitempty"`
	Disks    []client.VirtualMachineDisk `yaml:"disks,omitempty"`

	Type                string           `yaml:"type,omitempty"`
	Scale               yaml.StringorInt `yaml:"scale,omitempty"`
	ScaleMin            yaml.StringorInt `yaml:"scale_min,omitempty"`
	ScaleMax            yaml.StringorInt `yaml:"scale_max,omitempty"`
	ScaleIncrement      yaml.StringorInt `yaml:"scale_increment,omitempty"`
	StartOnCreate       bool             `yaml:"start_on_create,omitempty"`
	MilliCpuReservation yaml.StringorInt `yaml:"milli_cpu_reservation,omitempty"`

	Metadata        map[string]interface{}          `yaml:"metadata,omitempty"`
	NetworkDriver   *client.NetworkDriver           `yaml:"network_driver,omitempty"`
	ServiceSchemas  map[string]client.Schema        `yaml:"service_schemas,omitempty"`
	StorageDriver   *client.StorageDriver           `yaml:"storage_driver,omitempty"`
	UpgradeStrategy client.InServiceUpgradeStrategy `yaml:"upgrade_strategy,omitempty"`
}

type RawConfig added in v0.14.0 

type RawConfig struct {
	Version string `yaml:"version,omitempty"`

	Services         RawServiceMap `yaml:"services,omitempty"`
	Containers       RawServiceMap `yaml:"containers,omitempty"`
	LoadBalancers    RawServiceMap `yaml:"load_balancers,omitempty"`
	StorageDrivers   RawServiceMap `yaml:"storage_drivers,omitempty"`
	NetworkDrivers   RawServiceMap `yaml:"network_drivers,omitempty"`
	VirtualMachines  RawServiceMap `yaml:"virtual_machines,omitempty"`
	ExternalServices RawServiceMap `yaml:"external_services,omitempty"`
	Aliases          RawServiceMap `yaml:"aliases,omitempty"`

	Dependencies map[string]interface{} `yaml:"dependencies,omitempty"`
	Volumes      map[string]interface{} `yaml:"volumes,omitempty"`
	Networks     map[string]interface{} `yaml:"networks,omitempty"`
	Secrets      map[string]interface{} `yaml:"secrets,omitempty"`
	Hosts        map[string]interface{} `yaml:"hosts,omitempty"`

	KubernetesResources map[string]interface{} `yaml:"kubernetes_resources,omitempty"`
}

type RawService 

type RawService map[string]interface{}

RawService is represent a Service in map form unparsed

type RawServiceMap 

type RawServiceMap map[string]RawService

RawServiceMap is a collection of RawServices

type SecretConfig added in v0.14.0 

type SecretConfig struct {
	File     string `yaml:"file,omitempty"`
	External string `yaml:"external,omitempty"`
}

type SecretReference added in v0.14.0 

type SecretReference struct {
	Source string `yaml:"source,omitempty"`
	Target string `yaml:"target,omitempty"`
	Uid    string `yaml:"uid,omitempty"`
	Gid    string `yaml:"gid,omitempty"`
	Mode   string `yaml:"mode,omitempty"`
}

type SecretReferences added in v0.14.0 

type SecretReferences []SecretReference

func (*SecretReferences) UnmarshalYAML added in v0.14.0 

func (s *SecretReferences) UnmarshalYAML(unmarshal func(interface{}) error) error

type ServiceConfig 

type ServiceConfig struct {
	BlkioWeight       yaml.StringorInt     `yaml:"blkio_weight,omitempty"`
	BlkioWeightDevice []string             `yaml:"blkio_weight_device,omitempty"`
	Build             yaml.Build           `yaml:"build,omitempty"`
	CapAdd            []string             `yaml:"cap_add,omitempty"`
	CapDrop           []string             `yaml:"cap_drop,omitempty"`
	CPUPeriod         yaml.StringorInt     `yaml:"cpu_period,omitempty"`
	CPUSet            string               `yaml:"cpuset,omitempty"`
	CPUShares         yaml.StringorInt     `yaml:"cpu_shares,omitempty"`
	CPUQuota          yaml.StringorInt     `yaml:"cpu_quota,omitempty"`
	Command           yaml.Command         `yaml:"command,flow,omitempty"`
	CgroupParent      string               `yaml:"cgroup_parent,omitempty"`
	ContainerName     string               `yaml:"container_name,omitempty"`
	DeviceReadBps     yaml.MaporColonSlice `yaml:"device_read_bps,omitempty"`
	DeviceReadIOps    yaml.MaporColonSlice `yaml:"device_read_iops,omitempty"`
	Devices           []string             `yaml:"devices,omitempty"`
	DeviceWriteBps    yaml.MaporColonSlice `yaml:"device_write_bps,omitempty"`
	DeviceWriteIOps   yaml.MaporColonSlice `yaml:"device_write_iops,omitempty"`
	DependsOn         Dependencies         `yaml:"depends_on,omitempty"`
	DNS               yaml.Stringorslice   `yaml:"dns,omitempty"`
	DNSOpt            []string             `yaml:"dns_opt,omitempty"`
	DNSSearch         yaml.Stringorslice   `yaml:"dns_search,omitempty"`
	DomainName        string               `yaml:"domainname,omitempty"`
	Entrypoint        yaml.Command         `yaml:"entrypoint,flow,omitempty"`
	EnvFile           yaml.Stringorslice   `yaml:"env_file,omitempty"`
	Environment       yaml.MaporEqualSlice `yaml:"environment,omitempty"`
	Expose            []string             `yaml:"expose,omitempty"`
	Extends           yaml.MaporEqualSlice `yaml:"extends,omitempty"`
	ExternalLinks     []string             `yaml:"external_links,omitempty"`
	ExtraHosts        []string             `yaml:"extra_hosts,omitempty"`
	GroupAdd          []string             `yaml:"group_add,omitempty"`
	Image             string               `yaml:"image,omitempty"`
	Init              bool                 `yaml:"init,omitempty"`
	Isolation         string               `yaml:"isolation,omitempty"`
	Hostname          string               `yaml:"hostname,omitempty"`
	Ipc               string               `yaml:"ipc,omitempty"`
	Labels            yaml.SliceorMap      `yaml:"labels,omitempty"`
	Links             yaml.MaporColonSlice `yaml:"links,omitempty"`
	Logging           Log                  `yaml:"logging,omitempty"`
	MacAddress        string               `yaml:"mac_address,omitempty"`
	MemLimit          yaml.MemStringorInt  `yaml:"mem_limit,omitempty"`
	MemReservation    yaml.MemStringorInt  `yaml:"mem_reservation,omitempty"`
	MemSwapLimit      yaml.MemStringorInt  `yaml:"memswap_limit,omitempty"`
	MemSwappiness     yaml.StringorInt     `yaml:"mem_swappiness,omitempty"`
	NetworkMode       string               `yaml:"network_mode,omitempty"`
	Networks          *yaml.Networks       `yaml:"networks,omitempty"`
	OomKillDisable    bool                 `yaml:"oom_kill_disable,omitempty"`
	OomScoreAdj       yaml.StringorInt     `yaml:"oom_score_adj,omitempty"`
	Pid               string               `yaml:"pid,omitempty"`
	Ports             []string             `yaml:"ports,omitempty"`
	Privileged        bool                 `yaml:"privileged,omitempty"`
	Secrets           SecretReferences     `yaml:"secrets,omitempty"`
	SecurityOpt       []string             `yaml:"security_opt,omitempty"`
	ShmSize           yaml.MemStringorInt  `yaml:"shm_size,omitempty"`
	StopSignal        string               `yaml:"stop_signal,omitempty"`
	Sysctls           yaml.SliceorMap      `yaml:"sysctls,omitempty"`
	Tmpfs             yaml.Stringorslice   `yaml:"tmpfs,omitempty"`
	VolumeDriver      string               `yaml:"volume_driver,omitempty"`
	Volumes           *yaml.Volumes        `yaml:"volumes,omitempty"`
	VolumesFrom       []string             `yaml:"volumes_from,omitempty"`
	Uts               string               `yaml:"uts,omitempty"`
	Restart           string               `yaml:"restart,omitempty"`
	ReadOnly          bool                 `yaml:"read_only,omitempty"`
	StdinOpen         bool                 `yaml:"stdin_open,omitempty"`
	Tty               bool                 `yaml:"tty,omitempty"`
	User              string               `yaml:"user,omitempty"`
	WorkingDir        string               `yaml:"working_dir,omitempty"`
	Ulimits           yaml.Ulimits         `yaml:"ulimits,omitempty"`

	RancherConfig `yaml:",inline"`
}

ServiceConfig holds version 2 of libcompose service configuration

type ServiceConfigV1 

type ServiceConfigV1 struct {
	BlkioWeight       yaml.StringorInt     `yaml:"blkio_weight,omitempty"`
	BlkioWeightDevice []string             `yaml:"blkio_weight_device,omitempty"`
	Build             string               `yaml:"build,omitempty"`
	CapAdd            []string             `yaml:"cap_add,omitempty"`
	CapDrop           []string             `yaml:"cap_drop,omitempty"`
	CgroupParent      string               `yaml:"cgroup_parent,omitempty"`
	CPUPeriod         yaml.StringorInt     `yaml:"cpu_period,omitempty"`
	CPUQuota          yaml.StringorInt     `yaml:"cpu_quota,omitempty"`
	CPUSet            string               `yaml:"cpuset,omitempty"`
	CPUShares         yaml.StringorInt     `yaml:"cpu_shares,omitempty"`
	Command           yaml.Command         `yaml:"command,flow,omitempty"`
	ContainerName     string               `yaml:"container_name,omitempty"`
	DeviceReadBps     yaml.MaporColonSlice `yaml:"device_read_bps,omitempty"`
	DeviceReadIOps    yaml.MaporColonSlice `yaml:"device_read_iops,omitempty"`
	Devices           []string             `yaml:"devices,omitempty"`
	DeviceWriteBps    yaml.MaporColonSlice `yaml:"device_write_bps,omitempty"`
	DeviceWriteIOps   yaml.MaporColonSlice `yaml:"device_write_iops,omitempty"`
	DNS               yaml.Stringorslice   `yaml:"dns,omitempty"`
	DNSOpt            []string             `yaml:"dns_opt,omitempty"`
	DNSSearch         yaml.Stringorslice   `yaml:"dns_search,omitempty"`
	Dockerfile        string               `yaml:"dockerfile,omitempty"`
	DomainName        string               `yaml:"domainname,omitempty"`
	Entrypoint        yaml.Command         `yaml:"entrypoint,flow,omitempty"`
	EnvFile           yaml.Stringorslice   `yaml:"env_file,omitempty"`
	Environment       yaml.MaporEqualSlice `yaml:"environment,omitempty"`
	GroupAdd          []string             `yaml:"group_add,omitempty"`
	Hostname          string               `yaml:"hostname,omitempty"`
	Image             string               `yaml:"image,omitempty"`
	Isolation         string               `yaml:"isolation,omitempty"`
	Labels            yaml.SliceorMap      `yaml:"labels,omitempty"`
	Links             yaml.MaporColonSlice `yaml:"links,omitempty"`
	LogDriver         string               `yaml:"log_driver,omitempty"`
	MacAddress        string               `yaml:"mac_address,omitempty"`
	MemLimit          yaml.MemStringorInt  `yaml:"mem_limit,omitempty"`
	MemSwapLimit      yaml.MemStringorInt  `yaml:"memswap_limit,omitempty"`
	MemSwappiness     yaml.StringorInt     `yaml:"mem_swappiness,omitempty"`
	Name              string               `yaml:"name,omitempty"`
	Net               string               `yaml:"net,omitempty"`
	OomKillDisable    bool                 `yaml:"oom_kill_disable,omitempty"`
	OomScoreAdj       yaml.StringorInt     `yaml:"oom_score_adj,omitempty"`
	Pid               string               `yaml:"pid,omitempty"`
	Uts               string               `yaml:"uts,omitempty"`
	Ipc               string               `yaml:"ipc,omitempty"`
	Ports             []string             `yaml:"ports,omitempty"`
	Privileged        bool                 `yaml:"privileged,omitempty"`
	Restart           string               `yaml:"restart,omitempty"`
	ReadOnly          bool                 `yaml:"read_only,omitempty"`
	Secrets           SecretReferences     `yaml:"secrets,omitempty"`
	ShmSize           yaml.MemStringorInt  `yaml:"shm_size,omitempty"`
	StdinOpen         bool                 `yaml:"stdin_open,omitempty"`
	SecurityOpt       []string             `yaml:"security_opt,omitempty"`
	StopSignal        string               `yaml:"stop_signal,omitempty"`
	Sysctls           yaml.SliceorMap      `yaml:"sysctls,omitempty"`
	Init              bool                 `yaml:"init,omitempty"`
	Tmpfs             yaml.Stringorslice   `yaml:"tmpfs,omitempty"`
	Tty               bool                 `yaml:"tty,omitempty"`
	User              string               `yaml:"user,omitempty"`
	VolumeDriver      string               `yaml:"volume_driver,omitempty"`
	Volumes           []string             `yaml:"volumes,omitempty"`
	VolumesFrom       []string             `yaml:"volumes_from,omitempty"`
	WorkingDir        string               `yaml:"working_dir,omitempty"`
	Expose            []string             `yaml:"expose,omitempty"`
	ExternalLinks     []string             `yaml:"external_links,omitempty"`
	LogOpt            map[string]string    `yaml:"log_opt,omitempty"`
	ExtraHosts        []string             `yaml:"extra_hosts,omitempty"`
	Ulimits           yaml.Ulimits         `yaml:"ulimits,omitempty"`

	LbConfig                 *LBConfig                        `yaml:"lb_config"`
	LegacyLoadBalancerConfig *legacyClient.LoadBalancerConfig `yaml:"load_balancer_config,omitempty"`
	DefaultCert              string                           `yaml:"default_cert,omitempty"`
	Certs                    []string                         `yaml:"certs,omitempty"`

	Vcpu     yaml.StringorInt            `yaml:"vcpu,omitempty"`
	Userdata string                      `yaml:"userdata,omitempty"`
	Memory   yaml.MemStringorInt         `yaml:"memory,omitempty"`
	Disks    []client.VirtualMachineDisk `yaml:"disks,omitempty"`

	Type        string           `yaml:"type,omitempty"`
	Scale       yaml.StringorInt `yaml:"scale,omitempty"`
	RetainIp    bool             `yaml:"retain_ip,omitempty"`
	ExternalIps []string         `yaml:"external_ips,omitempty"`
	// TODO: hostname is in docker-compose.yml and rancher-compose.yml
	//Hostname    string                      `yaml:"hostname,omitempty"`
	HealthCheck *client.InstanceHealthCheck `yaml:"health_check,omitempty"`

	Metadata        map[string]interface{}          `yaml:"metadata,omitempty"`
	ServiceSchemas  map[string]client.Schema        `yaml:"service_schemas,omitempty"`
	UpgradeStrategy client.InServiceUpgradeStrategy `yaml:"upgrade_strategy,omitempty"`
	StorageDriver   *client.StorageDriver           `yaml:"storage_driver,omitempty"`
	NetworkDriver   *client.NetworkDriver           `yaml:"network_driver,omitempty"`
}

ServiceConfigV1 holds version 1 of libcompose service configuration

type SidekickInfo added in v0.15.0 

type SidekickInfo struct {
	PrimariesToSidekicks map[string][]string
	Primaries            map[string]bool
	SidekickToPrimaries  map[string][]string
}

type VolumeConfig 

type VolumeConfig struct {
	Driver       string            `yaml:"driver,omitempty"`
	DriverOpts   map[string]string `yaml:"driver_opts,omitempty"`
	External     yaml.External     `yaml:"external,omitempty"`
	PerContainer bool              `yaml:"per_container,omitempty"`
}

VolumeConfig holds v2 volume configuration

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.