NewHostsList creates a HostsList from a list of `host=ip` strings.

NewMapping build a new Mapping from a set of KEY=VALUE strings.

NewMappingWithEquals build a new Mapping from a set of KEY=VALUE strings.

ParsePortConfig parse short syntax for service port configuration.

ContainerPrefix is the prefix for references pointing to a container.

NetworkModeContainerPrefix is the prefix for network_mode pointing to a container Deprecated prefer ContainerPrefix.

NetworkModeServicePrefix is the prefix for network_mode pointing to a service Deprecated prefer ServicePrefix.

PropagationPrivate PRIVATE.

PropagationRPrivate RPRIVATE.

PropagationRShared RSHARED.

PropagationRSlave RSLAVE.

PropagationShared SHARED.

PropagationSlave SLAVE.

PullPolicyAlways always pull images.

PullPolicyBuild force building images.

PullPolicyIfNotPresent pull missing images.

PullPolicyMissing pull missing images.

PullPolicyNever never pull images.

PullPolicyRefresh checks if image needs to be updated.

RestartPolicyAlways always restart the container if it stops.

RestartPolicyNo do not automatically restart the container.

RestartPolicyOnFailure restart the container if it exits due to an error.

RestartPolicyUnlessStopped always restart the container unless the container is stopped (manually or otherwise).

SELinuxPrivate option indicates that the bind mount content is private and unshared.

SElinuxShared share the volume content.

SELinuxShared option indicates that the bind mount content is shared among multiple containers.

SElinuxUnshared label content as private unshared.

ServiceConditionCompletedSuccessfully is the type for waiting until a service has completed successfully (exit code 0).

ServiceConditionHealthy is the type for waiting until a service is healthy.

ServiceConditionStarted is the type for waiting until a service has started (default).

ServicePrefix is the prefix for references pointing to a service.

VolumeTypeBind is the type for mounting host dir.

VolumeTypeCluster is the type for mounting container storage interface (CSI) volumes.

VolumeTypeNamedPipe is the type for mounting Windows named pipes.

VolumeTypeTmpfs is the type for mounting tmpfs.

VolumeTypeVolume is the type for remote storage volumes.

BlkioConfig define blkio config.

BuildConfig is a type for build.

Config is a full compose file configuration and model.

ConfigDetails are the details about a group of ConfigFiles.

ConfigFile is a filename and the contents of the file as a Dict.

CredentialSpecConfig for credential spec on Windows.

DeployConfig the deployment configuration for a service.

DiscreteGenericResource represents a "user defined" resource which is defined as an integer "Kind" is used to describe the Kind of a resource (e.g: "GPU", "FPGA", "SSD", ...) Value is used to count the resource (SSD=5, HDD=3, ...).

FileObjectConfig is a config type for a file used by a service.

FileReferenceConfig for a reference to a swarm file object.

GenericResource represents a "user defined" resource which can only be an integer (e.g: SSD=3) for a service.

HealthCheckConfig the healthcheck configuration for a service.

IPAMConfig for a network.

IPAMPool for a network.

LoggingConfig the logging configuration for a service.

NetworkConfig for a network.

Placement constraints for the service.

PlacementPreferences is the preferences for a service placement.

Project is the result of loading a set of compose files Since v2, Project are managed as immutable objects.

Resource is a resource to be limited or reserved.

Resources the resource limits and reservations.

RestartPolicy the service restart policy.

ServiceConfig is the configuration of one service.

ServiceHook is a command to exec inside container by some lifecycle events.

ServiceNetworkConfig is the network configuration for a service.

ServicePortConfig is the port configuration for a service.

ServiceVolumeBind are options for a service volume of type bind.

ServiceVolumeConfig are references to a volume used by a service.

ServiceVolumeTmpfs are options for a service volume of type tmpfs.

ServiceVolumeVolume are options for a service volume of type volume.

ThrottleDevice is a structure that holds device:rate_per_second pair.

UlimitsConfig the ulimit configuration.

UpdateConfig the service update configuration.

VolumeConfig for a volume.

WeightDevice is a structure that holds device:weight pair.

ConfigObjConfig is the config for the swarm "Config" object.

Configs is a map of ConfigObjConfig.

Duration is a thin wrapper around time.Duration with improved JSON marshalling.

Extensions is a map of custom extension.

External identifies a Volume or Network as a reference to a resource that is not managed, and should already exist.

HealthCheckTest is the command run to test the health of a service.

HostsList is a list of colon-separated host-ip mappings.

Labels is a mapping type for labels.

Mapping is a mapping type that can be converted from a list of key[=value] strings.

MappingWithColon is a mapping type that can be converted from a list of 'key: value' strings.

MappingWithEquals is a mapping type that can be converted from a list of key[=value] strings.

Networks is a map of NetworkConfig.

Options is a mapping type for options we pass as-is to container runtime.

SecretConfig for a secret.

Secrets is a map of SecretConfig.

ServiceConfigObjConfig is the config obj configuration for a service.

Services is a map of ServiceConfig.

ServiceSecretConfig is the secret configuration for a service.

ShellCommand is a string or list of string args.

SSHConfig is a mapping type for SSH build config.

StringList is a type for fields that can be a string or list of strings.

StringOrNumberList is a type for fields that can be a list of strings or numbers.

UnitBytes is the bytes type.

Volumes is a map of VolumeConfig.