Versions in this module Expand all Collapse all v1 v1.2.0 Feb 14, 2022 v1.1.0 Jan 9, 2022 v1.0.2 Jan 2, 2022 Changes in this version type ServiceConfig + DependsOn DependsOnConfig + InitContainer Services + InitContainerPolicy string + func (s ServiceConfig) GetDependencies() []string v1.0.1 Dec 30, 2021 Changes in this version + const ContainerPrefix + const NetworkModeContainerPrefix + const NetworkModeServicePrefix + const PropagationPrivate + const PropagationRPrivate + const PropagationRShared + const PropagationRSlave + const PropagationShared + const PropagationSlave + const PullPolicyAlways + const PullPolicyBuild + const PullPolicyIfNotPresent + const PullPolicyMissing + const PullPolicyNever + const RestartPolicyAlways + const RestartPolicyNo + const RestartPolicyOnFailure + const RestartPolicyUnlessStopped + const ServiceConditionCompletedSuccessfully + const ServiceConditionHealthy + const ServiceConditionStarted + const ServicePrefix + const VolumeTypeBind + const VolumeTypeNamedPipe + const VolumeTypeTmpfs + const VolumeTypeVolume + func ConvertDurationPtr(d *Duration) *time.Duration + type BlkioConfig struct + DeviceReadBps []ThrottleDevice + DeviceReadIOps []ThrottleDevice + DeviceWriteBps []ThrottleDevice + DeviceWriteIOps []ThrottleDevice + Extensions map[string]interface{} + Weight uint16 + WeightDevice []WeightDevice + type BuildConfig struct + Args MappingWithEquals + CacheFrom StringList + Context string + Dockerfile string + Extensions map[string]interface{} + ExtraHosts HostsList + Isolation string + Labels Labels + Network string + Target string + type Config struct + Configs Configs + Extensions Extensions + Filename string + Networks Networks + Secrets Secrets + Services Services + Volumes Volumes + func (c Config) MarshalJSON() ([]byte, error) + type ConfigDetails struct + ConfigFiles []ConfigFile + Environment map[string]string + Version string + WorkingDir string + func (cd ConfigDetails) LookupEnv(key string) (string, bool) + type ConfigFile struct + Config map[string]interface{} + Content []byte + Filename string + type ConfigObjConfig FileObjectConfig + type Configs map[string]ConfigObjConfig + type CredentialSpecConfig struct + Config string + Extensions map[string]interface{} + File string + Registry string + type DependsOnConfig map[string]ServiceDependency + type DeployConfig struct + EndpointMode string + Extensions map[string]interface{} + Labels Labels + Mode string + Placement Placement + Replicas *uint64 + Resources Resources + RestartPolicy *RestartPolicy + RollbackConfig *UpdateConfig + UpdateConfig *UpdateConfig + type DeviceRequest struct + Capabilities []string + Count int64 + Driver string + IDs []string + type DiscreteGenericResource struct + Extensions map[string]interface{} + Kind string + Value int64 + type Duration time.Duration + func (d *Duration) UnmarshalJSON(b []byte) error + func (d Duration) MarshalJSON() ([]byte, error) + func (d Duration) MarshalYAML() (interface{}, error) + func (d Duration) String() string + type ExtendsConfig MappingWithEquals + type Extensions map[string]interface + func (e Extensions) Get(name string, target interface{}) (bool, error) + type External struct + Extensions map[string]interface{} + External bool + Name string + func (e External) MarshalJSON() ([]byte, error) + func (e External) MarshalYAML() (interface{}, error) + type FileObjectConfig struct + Driver string + DriverOpts map[string]string + Extensions map[string]interface{} + External External + File string + Labels Labels + Name string + TemplateDriver string + type FileReferenceConfig struct + Extensions map[string]interface{} + GID string + Mode *uint32 + Source string + Target string + UID string + type GenericResource struct + DiscreteResourceSpec *DiscreteGenericResource + Extensions map[string]interface{} + type HealthCheckConfig struct + Disable bool + Extensions map[string]interface{} + Interval *Duration + Retries *uint64 + StartPeriod *Duration + Test HealthCheckTest + Timeout *Duration + type HealthCheckTest []string + type HostsList []string + type IPAMConfig struct + Config []*IPAMPool + Driver string + Extensions map[string]interface{} + type IPAMPool struct + AuxiliaryAddresses map[string]string + Extensions map[string]interface{} + Gateway string + IPRange string + Subnet string + type Labels map[string]string + func (l Labels) Add(key, value string) Labels + type LoggingConfig struct + Driver string + Extensions map[string]interface{} + Options map[string]string + type Mapping map[string]string + func NewMapping(values []string) Mapping + type MappingWithColon map[string]string + type MappingWithEquals map[string]*string + func NewMappingWithEquals(values []string) MappingWithEquals + func (e MappingWithEquals) OverrideBy(other MappingWithEquals) MappingWithEquals + func (e MappingWithEquals) RemoveEmpty() MappingWithEquals + func (e MappingWithEquals) Resolve(lookupFn func(string) (string, bool)) MappingWithEquals + type NetworkConfig struct + Attachable bool + Driver string + DriverOpts map[string]string + EnableIPv6 bool + Extensions map[string]interface{} + External External + Internal bool + Ipam IPAMConfig + Labels Labels + Name string + type Networks map[string]NetworkConfig + type Placement struct + Constraints []string + Extensions map[string]interface{} + MaxReplicas uint64 + Preferences []PlacementPreferences + type PlacementPreferences struct + Extensions map[string]interface{} + Spread string + type PreRunDependency struct + Condition string + Extensions map[string]interface{} + type Project struct + ComposeFiles []string + Configs Configs + DisabledServices Services + Environment map[string]string + Extensions Extensions + Name string + Networks Networks + Secrets Secrets + Services Services + Volumes Volumes + WorkingDir string + func (p *Project) ApplyProfiles(profiles []string) + func (p *Project) ForServices(names []string) error + func (p *Project) RelativePath(path string) string + func (p *Project) ResolveImages(resolver func(named reference.Named) (digest.Digest, error)) error + func (p *Project) WithoutUnnecessaryResources() + func (p Project) AllServices() Services + func (p Project) ConfigNames() []string + func (p Project) GetService(name string) (ServiceConfig, error) + func (p Project) GetServices(names ...string) (Services, error) + func (p Project) NetworkNames() []string + func (p Project) SecretNames() []string + func (p Project) ServiceNames() []string + func (p Project) VolumeNames() []string + func (p Project) WithServices(names []string, fn ServiceFunc) error + type Resource struct + Devices []DeviceRequest + Extensions map[string]interface{} + GenericResources []GenericResource + MemoryBytes UnitBytes + NanoCPUs string + type Resources struct + Extensions map[string]interface{} + Limits *Resource + Reservations *Resource + type RestartPolicy struct + Condition string + Delay *Duration + Extensions map[string]interface{} + MaxAttempts *uint64 + Window *Duration + type SecretConfig FileObjectConfig + type Secrets map[string]SecretConfig + type ServiceConfig struct + BlkioConfig *BlkioConfig + Build *BuildConfig + CPUCount int64 + CPUPercent float32 + CPUPeriod int64 + CPUQuota int64 + CPURTPeriod int64 + CPURTRuntime int64 + CPUS float32 + CPUSet string + CPUShares int64 + CapAdd []string + CapDrop []string + CgroupParent string + Command ShellCommand + Configs []ServiceConfigObjConfig + ContainerName string + CredentialSpec *CredentialSpecConfig + CustomLabels Labels + DNS StringList + DNSOpts []string + DNSSearch StringList + DependsOnPreRun DependsOnConfig + DependsOnStartOrder DependsOnConfig + DependsPre *string + DependsStart *string + Deploy *DeployConfig + Devices []string + Dockerfile string + DomainName string + Entrypoint ShellCommand + EnvFile StringList + Environment MappingWithEquals + Expose StringOrNumberList + Extends ExtendsConfig + Extensions map[string]interface{} + ExternalLinks []string + ExtraHosts HostsList + GroupAdd []string + HealthCheck *HealthCheckConfig + Hostname string + Image string + Init *bool + Ipc string + Isolation string + Labels Labels + Links []string + LogDriver string + LogOpt map[string]string + Logging *LoggingConfig + MacAddress string + MemLimit UnitBytes + MemReservation UnitBytes + MemSwapLimit UnitBytes + MemSwappiness UnitBytes + Name string + Net string + NetworkMode string + Networks map[string]*ServiceNetworkConfig + OomKillDisable bool + OomScoreAdj int64 + Pid string + PidsLimit int64 + Platform string + Ports []ServicePortConfig + PreRunPolicy string + Privileged bool + Profiles []string + PullPolicy string + ReadOnly bool + Restart string + Runtime string + Scale int + Secrets []ServiceSecretConfig + SecurityOpt []string + ShmSize UnitBytes + StdinOpen bool + StopGracePeriod *Duration + StopSignal string + Sysctls Mapping + Tmpfs StringList + Tty bool + Ulimits map[string]*UlimitsConfig + User string + UserNSMode string + Uts string + VolumeDriver string + Volumes []ServiceVolumeConfig + VolumesFrom []string + WorkingDir string + func (s *ServiceConfig) NetworksByPriority() []string + func (s ServiceConfig) GetPreRunDependencies() []string + func (s ServiceConfig) GetStartOrderDependencies() []string + func (s ServiceConfig) HasProfile(profiles []string) bool + type ServiceConfigObjConfig FileReferenceConfig + type ServiceDependency struct + Condition string + Extensions map[string]interface{} + type ServiceFunc func(service ServiceConfig) error + type ServiceNetworkConfig struct + Aliases []string + Extensions map[string]interface{} + Ipv4Address string + Ipv6Address string + Priority int + type ServicePortConfig struct + Extensions map[string]interface{} + HostIP string + Mode string + Protocol string + Published uint32 + Target uint32 + func ParsePortConfig(value string) ([]ServicePortConfig, error) + type ServiceSecretConfig FileReferenceConfig + type ServiceVolumeBind struct + CreateHostPath bool + Extensions map[string]interface{} + Propagation string + type ServiceVolumeConfig struct + Bind *ServiceVolumeBind + Consistency string + Extensions map[string]interface{} + ReadOnly bool + Source string + Target string + Tmpfs *ServiceVolumeTmpfs + Type string + Volume *ServiceVolumeVolume + type ServiceVolumeTmpfs struct + Extensions map[string]interface{} + Size UnitBytes + type ServiceVolumeVolume struct + Extensions map[string]interface{} + NoCopy bool + type Services []ServiceConfig + func (s Services) GetProfiles() []string + func (s Services) MarshalJSON() ([]byte, error) + func (s Services) MarshalYAML() (interface{}, error) + type ShellCommand []string + type StartOrderDependency struct + Condition string + Extensions map[string]interface{} + type StringList []string + type StringOrNumberList []string + type ThrottleDevice struct + Extensions map[string]interface{} + Path string + Rate uint64 + type UlimitsConfig struct + Extensions map[string]interface{} + Hard int + Single int + Soft int + func (u *UlimitsConfig) MarshalJSON() ([]byte, error) + func (u *UlimitsConfig) MarshalYAML() (interface{}, error) + type UnitBytes int64 + func (u UnitBytes) MarshalJSON() ([]byte, error) + func (u UnitBytes) MarshalYAML() (interface{}, error) + type UpdateConfig struct + Delay Duration + Extensions map[string]interface{} + FailureAction string + MaxFailureRatio float32 + Monitor Duration + Order string + Parallelism *uint64 + type VolumeConfig struct + Driver string + DriverOpts map[string]string + Extensions map[string]interface{} + External External + Labels Labels + Name string + type Volumes map[string]VolumeConfig + type WeightDevice struct + Extensions map[string]interface{} + Path string + Weight uint16
Go to main page