types

package
v0.8.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 16, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Package types catalogs github.com/compose-spec/compose-go/v2/types for wrapping by containerkit.

Code generated by go run ./tools/gencatalog; DO NOT EDIT.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types

Each identifier keeps the exact upstream type name. Domain isolation lives in the import path (internal/compose/types), not in renamed aliases.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BlkioConfig

type BlkioConfig = composetypes.BlkioConfig

BlkioConfig wraps types.BlkioConfig.

BlkioConfig define blkio config

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#BlkioConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type BlkioConfig.

type BuildConfig

type BuildConfig = composetypes.BuildConfig

BuildConfig wraps types.BuildConfig.

BuildConfig is a type for build

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#BuildConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/build.go Kind: struct Usecase: wrap the Compose file object model type BuildConfig.

type Config

type Config = composetypes.Config

Config wraps types.Config.

Config is a full compose file configuration and model

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Config GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/config.go Kind: struct Usecase: wrap the Compose file object model type Config.

type ConfigDetails

type ConfigDetails = composetypes.ConfigDetails

ConfigDetails wraps types.ConfigDetails.

ConfigDetails are the details about a group of ConfigFiles

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ConfigDetails GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/config.go Kind: struct Usecase: wrap the Compose file object model type ConfigDetails.

type ConfigFile

type ConfigFile = composetypes.ConfigFile

ConfigFile wraps types.ConfigFile.

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

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ConfigFile GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/config.go Kind: struct Usecase: wrap the Compose file object model type ConfigFile.

type ConfigObjConfig

type ConfigObjConfig = composetypes.ConfigObjConfig

ConfigObjConfig wraps types.ConfigObjConfig.

ConfigObjConfig is the config for the swarm "Config" object

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ConfigObjConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: named:FileObjectConfig Underlying: FileObjectConfig Usecase: wrap the Compose file object model type ConfigObjConfig.

type Configs

type Configs = composetypes.Configs

Configs wraps types.Configs.

Configs is a map of ConfigObjConfig

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Configs GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/config.go Kind: map Underlying: map[string]ConfigObjConfig Usecase: wrap the Compose file object model type Configs.

type ContainerSpec

type ContainerSpec = composetypes.ContainerSpec

ContainerSpec wraps types.ContainerSpec.

ContainerSpec defines the runtime configuration for a container. It is the common set of attributes shared by services, jobs, and other container-based elements. ContainerSpec holds the attributes shared by anything that runs a container: services, jobs, and run-to-completion init containers (pre_start hooks).

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ContainerSpec GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type ContainerSpec.

type CredentialSpecConfig

type CredentialSpecConfig = composetypes.CredentialSpecConfig

CredentialSpecConfig wraps types.CredentialSpecConfig.

CredentialSpecConfig for credential spec on Windows

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#CredentialSpecConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type CredentialSpecConfig.

type DependencyOption

type DependencyOption = composetypes.DependencyOption

DependencyOption wraps types.DependencyOption.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#DependencyOption GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/project.go Kind: func Underlying: func(options *withServicesOptions) Usecase: wrap the Compose file object model type DependencyOption.

type DependsOnConfig

type DependsOnConfig = composetypes.DependsOnConfig

DependsOnConfig wraps types.DependsOnConfig.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#DependsOnConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: map Underlying: map[string]ServiceDependency Usecase: wrap the Compose file object model type DependsOnConfig.

type DeployConfig

type DeployConfig = composetypes.DeployConfig

DeployConfig wraps types.DeployConfig.

DeployConfig the deployment configuration for a service

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#DeployConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type DeployConfig.

type DevelopConfig

type DevelopConfig = composetypes.DevelopConfig

DevelopConfig wraps types.DevelopConfig.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#DevelopConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/develop.go Kind: struct Usecase: wrap the Compose file object model type DevelopConfig.

type DeviceCount

type DeviceCount = composetypes.DeviceCount

DeviceCount wraps types.DeviceCount.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#DeviceCount GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/device.go Kind: named:int64 Underlying: int64 Usecase: wrap the Compose file object model type DeviceCount.

type DeviceMapping

type DeviceMapping = composetypes.DeviceMapping

DeviceMapping wraps types.DeviceMapping.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#DeviceMapping GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type DeviceMapping.

type DeviceRequest

type DeviceRequest = composetypes.DeviceRequest

DeviceRequest wraps types.DeviceRequest.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#DeviceRequest GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/device.go Kind: struct Usecase: wrap the Compose file object model type DeviceRequest.

type DiscreteGenericResource

type DiscreteGenericResource = composetypes.DiscreteGenericResource

DiscreteGenericResource wraps types.DiscreteGenericResource.

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, ...)

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#DiscreteGenericResource GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type DiscreteGenericResource.

type Duration

type Duration = composetypes.Duration

Duration wraps types.Duration.

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

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Duration GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/duration.go Kind: named:time.Duration Underlying: time.Duration References: time.Duration Usecase: wrap the Compose file object model type Duration.

type EnvFile

type EnvFile = composetypes.EnvFile

EnvFile wraps types.EnvFile.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#EnvFile GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/envfile.go Kind: struct Usecase: wrap the Compose file object model type EnvFile.

type ExtendsConfig

type ExtendsConfig = composetypes.ExtendsConfig

ExtendsConfig wraps types.ExtendsConfig.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ExtendsConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type ExtendsConfig.

type Extensions

type Extensions = composetypes.Extensions

Extensions wraps types.Extensions.

Extensions is a map of custom extension

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Extensions GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/config.go Kind: map Underlying: map[string]any Usecase: wrap the Compose file object model type Extensions.

type External

type External = composetypes.External

External wraps types.External.

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

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#External GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: named:bool Underlying: bool Usecase: wrap the Compose file object model type External.

type FileMode

type FileMode = composetypes.FileMode

FileMode wraps types.FileMode.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#FileMode GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: named:int64 Underlying: int64 Usecase: wrap the Compose file object model type FileMode.

type FileObjectConfig

type FileObjectConfig = composetypes.FileObjectConfig

FileObjectConfig wraps types.FileObjectConfig.

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

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#FileObjectConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type FileObjectConfig.

type FileReferenceConfig

type FileReferenceConfig = composetypes.FileReferenceConfig

FileReferenceConfig wraps types.FileReferenceConfig.

FileReferenceConfig for a reference to a swarm file object

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#FileReferenceConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type FileReferenceConfig.

type GenericResource

type GenericResource = composetypes.GenericResource

GenericResource wraps types.GenericResource.

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

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#GenericResource GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type GenericResource.

type HealthCheckConfig

type HealthCheckConfig = composetypes.HealthCheckConfig

HealthCheckConfig wraps types.HealthCheckConfig.

HealthCheckConfig the healthcheck configuration for a service

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#HealthCheckConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/healthcheck.go Kind: struct Usecase: wrap the Compose file object model type HealthCheckConfig.

type HealthCheckTest

type HealthCheckTest = composetypes.HealthCheckTest

HealthCheckTest wraps types.HealthCheckTest.

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

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#HealthCheckTest GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/healthcheck.go Kind: slice Underlying: []string Usecase: wrap the Compose file object model type HealthCheckTest.

type HostsList

type HostsList = composetypes.HostsList

HostsList wraps types.HostsList.

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

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#HostsList GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/hostList.go Kind: map Underlying: map[string][]string Usecase: wrap the Compose file object model type HostsList.

type IPAMConfig

type IPAMConfig = composetypes.IPAMConfig

IPAMConfig wraps types.IPAMConfig.

IPAMConfig for a network

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#IPAMConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type IPAMConfig.

type IPAMPool

type IPAMPool = composetypes.IPAMPool

IPAMPool wraps types.IPAMPool.

IPAMPool for a network

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#IPAMPool GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type IPAMPool.

type IncludeConfig

type IncludeConfig = composetypes.IncludeConfig

IncludeConfig wraps types.IncludeConfig.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#IncludeConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type IncludeConfig.

type JobConfig

type JobConfig = composetypes.JobConfig

JobConfig wraps types.JobConfig.

JobConfig is the configuration of one job

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#JobConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/jobs.go Kind: struct Usecase: wrap the Compose file object model type JobConfig.

type Jobs

type Jobs = composetypes.Jobs

Jobs wraps types.Jobs.

Jobs is a mapping of job names to job configurations

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Jobs GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/jobs.go Kind: map Underlying: map[string]JobConfig Usecase: wrap the Compose file object model type Jobs.

type Labels

type Labels = composetypes.Labels

Labels wraps types.Labels.

Labels is a mapping type for labels

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Labels GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/labels.go Kind: map Underlying: map[string]string Usecase: wrap the Compose file object model type Labels.

type LoggingConfig

type LoggingConfig = composetypes.LoggingConfig

LoggingConfig wraps types.LoggingConfig.

LoggingConfig the logging configuration for a service

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#LoggingConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type LoggingConfig.

type Mapping

type Mapping = composetypes.Mapping

Mapping wraps types.Mapping.

Mapping is a mapping type that can be converted from a list of key[=value] strings. For the key with an empty value (`key=`), or key without value (`key`), the mapped value is set to an empty string `""`.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Mapping GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/mapping.go Kind: map Underlying: map[string]string Usecase: wrap the Compose file object model type Mapping.

type MappingWithColon

type MappingWithColon = composetypes.MappingWithColon

MappingWithColon wraps types.MappingWithColon.

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

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#MappingWithColon GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: map Underlying: map[string]string Usecase: wrap the Compose file object model type MappingWithColon.

type MappingWithEquals

type MappingWithEquals = composetypes.MappingWithEquals

MappingWithEquals wraps types.MappingWithEquals.

MappingWithEquals is a mapping type that can be converted from a list of key[=value] strings. For the key with an empty value (`key=`), the mapped value is set to a pointer to `""`. For the key without value (`key`), the mapped value is set to nil.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#MappingWithEquals GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/mapping.go Kind: map Underlying: map[string]*string Usecase: wrap the Compose file object model type MappingWithEquals.

type ModelConfig

type ModelConfig = composetypes.ModelConfig

ModelConfig wraps types.ModelConfig.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ModelConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/models.go Kind: struct Usecase: wrap the Compose file object model type ModelConfig.

type Models

type Models = composetypes.Models

Models wraps types.Models.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Models GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/config.go Kind: map Underlying: map[string]ModelConfig Usecase: wrap the Compose file object model type Models.

type MultiOptions

type MultiOptions = composetypes.MultiOptions

MultiOptions wraps types.MultiOptions.

MultiOptions allow option to be repeated

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#MultiOptions GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/options.go Kind: map Underlying: map[string][]string Usecase: wrap the Compose file object model type MultiOptions.

type NanoCPUs

type NanoCPUs = composetypes.NanoCPUs

NanoCPUs wraps types.NanoCPUs.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#NanoCPUs GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/cpus.go Kind: named:float32 Underlying: float32 Usecase: wrap the Compose file object model type NanoCPUs.

type NetworkConfig

type NetworkConfig = composetypes.NetworkConfig

NetworkConfig wraps types.NetworkConfig.

NetworkConfig for a network

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#NetworkConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type NetworkConfig.

type Networks

type Networks = composetypes.Networks

Networks wraps types.Networks.

Networks is a map of NetworkConfig

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Networks GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/config.go Kind: map Underlying: map[string]NetworkConfig Usecase: wrap the Compose file object model type Networks.

type OptOut

type OptOut = composetypes.OptOut

OptOut wraps types.OptOut.

OptOut is a boolean which default value is 'true'

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#OptOut GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: named:bool Underlying: bool Usecase: wrap the Compose file object model type OptOut.

type Options

type Options = composetypes.Options

Options wraps types.Options.

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

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Options GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/options.go Kind: map Underlying: map[string]string Usecase: wrap the Compose file object model type Options.

type Placement

type Placement = composetypes.Placement

Placement wraps types.Placement.

Placement constraints for the service

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Placement GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type Placement.

type PlacementPreferences

type PlacementPreferences = composetypes.PlacementPreferences

PlacementPreferences wraps types.PlacementPreferences.

PlacementPreferences is the preferences for a service placement

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#PlacementPreferences GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type PlacementPreferences.

type PreStartHook

type PreStartHook = composetypes.PreStartHook

PreStartHook wraps types.PreStartHook.

PreStartHook is an init container run to completion before the service starts. It accepts the full container specification, inheriting from the service in the spirit of the yaml merge rules: collection attributes complete the inherited value with the hook's declarations winning on conflicts, scalar attributes replace it (image is inherited via normalization when undeclared).

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#PreStartHook GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/hooks.go Kind: struct Usecase: wrap the Compose file object model type PreStartHook.

type Project

type Project = composetypes.Project

Project wraps types.Project.

Project is the result of loading a set of compose files Since v2, Project are managed as immutable objects. Each public functions which mutate Project state now return a copy of the original Project with the expected changes.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Project GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/project.go Kind: struct Usecase: wrap the Compose file object model type Project.

type Resource

type Resource = composetypes.Resource

Resource wraps types.Resource.

Resource is a resource to be limited or reserved

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Resource GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type Resource.

type Resources

type Resources = composetypes.Resources

Resources wraps types.Resources.

Resources the resource limits and reservations

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Resources GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type Resources.

type RestartPolicy

type RestartPolicy = composetypes.RestartPolicy

RestartPolicy wraps types.RestartPolicy.

RestartPolicy the service restart policy

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#RestartPolicy GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type RestartPolicy.

type SSHConfig

type SSHConfig = composetypes.SSHConfig

SSHConfig wraps types.SSHConfig.

SSHConfig is a mapping type for SSH build config

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#SSHConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/ssh.go Kind: slice Underlying: []SSHKey Usecase: wrap the Compose file object model type SSHConfig.

type SSHKey

type SSHKey = composetypes.SSHKey

SSHKey wraps types.SSHKey.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#SSHKey GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/ssh.go Kind: struct Usecase: wrap the Compose file object model type SSHKey.

type ScheduleConfig

type ScheduleConfig = composetypes.ScheduleConfig

ScheduleConfig wraps types.ScheduleConfig.

ScheduleConfig defines a schedule for a job trigger. A plain crontab expression in yaml is canonicalized into a ScheduleConfig with only Cron set.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ScheduleConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/jobs.go Kind: struct Usecase: wrap the Compose file object model type ScheduleConfig.

type SecretConfig

type SecretConfig = composetypes.SecretConfig

SecretConfig wraps types.SecretConfig.

SecretConfig for a secret

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#SecretConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: named:FileObjectConfig Underlying: FileObjectConfig Usecase: wrap the Compose file object model type SecretConfig.

type Secrets

type Secrets = composetypes.Secrets

Secrets wraps types.Secrets.

Secrets is a map of SecretConfig

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Secrets GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/config.go Kind: map Underlying: map[string]SecretConfig Usecase: wrap the Compose file object model type Secrets.

type ServiceConfig

type ServiceConfig = composetypes.ServiceConfig

ServiceConfig wraps types.ServiceConfig.

ServiceConfig is the configuration of one service

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ServiceConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type ServiceConfig.

type ServiceConfigObjConfig

type ServiceConfigObjConfig = composetypes.ServiceConfigObjConfig

ServiceConfigObjConfig wraps types.ServiceConfigObjConfig.

ServiceConfigObjConfig is the config obj configuration for a service

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ServiceConfigObjConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: named:FileReferenceConfig Underlying: FileReferenceConfig Usecase: wrap the Compose file object model type ServiceConfigObjConfig.

type ServiceDependency

type ServiceDependency = composetypes.ServiceDependency

ServiceDependency wraps types.ServiceDependency.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ServiceDependency GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type ServiceDependency.

type ServiceFunc

type ServiceFunc = composetypes.ServiceFunc

ServiceFunc wraps types.ServiceFunc.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ServiceFunc GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/project.go Kind: func Underlying: func(name string, service *ServiceConfig) error Usecase: wrap the Compose file object model type ServiceFunc.

type ServiceHook

type ServiceHook = composetypes.ServiceHook

ServiceHook wraps types.ServiceHook.

ServiceHook is a command exec'd inside the service container at a lifecycle event (post_start, pre_stop).

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ServiceHook GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/hooks.go Kind: struct Usecase: wrap the Compose file object model type ServiceHook.

type ServiceModelConfig

type ServiceModelConfig = composetypes.ServiceModelConfig

ServiceModelConfig wraps types.ServiceModelConfig.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ServiceModelConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/models.go Kind: struct Usecase: wrap the Compose file object model type ServiceModelConfig.

type ServiceNetworkConfig

type ServiceNetworkConfig = composetypes.ServiceNetworkConfig

ServiceNetworkConfig wraps types.ServiceNetworkConfig.

ServiceNetworkConfig is the network configuration for a service

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ServiceNetworkConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type ServiceNetworkConfig.

type ServicePortConfig

type ServicePortConfig = composetypes.ServicePortConfig

ServicePortConfig wraps types.ServicePortConfig.

ServicePortConfig is the port configuration for a service

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ServicePortConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type ServicePortConfig.

type ServiceProviderConfig

type ServiceProviderConfig = composetypes.ServiceProviderConfig

ServiceProviderConfig wraps types.ServiceProviderConfig.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ServiceProviderConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type ServiceProviderConfig.

type ServiceSecretConfig

type ServiceSecretConfig = composetypes.ServiceSecretConfig

ServiceSecretConfig wraps types.ServiceSecretConfig.

ServiceSecretConfig is the secret configuration for a service

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ServiceSecretConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: named:FileReferenceConfig Underlying: FileReferenceConfig Usecase: wrap the Compose file object model type ServiceSecretConfig.

type ServiceVolumeBind

type ServiceVolumeBind = composetypes.ServiceVolumeBind

ServiceVolumeBind wraps types.ServiceVolumeBind.

ServiceVolumeBind are options for a service volume of type bind

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ServiceVolumeBind GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type ServiceVolumeBind.

type ServiceVolumeConfig

type ServiceVolumeConfig = composetypes.ServiceVolumeConfig

ServiceVolumeConfig wraps types.ServiceVolumeConfig.

ServiceVolumeConfig are references to a volume used by a service

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ServiceVolumeConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type ServiceVolumeConfig.

type ServiceVolumeImage

type ServiceVolumeImage = composetypes.ServiceVolumeImage

ServiceVolumeImage wraps types.ServiceVolumeImage.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ServiceVolumeImage GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type ServiceVolumeImage.

type ServiceVolumeTmpfs

type ServiceVolumeTmpfs = composetypes.ServiceVolumeTmpfs

ServiceVolumeTmpfs wraps types.ServiceVolumeTmpfs.

ServiceVolumeTmpfs are options for a service volume of type tmpfs

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ServiceVolumeTmpfs GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type ServiceVolumeTmpfs.

type ServiceVolumeVolume

type ServiceVolumeVolume = composetypes.ServiceVolumeVolume

ServiceVolumeVolume wraps types.ServiceVolumeVolume.

ServiceVolumeVolume are options for a service volume of type volume

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ServiceVolumeVolume GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type ServiceVolumeVolume.

type Services

type Services = composetypes.Services

Services wraps types.Services.

Services is a map of ServiceConfig

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Services GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/services.go Kind: map Underlying: map[string]ServiceConfig Usecase: wrap the Compose file object model type Services.

type ShellCommand

type ShellCommand = composetypes.ShellCommand

ShellCommand wraps types.ShellCommand.

ShellCommand is a string or list of string args.

When marshaled to YAML, nil command fields will be omitted if `omitempty` is specified as a struct tag. Explicitly empty commands (i.e. `[]` or empty string will serialize to an empty array (`[]`).

When marshaled to JSON, the `omitempty` struct must NOT be specified. If the command field is nil, it will be serialized as `null`. Explicitly empty commands (i.e. `[]` or empty string) will serialize to an empty array (`[]`).

The distinction between nil and explicitly empty is important to distinguish between an unset value and a provided, but empty, value, which should be preserved so that it can override any base value (e.g. container entrypoint).

The different semantics between YAML and JSON are due to limitations with JSON marshaling + `omitempty` in the Go stdlib, while go.yaml.in/yaml/v4 gives us more flexibility via the yaml.IsZeroer interface.

In the future, it might make sense to make fields of this type be `*ShellCommand` to avoid this situation, but that would constitute a breaking change.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ShellCommand GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/command.go Kind: slice Underlying: []string Usecase: wrap the Compose file object model type ShellCommand.

type StringList

type StringList = composetypes.StringList

StringList wraps types.StringList.

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

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#StringList GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/stringOrList.go Kind: slice Underlying: []string Usecase: wrap the Compose file object model type StringList.

type StringOrNumberList

type StringOrNumberList = composetypes.StringOrNumberList

StringOrNumberList wraps types.StringOrNumberList.

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

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#StringOrNumberList GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/stringOrList.go Kind: slice Underlying: []string Usecase: wrap the Compose file object model type StringOrNumberList.

type ThrottleDevice

type ThrottleDevice = composetypes.ThrottleDevice

ThrottleDevice wraps types.ThrottleDevice.

ThrottleDevice is a structure that holds device:rate_per_second pair

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#ThrottleDevice GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type ThrottleDevice.

type Trigger

type Trigger = composetypes.Trigger

Trigger wraps types.Trigger.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Trigger GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/develop.go Kind: struct Usecase: wrap the Compose file object model type Trigger.

type TriggerConfig

type TriggerConfig = composetypes.TriggerConfig

TriggerConfig wraps types.TriggerConfig.

TriggerConfig defines trigger conditions for a job. Manual is tri-state: nil (unset) leaves manual execution allowed — any job can be triggered by an explicit run command; an explicit false forbids it; an explicit true declares the job as manual-only intent.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#TriggerConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/jobs.go Kind: struct Usecase: wrap the Compose file object model type TriggerConfig.

type UlimitsConfig

type UlimitsConfig = composetypes.UlimitsConfig

UlimitsConfig wraps types.UlimitsConfig.

UlimitsConfig the ulimit configuration

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#UlimitsConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type UlimitsConfig.

type UnitBytes

type UnitBytes = composetypes.UnitBytes

UnitBytes wraps types.UnitBytes.

UnitBytes is the bytes type

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#UnitBytes GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/bytes.go Kind: named:int64 Underlying: int64 Usecase: wrap the Compose file object model type UnitBytes.

type UpdateConfig

type UpdateConfig = composetypes.UpdateConfig

UpdateConfig wraps types.UpdateConfig.

UpdateConfig the service update configuration

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#UpdateConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type UpdateConfig.

type VolumeConfig

type VolumeConfig = composetypes.VolumeConfig

VolumeConfig wraps types.VolumeConfig.

VolumeConfig for a volume

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#VolumeConfig GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type VolumeConfig.

type Volumes

type Volumes = composetypes.Volumes

Volumes wraps types.Volumes.

Volumes is a map of VolumeConfig

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#Volumes GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/config.go Kind: map Underlying: map[string]VolumeConfig Usecase: wrap the Compose file object model type Volumes.

type WatchAction

type WatchAction = composetypes.WatchAction

WatchAction wraps types.WatchAction.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#WatchAction GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/develop.go Kind: named:string Underlying: string Usecase: wrap the Compose file object model type WatchAction.

type WeightDevice

type WeightDevice = composetypes.WeightDevice

WeightDevice wraps types.WeightDevice.

WeightDevice is a structure that holds device:weight pair

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#WeightDevice GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type WeightDevice.

type WorkloadSpec

type WorkloadSpec = composetypes.WorkloadSpec

WorkloadSpec wraps types.WorkloadSpec.

WorkloadSpec holds container attributes meaningful for orchestrated workloads (services and jobs) but not for run-to-completion init containers: build, dependency ordering, health reporting, port exposure and interactivity.

Source: https://pkg.go.dev/github.com/compose-spec/compose-go/v2/types#WorkloadSpec GitHub: https://github.com/compose-spec/compose-go/blob/v2.16.2/types/types.go Kind: struct Usecase: wrap the Compose file object model type WorkloadSpec.

Jump to

Keyboard shortcuts

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