package
0.0.0-20200902144940-ad3de8621596
Repository: https://github.com/kelda/compose-go.git
Documentation: pkg.go.dev
# Functions
ConvertDurationPtr converts a typedefined Duration pointer to a time.Duration pointer with the same value.
ParsePortConfig parse short syntax for service port configuration.
# Constants
PropagationPrivate PRIVATE.
PropagationRPrivate RPRIVATE.
PropagationRShared RSHARED.
PropagationRSlave RSLAVE.
PropagationShared SHARED.
PropagationSlave SLAVE.
TypeServiceConditionHealthy is the type for waiting until a service is healthy.
TypeServiceConditionHealthy is the type for waiting until a service has started.
TypeBind is the type for mounting host dir.
TypeNamedPipe is the type for mounting Windows named pipes.
TypeTmpfs is the type for mounting tmpfs.
TypeVolume is the type for remote storage volumes.
# Structs
BuildConfig is a type for build using the same format at libcompose: https://github.com/docker/libcompose/blob/master/yaml/build.go#L12.
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, ...).
External identifies a Volume or Network as a reference to a resource that is not managed, and should already exist.
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.
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.
No description provided by the author
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.
UlimitsConfig the ulimit configuration.
UpdateConfig the service update configuration.
VolumeConfig for a volume.
# Type aliases
ConfigObjConfig is the config for the swarm "Config" object.
Configs is a map of ConfigObjConfig.
No description provided by the author
Duration is a thin wrapper around time.Duration with improved JSON marshalling.
No description provided by the author
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.
SecretConfig for a secret.
Secrets is a map of SecretConfig.
ServiceConfigObjConfig is the config obj configuration for a service.
No description provided by the author
Services is a list of ServiceConfig.
ServiceSecretConfig is the secret configuration for a service.
ShellCommand is a string or list of string args.
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.