compose

type BindOptions struct {
	Propagation    String `yaml:"propagation,omitempty"`
	CreateHostPath Bool   `yaml:"create_host_path,omitempty"`
}

type BlkioConfig struct {
	DeviceReadBPS   []ThrottleDevice `yaml:"device_read_bps,omitempty"`
	DeviceWriteBPS  []ThrottleDevice `yaml:"device_write_bps,omitempty"`
	DeviceReadIOPS  []ThrottleDevice `yaml:"device_read_iops,omitempty"`
	DeviceWriteIOPS []ThrottleDevice `yaml:"device_write_iops,omitempty"`
	Weight          Int              `yaml:"weight,omitempty"`
	WeightDevice    []WeightDevice   `yaml:"weight_device,omitempty"`
}

type Bool struct {
	String
	Value bool
}

type Build struct {
	ShortForm String
	BuildLongForm
}

type BuildLongForm struct {
	Context    String     `yaml:"context,omitempty"`
	Dockerfile String     `yaml:"dockerfile,omitempty"`
	Args       Dictionary `yaml:"args,omitempty"`
	CacheFrom  Strings    `yaml:"cache_from,omitempty"`
	ExtraHosts Strings    `yaml:"extra_hosts,omitempty"`
	Isolation  String     `yaml:"isolation,omitempty"`
	Labels     Dictionary `yaml:"labels,omitempty"`
	ShmSize    Bytes      `yaml:"shm_size,omitempty"`
	Target     String     `yaml:"target,omitempty"`
}

type ByteUnit struct {
	Suffix string
	Scalar int64
}

type Bytes struct {
	String
	Quantity int64
	Unit     ByteUnit
}

type Command struct {
	// IsShellForm is true if the command was provided as a string rather than an
	// array of strings. This indicates that it should be passed to the image's
	// shell as the first argument.
	IsShellForm bool
	Parts       Strings
}

type Config struct {
	Key string `yaml:"-"`

	File     String `yaml:"file,omitempty"`
	External Bool   `yaml:"external,omitempty"`
	Name     String `yaml:"name,omitempty"`
}

type DeviceMapping struct {
	String
	PathOnHost        string
	PathInContainer   string
	CgroupPermissions string
}

type Dictionary struct {
	Style Style
	Items []DictionaryItem
}

type DictionaryItem struct {
	Style Style
	// For map style, String contains only the value.
	// For seq style, String is expected to evaluate to "key" or "key=value".
	String String
	Key    string
	Value  string
	// True in seq style when there is no "=" in the evaluated String.
	NoValue bool
}

type Duration struct {
	String
	Duration time.Duration
}

type Environment = template.Environment

type Healthcheck struct {
	Test        Command  `yaml:"test,omitempty"`
	Interval    Duration `yaml:"interval,omitempty"`
	Timeout     Duration `yaml:"timeout,omitempty"`
	Retries     Int      `yaml:"retries,omitempty"`
	StartPeriod Duration `yaml:"start_period,omitempty"`
}

type Ignored struct{}

type Int struct {
	String
	Value int64
}

type Interpolator interface {
	Interpolate(Environment) error
}

type Link struct {
	String
	Service string
	Alias   string
}

type Links []Link

type Logging struct {
	Driver  String     `yaml:"driver,omitempty"`
	Options Dictionary `yaml:"options,omitempty"`
}

type MapEnvironment = template.MapEnvironment

type Network struct {
	Key string `yaml:"-"`

	Name       String     `yaml:"name,omitempty"`
	Driver     String     `yaml:"driver,omitempty"`
	DriverOpts Dictionary `yaml:"driver_opts,omitempty"`
	Attachable Bool       `yaml:"attachable,omitempty"`
	EnableIPv6 Bool       `yaml:"enable_ipv6,omitempty"`
	Internal   Bool       `yaml:"internal,omitempty"`
	Labels     Dictionary `yaml:"labels,omitempty"`
	External   Bool       `yaml:"external,omitempty"`
}

type PortMapping struct {
	IsShortForm bool
	String
	PortMappingLongForm
}

type PortMappingLongForm struct {
	Target    PortRange `yaml:"target,omitempty"`
	Published PortRange `yaml:"published,omitempty"`
	HostIP    string    `yaml:"host_ip,omitempty"`
	Protocol  string    `yaml:"protocol,omitempty"`
	Mode      string    `yaml:"mode,omitempty"`
}

type PortMappings []PortMapping

type PortRange struct {
	String
	Min uint16
	Max uint16
}

type PortRangeWithProtocol struct {
	String
	Min      uint16
	Max      uint16
	Protocol string
}

type Project struct {
	Version  String          `yaml:"version,omitempty"`
	Services ProjectServices `yaml:"services,omitempty"`
	Networks ProjectNetworks `yaml:"networks,omitempty"`
	Volumes  ProjectVolumes  `yaml:"volumes,omitempty"`
	Configs  ProjectConfigs  `yaml:"configs,omitempty"`
	Secrets  ProjectSecrets  `yaml:"secrets,omitempty"`
}

type ProjectConfigs []Config

type ProjectNetworks []Network

type ProjectSecrets []Secret

type ProjectServices []Service

type ProjectVolumes []Volume

type Secret struct {
	Key string `yaml:"-"`

	File     String `yaml:"file,omitempty"`
	External Bool   `yaml:"external,omitempty"`
	Name     String `yaml:"name,omitempty"`
}

type Service struct {
	Key string `yaml:"-"`

	// Note that these two are only applicable to Windows.
	CPUCount   Int `yaml:"cpu_count,omitempty"`
	CPUPercent Int `yaml:"cpu_percent,omitempty"`

	CPUShares          Int         `yaml:"cpu_shares,omitempty"`
	CPUPeriod          Int         `yaml:"cpu_period,omitempty"`
	CPUQuota           Int         `yaml:"cpu_quota,omitempty"`
	CPURealtimeRuntime Duration    `yaml:"cpu_rt_runtime,omitempty"`
	CPURealtimePeriod  Duration    `yaml:"cpu_rt_period,omitempty"`
	CPUSet             String      `yaml:"cpuset,omitempty"`
	BlkioConfig        BlkioConfig `yaml:"blkio_config,omitempty"`
	Build              Build       `yaml:"build,omitempty"`
	CapAdd             Strings     `yaml:"cap_add,omitempty"`
	CapDrop            Strings     `yaml:"cap_drop,omitempty"`
	CgroupParent       String      `yaml:"cgroup_parent,omitempty"`
	Command            Command     `yaml:"command,omitempty"`
	Configs            Strings     `yaml:"configs,omitempty"` // TODO: support long syntax.
	ContainerName      String      `yaml:"container_name,omitempty"`
	// TODO: credential_spec
	DependsOn         ServiceDependencies     `yaml:"depends_on,omitempty"`
	DeviceCgroupRules Strings                 `yaml:"device_cgroup_rules,omitempty"`
	Devices           []DeviceMapping         `yaml:"devices,omitempty"`
	DNS               Tuple                   `yaml:"dns,omitempty"`
	DNSOptions        Strings                 `yaml:"dns_opt,omitempty"`
	DNSSearch         Tuple                   `yaml:"dns_search,omitempty"`
	Domainname        String                  `yaml:"domainname,omitempty"`
	Entrypoint        Command                 `yaml:"entrypoint,omitempty"`
	EnvFile           Tuple                   `yaml:"env_file,omitempty"`
	Environment       Dictionary              `yaml:"environment,omitempty"`
	Expose            []PortRangeWithProtocol `yaml:"expose,omitempty"`
	// TODO: extends
	// List of links of the form `SERVICE` or `SERVICE:ALIAS`
	ExternalLinks Strings `yaml:"external_links,omitempty"`
	// List of host/IP pairs to add to /etc/hosts of the form `HOST:IP`
	ExtraHosts       Strings         `yaml:"extra_hosts,omitempty"`
	GroupAdd         Strings         `yaml:"group_add,omitempty"`
	Healthcheck      *Healthcheck    `yaml:"healthcheck,omitempty"`
	Hostname         String          `yaml:"hostname,omitempty"`
	Image            String          `yaml:"image,omitempty"`
	Init             *Bool           `yaml:"init,omitempty"`
	IPC              String          `yaml:"ipc,omitempty"`
	Isolation        String          `yaml:"isolation,omitempty"`
	Labels           Dictionary      `yaml:"labels,omitempty"`
	Links            Links           `yaml:"links,omitempty"`
	Logging          Logging         `yaml:"logging,omitempty"`
	NetworkMode      String          `yaml:"network_mode,omitempty"`
	Networks         ServiceNetworks `yaml:"networks,omitempty"`
	MacAddress       String          `yaml:"mac_address,omitempty"`
	MemorySwappiness *Int            `yaml:"mem_swappiness,omitempty"`
	// MemoryLimit and MemoryReservation can be specified either as strings or integers.
	// TODO: Deprecate these fields once we support `deploy.limits.memory` and `deploy.reservations.memory`.
	MemoryLimit       Bytes `yaml:"mem_limit,omitempty"`
	MemoryReservation Bytes `yaml:"mem_reservation,omitempty"`

	MemswapLimit   Bytes        `yaml:"memswap_limit,omitempty"`
	OomKillDisable *Bool        `yaml:"oom_kill_disable,omitempty"`
	OomScoreAdj    Int          `yaml:"oom_score_adj,omitempty"`
	PidMode        String       `yaml:"pid,omitempty"`
	PidsLimit      *Int         `yaml:"pids_limit,omitempty"`
	Platform       String       `yaml:"platform,omitempty"`
	Ports          PortMappings `yaml:"ports,omitempty"`
	Privileged     Bool         `yaml:"privileged,omitempty"`
	// TODO: Support profiles. See https://docs.docker.com/compose/profiles/.
	Profiles        Ignored       `yaml:"profiles,omitempty"`
	PullPolicy      String        `yaml:"pull_policy,omitempty"`
	ReadOnly        Bool          `yaml:"read_only,omitempty"`
	Restart         String        `yaml:"restart,omitempty"`
	Runtime         String        `yaml:"runtime,omitempty"`
	SecurityOpt     Strings       `yaml:"security_opt,omitempty"`
	ShmSize         Bytes         `yaml:"shm_size,omitempty"`
	StdinOpen       Bool          `yaml:"stdin_open,omitempty"`
	StopGracePeriod *Duration     `yaml:"stop_grace_period,omitempty"`
	StopSignal      String        `yaml:"stop_signal,omitempty"`
	StorageOpt      Dictionary    `yaml:"storage_opt,omitempty"`
	Sysctls         Dictionary    `yaml:"sysctls,omitempty"`
	Tmpfs           Tuple         `yaml:"tmpfs,omitempty"`
	TTY             Bool          `yaml:"tty,omitempty"`
	Ulimits         Ulimits       `yaml:"ulimits,omitempty"`
	User            String        `yaml:"user,omitempty"`
	UsernsMode      String        `yaml:"userns_mode,omitempty"`
	Volumes         []VolumeMount `yaml:"volumes,omitempty"`
	VolumesFrom     Strings       `yaml:"volumes_from,omitempty"`
	WorkingDir      String        `yaml:"working_dir,omitempty"`

	// NOTE [DOCKER SWARM FEATURES]:
	// Docker-Compose manages local, single-container deployments as well as Docker Swarm
	// deployments. Since Swarm is not as widely used as Kubernetes, support for the Swarm
	// features that Docker-Compose includes is not a top priority. The settings listed
	// below are the ones that are applicable to a Swarm deployment.
	Deploy  Ignored `yaml:"deploy,omitempty"`
	Scale   Ignored `yaml:"scale,omitempty"`
	Secrets Ignored `yaml:"secrets,omitempty"`
}

type ServiceDependencies struct {
	Style Style
	Items []ServiceDependency
}

type ServiceDependency struct {
	IsShortSyntax bool
	Service       String
	ServiceDependencyLongForm
}

type ServiceDependencyLongForm struct {
	Condition String `yaml:"condition,omitempty"`
}

type ServiceNetwork struct {
	Key string

	ShortForm String
	ServiceNetworkLongForm
}

type ServiceNetworkLongForm struct {
	Aliases      Strings `yaml:"aliases,omitempty"`
	IPV4Address  String  `yaml:"ipv4_address,omitempty"`
	IPV6Address  String  `yaml:"ipv6_address,omitempty"`
	LinkLocalIPs Strings `yaml:"link_local_ips,omitempty"`
	Priority     Int     `yaml:"priority,omitempty"`
}

type ServiceNetworks struct {
	Style Style
	Items []ServiceNetwork
}

type String struct {
	Tag        string
	Style      yaml.Style
	Expression string
	Value      string
}

type Strings []String

type Style byte

type ThrottleDevice struct {
	Path String `yaml:"path,omitempty"`
	Rate Bytes  `yaml:"rate,omitempty"`
}

type TmpfsOptions struct {
	Size Bytes `yaml:"size,omitempty"`
}

type Tuple struct {
	IsSequence bool
	Items      []String
}

type Ulimit struct {
	Name string

	ShortForm Int
	UlimitLongForm
}

type UlimitLongForm struct {
	Soft Int `yaml:"soft,omitempty"`
	Hard Int `yaml:"hard,omitempty"`
}

type Ulimits []Ulimit

type Volume struct {
	Key string `yaml:"-"`

	Driver     String     `yaml:"driver,omitempty"`
	DriverOpts Dictionary `yaml:"driver_opts,omitempty"`
	// TODO: external
	Labels Dictionary `yaml:"labels,omitempty"`
	Name   String     `yaml:"name,omitempty"`
}

type VolumeMount struct {
	ShortForm String
	VolumeMountLongForm
}

type VolumeMountLongForm struct {
	Type        String         `yaml:"type,omitempty"`
	Source      String         `yaml:"source,omitempty"`
	Target      String         `yaml:"target,omitempty"`
	ReadOnly    Bool           `yaml:"read_only,omitempty"`
	Bind        *BindOptions   `yaml:"bind,omitempty"`
	Volume      *VolumeOptions `yaml:"volume,omitempty"`
	Tmpfs       *TmpfsOptions  `yaml:"tmpfs,omitempty"`
	Consistency *Ignored       `yaml:"consistency,omitempty"`
}

type VolumeOptions struct {
	Nocopy Bool `yaml:"nocopy,omitempty"`
}

type WeightDevice struct {
	Path   String `yaml:"path,omitempty"`
	Weight Int    `yaml:"weight,omitempty"`
}