types

package

Go to main page

Versions in this module

v2

v2.1.1

May 16, 2024

Changes in this version

type ServiceNetworkConfig

+ DriverOpts Options

v2.1.0

Apr 23, 2024

Changes in this version

type BuildConfig

+ Entitlements []string

type Project

+ func (p *Project) CheckContainerNameUnicity() error

v2.0.2

Mar 22, 2024

v2.0.1

Mar 21, 2024

Changes in this version

+ type NanoCPUs float32

+ func (n *NanoCPUs) DecodeMapstructure(a any) error

+ func (n *NanoCPUs) Value() float32

v2.0.0

Mar 15, 2024

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 SELinuxPrivate

+ const SELinuxShared

+ const SElinuxShared

+ const SElinuxUnshared

+ const ServiceConditionCompletedSuccessfully

+ const ServiceConditionHealthy

+ const ServiceConditionStarted

+ const ServicePrefix

+ const VolumeTypeBind

+ const VolumeTypeCluster

+ const VolumeTypeNamedPipe

+ const VolumeTypeTmpfs

+ const VolumeTypeVolume

+ func IgnoreDependencies(options *withServicesOptions)

+ func IncludeDependencies(options *withServicesOptions)

+ func IncludeDependents(options *withServicesOptions)

+ type BlkioConfig struct

+ DeviceReadBps []ThrottleDevice

+ DeviceReadIOps []ThrottleDevice

+ DeviceWriteBps []ThrottleDevice

+ DeviceWriteIOps []ThrottleDevice

+ Extensions Extensions

+ Weight uint16

+ WeightDevice []WeightDevice

+ type BuildConfig struct

+ AdditionalContexts Mapping

+ Args MappingWithEquals

+ CacheFrom StringList

+ CacheTo StringList

+ Context string

+ Dockerfile string

+ DockerfileInline string

+ Extensions Extensions

+ ExtraHosts HostsList

+ Isolation string

+ Labels Labels

+ Network string

+ NoCache bool

+ Platforms StringList

+ Privileged bool

+ Pull bool

+ SSH SSHConfig

+ Secrets []ServiceSecretConfig

+ ShmSize UnitBytes

+ Tags StringList

+ Target string

+ Ulimits map[string]*UlimitsConfig

+ type Config struct

+ Configs Configs

+ Extensions Extensions

+ Filename string

+ Include []IncludeConfig

+ Name string

+ Networks Networks

+ Secrets Secrets

+ Services Services

+ Volumes Volumes

+ func (c Config) MarshalJSON() ([]byte, error)

+ type ConfigDetails struct

+ ConfigFiles []ConfigFile

+ Environment Mapping

+ Version string

+ WorkingDir string

+ func (cd *ConfigDetails) LookupEnv(key string) (string, bool)

+ type ConfigFile struct

+ Config map[string]interface{}

+ Content []byte

+ Filename string

+ func ToConfigFiles(path []string) (f []ConfigFile)

+ type ConfigObjConfig FileObjectConfig

+ type Configs map[string]ConfigObjConfig

+ type CredentialSpecConfig struct

+ Config string

+ Extensions Extensions

+ File string

+ Registry string

+ type DependencyOption func(options *withServicesOptions)

+ type DependsOnConfig map[string]ServiceDependency

+ type DeployConfig struct

+ EndpointMode string

+ Extensions Extensions

+ Labels Labels

+ Mode string

+ Placement Placement

+ Replicas *int

+ Resources Resources

+ RestartPolicy *RestartPolicy

+ RollbackConfig *UpdateConfig

+ UpdateConfig *UpdateConfig

+ type DevelopConfig struct

+ Extensions Extensions

+ Watch []Trigger

+ type DeviceCount int64

+ func (c *DeviceCount) DecodeMapstructure(value interface{}) error

+ type DeviceRequest struct

+ Capabilities []string

+ Count DeviceCount

+ Driver string

+ IDs []string

+ type DiscreteGenericResource struct

+ Extensions Extensions

+ Kind string

+ Value int64

+ type Duration time.Duration

+ func (d *Duration) DecodeMapstructure(value interface{}) error

+ 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 EnvFile struct

+ Path string

+ Required bool

+ func (e *EnvFile) MarshalJSON() ([]byte, error)

+ func (e EnvFile) MarshalYAML() (interface{}, error)

+ type ExtendsConfig struct

+ File string

+ Service string

+ type Extensions map[string]interface

+ func (e Extensions) Get(name string, target interface{}) (bool, error)

+ type External bool

+ type FileObjectConfig struct

+ Content string

+ Driver string

+ DriverOpts map[string]string

+ Environment string

+ Extensions Extensions

+ External External

+ File string

+ Labels Labels

+ Name string

+ TemplateDriver string

+ type FileReferenceConfig struct

+ Extensions Extensions

+ GID string

+ Mode *uint32

+ Source string

+ Target string

+ UID string

+ type GenericResource struct

+ DiscreteResourceSpec *DiscreteGenericResource

+ Extensions Extensions

+ type HealthCheckConfig struct

+ Disable bool

+ Extensions Extensions

+ Interval *Duration

+ Retries *uint64

+ StartInterval *Duration

+ StartPeriod *Duration

+ Test HealthCheckTest

+ Timeout *Duration

+ type HealthCheckTest []string

+ func (l *HealthCheckTest) DecodeMapstructure(value interface{}) error

+ type HostsList map[string][]string

+ func NewHostsList(hosts []string) (HostsList, error)

+ func (h *HostsList) DecodeMapstructure(value interface{}) error

+ func (h HostsList) AsList(sep string) []string

+ func (h HostsList) MarshalJSON() ([]byte, error)

+ func (h HostsList) MarshalYAML() (interface{}, error)

+ type IPAMConfig struct

+ Config []*IPAMPool

+ Driver string

+ Extensions Extensions

+ type IPAMPool struct

+ AuxiliaryAddresses Mapping

+ Extensions map[string]interface{}

+ Gateway string

+ IPRange string

+ Subnet string

+ type IncludeConfig struct

+ EnvFile StringList

+ Path StringList

+ ProjectDirectory string

+ type Labels map[string]string

+ func (l *Labels) DecodeMapstructure(value interface{}) error

+ func (l Labels) Add(key, value string) Labels

+ func (l Labels) AsList() []string

+ type LoggingConfig struct

+ Driver string

+ Extensions Extensions

+ Options Options

+ type Mapping map[string]string

+ func NewMapping(values []string) Mapping

+ func (m *Mapping) DecodeMapstructure(value interface{}) error

+ func (m Mapping) Clone() Mapping

+ func (m Mapping) Merge(o Mapping) Mapping

+ func (m Mapping) Resolve(s string) (string, bool)

+ func (m Mapping) ToMappingWithEquals() MappingWithEquals

+ func (m Mapping) Values() []string

+ type MappingWithColon map[string]string

+ type MappingWithEquals map[string]*string

+ func NewMappingWithEquals(values []string) MappingWithEquals

+ func (m *MappingWithEquals) DecodeMapstructure(value interface{}) error

+ func (m MappingWithEquals) OverrideBy(other MappingWithEquals) MappingWithEquals

+ func (m MappingWithEquals) RemoveEmpty() MappingWithEquals

+ func (m MappingWithEquals) Resolve(lookupFn func(string) (string, bool)) MappingWithEquals

+ type NetworkConfig struct

+ Attachable bool

+ Driver string

+ DriverOpts Options

+ EnableIPv6 bool

+ Extensions Extensions

+ External External

+ Internal bool

+ Ipam IPAMConfig

+ Labels Labels

+ Name string

+ type Networks map[string]NetworkConfig

+ type Options map[string]string

+ func (d *Options) DecodeMapstructure(value interface{}) error

+ type Placement struct

+ Constraints []string

+ Extensions Extensions

+ MaxReplicas uint64

+ Preferences []PlacementPreferences

+ type PlacementPreferences struct

+ Extensions Extensions

+ Spread string

+ type Project struct

+ ComposeFiles []string

+ Configs Configs

+ DisabledServices Services

+ Environment Mapping

+ Extensions Extensions

+ Name string

+ Networks Networks

+ Profiles []string

+ Secrets Secrets

+ Services Services

+ Volumes Volumes

+ WorkingDir string

+ func (p *Project) AllServices() Services

+ func (p *Project) ConfigNames() []string

+ func (p *Project) DisabledServiceNames() []string

+ func (p *Project) ForEachService(names []string, fn ServiceFunc, options ...DependencyOption) error

+ func (p *Project) GetDependentsForService(s ServiceConfig) []string

+ func (p *Project) GetService(name string) (ServiceConfig, error)

+ func (p *Project) GetServices(names ...string) (Services, error)

+ func (p *Project) MarshalJSON() ([]byte, error)

+ func (p *Project) MarshalYAML() ([]byte, error)

+ func (p *Project) NetworkNames() []string

+ func (p *Project) RelativePath(path string) string

+ func (p *Project) SecretNames() []string

+ func (p *Project) ServiceNames() []string

+ func (p *Project) ServicesWithBuild() []string

+ func (p *Project) ServicesWithCapabilities() ([]string, []string, []string)

+ func (p *Project) ServicesWithDependsOn() []string

+ func (p *Project) ServicesWithExtends() []string

+ func (p *Project) VolumeNames() []string

+ func (p *Project) WithImagesResolved(resolver func(named reference.Named) (godigest.Digest, error)) (*Project, error)

+ func (p *Project) WithProfiles(profiles []string) (*Project, error)

+ func (p *Project) WithSelectedServices(names []string, options ...DependencyOption) (*Project, error)

+ func (p *Project) WithServicesDisabled(names ...string) *Project

+ func (p *Project) WithServicesEnabled(names ...string) (*Project, error)

+ func (p *Project) WithServicesTransform(fn func(name string, s ServiceConfig) (ServiceConfig, error)) (*Project, error)

+ func (p *Project) WithoutUnnecessaryResources() *Project

+ func (p Project) GetDisabledService(name string) (ServiceConfig, error)

+ func (p Project) WithServicesEnvironmentResolved(discardEnvFiles bool) (*Project, error)

+ type Resource struct

+ Devices []DeviceRequest

+ Extensions Extensions

+ GenericResources []GenericResource

+ MemoryBytes UnitBytes

+ NanoCPUs string

+ Pids int64

+ type Resources struct

+ Extensions Extensions

+ Limits *Resource

+ Reservations *Resource

+ type RestartPolicy struct

+ Condition string

+ Delay *Duration

+ Extensions Extensions

+ MaxAttempts *uint64

+ Window *Duration

+ type SSHConfig []SSHKey

+ func (s *SSHConfig) DecodeMapstructure(value interface{}) error

+ func (s SSHConfig) Get(id string) (string, error)

+ type SSHKey struct

+ ID string

+ Path string

+ func (s SSHKey) MarshalJSON() ([]byte, error)

+ func (s SSHKey) MarshalYAML() (interface{}, error)

+ type SecretConfig FileObjectConfig

+ type Secrets map[string]SecretConfig

+ type ServiceConfig struct

+ Annotations Mapping

+ Attach *bool

+ 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

+ Cgroup string

+ CgroupParent string

+ Command ShellCommand

+ Configs []ServiceConfigObjConfig

+ ContainerName string

+ CredentialSpec *CredentialSpecConfig

+ CustomLabels Labels

+ DNS StringList

+ DNSOpts []string

+ DNSSearch StringList

+ DependsOn DependsOnConfig

+ Deploy *DeployConfig

+ Develop *DevelopConfig

+ DeviceCgroupRules []string

+ Devices []string

+ Dockerfile string

+ DomainName string

+ Entrypoint ShellCommand

+ EnvFiles []EnvFile

+ Environment MappingWithEquals

+ Expose StringOrNumberList

+ Extends *ExtendsConfig

+ Extensions Extensions

+ 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

+ 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

+ StorageOpt map[string]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) GetScale() int

+ func (s *ServiceConfig) NetworksByPriority() []string

+ func (s *ServiceConfig) SetScale(scale int)

+ func (s ServiceConfig) GetDependencies() []string

+ func (s ServiceConfig) GetDependents(p *Project) []string

+ func (s ServiceConfig) HasProfile(profiles []string) bool

+ func (s ServiceConfig) MarshalYAML() (interface{}, error)

+ type ServiceConfigObjConfig FileReferenceConfig

+ type ServiceDependency struct

+ Condition string

+ Extensions Extensions

+ Required bool

+ Restart bool

+ type ServiceFunc func(name string, service *ServiceConfig) error

+ type ServiceNetworkConfig struct

+ Aliases []string

+ Extensions Extensions

+ Ipv4Address string

+ Ipv6Address string

+ LinkLocalIPs []string

+ MacAddress string

+ Priority int

+ type ServicePortConfig struct

+ AppProtocol string

+ Extensions Extensions

+ HostIP string

+ Mode string

+ Name string

+ Protocol string

+ Published string

+ Target uint32

+ func ParsePortConfig(value string) ([]ServicePortConfig, error)

+ type ServiceSecretConfig FileReferenceConfig

+ type ServiceVolumeBind struct

+ CreateHostPath bool

+ Extensions Extensions

+ Propagation string

+ SELinux string

+ type ServiceVolumeConfig struct

+ Bind *ServiceVolumeBind

+ Consistency string

+ Extensions Extensions

+ ReadOnly bool

+ Source string

+ Target string

+ Tmpfs *ServiceVolumeTmpfs

+ Type string

+ Volume *ServiceVolumeVolume

+ func (s ServiceVolumeConfig) String() string

+ type ServiceVolumeTmpfs struct

+ Extensions Extensions

+ Mode uint32

+ Size UnitBytes

+ type ServiceVolumeVolume struct

+ Extensions Extensions

+ NoCopy bool

+ Subpath string

+ type Services map[string]ServiceConfig

+ func (s Services) Filter(predicate func(ServiceConfig) bool) Services

+ func (s Services) GetProfiles() []string

+ type ShellCommand []string

+ func (s *ShellCommand) DecodeMapstructure(value interface{}) error

+ func (s ShellCommand) IsZero() bool

+ func (s ShellCommand) MarshalYAML() (interface{}, error)

+ type StringList []string

+ func (l *StringList) DecodeMapstructure(value interface{}) error

+ type StringOrNumberList []string

+ func (l *StringOrNumberList) DecodeMapstructure(value interface{}) error

+ type ThrottleDevice struct

+ Extensions Extensions

+ Path string

+ Rate UnitBytes

+ type Trigger struct

+ Action WatchAction

+ Ignore []string

+ Path string

+ Target string

+ type UlimitsConfig struct

+ Extensions Extensions

+ Hard int

+ Single int

+ Soft int

+ func (u *UlimitsConfig) DecodeMapstructure(value interface{}) error

+ func (u *UlimitsConfig) MarshalJSON() ([]byte, error)

+ func (u *UlimitsConfig) MarshalYAML() (interface{}, error)

+ type UnitBytes int64

+ func (u *UnitBytes) DecodeMapstructure(value interface{}) error

+ func (u UnitBytes) MarshalJSON() ([]byte, error)

+ func (u UnitBytes) MarshalYAML() (interface{}, error)

+ type UpdateConfig struct

+ Delay Duration

+ Extensions Extensions

+ FailureAction string

+ MaxFailureRatio float32

+ Monitor Duration

+ Order string

+ Parallelism *uint64

+ type VolumeConfig struct

+ Driver string

+ DriverOpts Options

+ Extensions Extensions

+ External External

+ Labels Labels

+ Name string

+ type Volumes map[string]VolumeConfig

+ type WatchAction string

+ const WatchActionRebuild

+ const WatchActionSync

+ const WatchActionSyncRestart

+ type WeightDevice struct

+ Extensions Extensions

+ Path string

+ Weight uint16

v2.0.0-rc.8

Feb 21, 2024

v2.0.0-rc.7

Feb 15, 2024

v2.0.0-rc.6

Feb 14, 2024

v2.0.0-rc.5

Feb 7, 2024

v2.0.0-rc.4

Feb 6, 2024

v2.0.0-rc.3

Jan 29, 2024

v2.0.0-rc.2

Jan 22, 2024

v2.0.0-rc.1

Jan 17, 2024

v2.0.0-beta.3

Jan 10, 2024

v2.0.0-beta.2

Dec 21, 2023

v2.0.0-beta.1

Nov 29, 2023

Other modules containing this package

github.com/compose-spec/compose-go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL