Documentation ¶
Index ¶
- Constants
- type Address
- type AuthConfig
- type BuildCache
- type BuildInfo
- type ClusterInfo
- type Commit
- type Config
- type ConfigSpec
- type ContainerConfig
- type ContainerSummary
- type ContainerSummaryItems0
- type ContainerSummaryItems0HostConfig
- type ContainerSummaryItems0NetworkSettings
- type CreateImageInfo
- type DeviceMapping
- type DeviceRequest
- type Driver
- type EndpointIPAMConfig
- type EndpointPortConfig
- type EndpointSettings
- type EndpointSpec
- type EngineDescription
- type EngineDescriptionPluginsItems0
- type ErrorDetail
- type ErrorResponse
- type GenericResources
- type GenericResourcesItems0
- type GenericResourcesItems0DiscreteResourceSpec
- type GenericResourcesItems0NamedResourceSpec
- type GraphDriverData
- type HealthConfig
- type HostConfig
- type HostConfigAO1LogConfig
- type IDResponse
- type IPAM
- type Image
- type ImageDeleteResponseItem
- type ImageID
- type ImageMetadata
- type ImageRootFS
- type ImageSummary
- type IndexInfo
- type JoinTokens
- type LocalNodeState
- type ManagerStatus
- type Mount
- type MountBindOptions
- type MountPoint
- type MountTmpfsOptions
- type MountVolumeOptions
- type MountVolumeOptionsDriverConfig
- type Network
- type NetworkContainer
- type NetworkSettings
- type Node
- type NodeDescription
- type NodeSpec
- type NodeState
- type NodeStatus
- type ObjectVersion
- type PeerNode
- type Platform
- type Plugin
- type PluginConfig
- type PluginConfigArgs
- type PluginConfigInterface
- type PluginConfigLinux
- type PluginConfigNetwork
- type PluginConfigRootfs
- type PluginConfigUser
- type PluginDevice
- type PluginEnv
- type PluginInterfaceType
- type PluginMount
- type PluginSettings
- type PluginsInfo
- type Port
- type PortBinding
- type PortMap
- type ProcessConfig
- type ProgressDetail
- type PushImageInfo
- type Reachability
- type RegistryServiceConfig
- type ResourceObject
- type Resources
- type ResourcesBlkioWeightDeviceItems0
- type ResourcesUlimitsItems0
- type RestartPolicy
- type Runtime
- type Secret
- type SecretSpec
- type Service
- type ServiceEndpoint
- type ServiceEndpointVirtualIpsItems0
- type ServiceSpec
- type ServiceSpecMode
- type ServiceSpecModeReplicated
- type ServiceSpecNetworksItems0
- type ServiceSpecRollbackConfig
- type ServiceSpecUpdateConfig
- type ServiceUpdateResponse
- type ServiceUpdateStatus
- type Swarm
- type SwarmInfo
- type SwarmSpec
- type SwarmSpecCAConfig
- type SwarmSpecCAConfigExternalCAsItems0
- type SwarmSpecDispatcher
- type SwarmSpecEncryptionConfig
- type SwarmSpecOrchestration
- type SwarmSpecRaft
- type SwarmSpecTaskDefaults
- type SwarmSpecTaskDefaultsLogDriver
- type SystemInfo
- type TLSInfo
- type Task
- type TaskSpec
- type TaskSpecContainerSpec
- type TaskSpecContainerSpecConfigsItems0
- type TaskSpecContainerSpecConfigsItems0File
- type TaskSpecContainerSpecDNSConfig
- type TaskSpecContainerSpecPrivileges
- type TaskSpecContainerSpecPrivilegesCredentialSpec
- type TaskSpecContainerSpecPrivilegesSELinuxContext
- type TaskSpecContainerSpecSecretsItems0
- type TaskSpecContainerSpecSecretsItems0File
- type TaskSpecLogDriver
- type TaskSpecNetworkAttachmentSpec
- type TaskSpecNetworksItems0
- type TaskSpecPlacement
- type TaskSpecPlacementPreferencesItems0
- type TaskSpecPlacementPreferencesItems0Spread
- type TaskSpecPluginSpec
- type TaskSpecPluginSpecPluginPrivilegeItems0
- type TaskSpecResources
- type TaskSpecRestartPolicy
- type TaskState
- type TaskStatus
- type TaskStatusContainerStatus
- type ThrottleDevice
- type Volume
- type VolumeUsageData
Constants ¶
const ( // EndpointPortConfigProtocolTCP captures enum value "tcp" EndpointPortConfigProtocolTCP string = "tcp" // EndpointPortConfigProtocolUDP captures enum value "udp" EndpointPortConfigProtocolUDP string = "udp" // EndpointPortConfigProtocolSctp captures enum value "sctp" EndpointPortConfigProtocolSctp string = "sctp" )
const ( // EndpointPortConfigPublishModeIngress captures enum value "ingress" EndpointPortConfigPublishModeIngress string = "ingress" // EndpointPortConfigPublishModeHost captures enum value "host" EndpointPortConfigPublishModeHost string = "host" )
const ( // EndpointSpecModeVip captures enum value "vip" EndpointSpecModeVip string = "vip" // EndpointSpecModeDNSRR captures enum value "dnsrr" EndpointSpecModeDNSRR string = "dnsrr" )
const ( // HostConfigAO1LogConfigTypeJSONFile captures enum value "json-file" HostConfigAO1LogConfigTypeJSONFile string = "json-file" // HostConfigAO1LogConfigTypeSyslog captures enum value "syslog" HostConfigAO1LogConfigTypeSyslog string = "syslog" // HostConfigAO1LogConfigTypeJournald captures enum value "journald" HostConfigAO1LogConfigTypeJournald string = "journald" // HostConfigAO1LogConfigTypeGelf captures enum value "gelf" HostConfigAO1LogConfigTypeGelf string = "gelf" // HostConfigAO1LogConfigTypeFluentd captures enum value "fluentd" HostConfigAO1LogConfigTypeFluentd string = "fluentd" // HostConfigAO1LogConfigTypeAwslogs captures enum value "awslogs" HostConfigAO1LogConfigTypeAwslogs string = "awslogs" // HostConfigAO1LogConfigTypeSplunk captures enum value "splunk" HostConfigAO1LogConfigTypeSplunk string = "splunk" // HostConfigAO1LogConfigTypeEtwlogs captures enum value "etwlogs" HostConfigAO1LogConfigTypeEtwlogs string = "etwlogs" // HostConfigAO1LogConfigTypeNone captures enum value "none" HostConfigAO1LogConfigTypeNone string = "none" )
const ( // MountTypeBind captures enum value "bind" MountTypeBind string = "bind" // MountTypeVolume captures enum value "volume" MountTypeVolume string = "volume" // MountTypeTmpfs captures enum value "tmpfs" MountTypeTmpfs string = "tmpfs" // MountTypeNpipe captures enum value "npipe" MountTypeNpipe string = "npipe" )
const ( // MountBindOptionsPropagationPrivate captures enum value "private" MountBindOptionsPropagationPrivate string = "private" // MountBindOptionsPropagationRprivate captures enum value "rprivate" MountBindOptionsPropagationRprivate string = "rprivate" MountBindOptionsPropagationShared string = "shared" MountBindOptionsPropagationRshared string = "rshared" // MountBindOptionsPropagationSLAVE captures enum value "slave" MountBindOptionsPropagationSLAVE string = "slave" // MountBindOptionsPropagationRslave captures enum value "rslave" MountBindOptionsPropagationRslave string = "rslave" )
const ( // NodeSpecAvailabilityActive captures enum value "active" NodeSpecAvailabilityActive string = "active" // NodeSpecAvailabilityPause captures enum value "pause" NodeSpecAvailabilityPause string = "pause" // NodeSpecAvailabilityDrain captures enum value "drain" NodeSpecAvailabilityDrain string = "drain" )
const ( // NodeSpecRoleWorker captures enum value "worker" NodeSpecRoleWorker string = "worker" // NodeSpecRoleManager captures enum value "manager" NodeSpecRoleManager string = "manager" )
const ( // PluginConfigInterfaceProtocolScheme captures enum value "" PluginConfigInterfaceProtocolScheme string = "" // PluginConfigInterfaceProtocolSchemeMobyPluginsHTTPV1 captures enum value "moby.plugins.http/v1" PluginConfigInterfaceProtocolSchemeMobyPluginsHTTPV1 string = "moby.plugins.http/v1" )
const ( // PortTypeTCP captures enum value "tcp" PortTypeTCP string = "tcp" // PortTypeUDP captures enum value "udp" PortTypeUDP string = "udp" // PortTypeSctp captures enum value "sctp" PortTypeSctp string = "sctp" )
const ( // RestartPolicyName captures enum value "" RestartPolicyName string = "" // RestartPolicyNameAlways captures enum value "always" RestartPolicyNameAlways string = "always" // RestartPolicyNameUnlessStopped captures enum value "unless-stopped" RestartPolicyNameUnlessStopped string = "unless-stopped" // RestartPolicyNameOnFailure captures enum value "on-failure" RestartPolicyNameOnFailure string = "on-failure" )
const ( // ServiceUpdateStatusStateUpdating captures enum value "updating" ServiceUpdateStatusStateUpdating string = "updating" // ServiceUpdateStatusStatePaused captures enum value "paused" ServiceUpdateStatusStatePaused string = "paused" // ServiceUpdateStatusStateCompleted captures enum value "completed" ServiceUpdateStatusStateCompleted string = "completed" )
const ( // ServiceSpecRollbackConfigFailureActionContinue captures enum value "continue" ServiceSpecRollbackConfigFailureActionContinue string = "continue" // ServiceSpecRollbackConfigFailureActionPause captures enum value "pause" ServiceSpecRollbackConfigFailureActionPause string = "pause" )
const ( // ServiceSpecRollbackConfigOrderStopFirst captures enum value "stop-first" ServiceSpecRollbackConfigOrderStopFirst string = "stop-first" // ServiceSpecRollbackConfigOrderStartFirst captures enum value "start-first" ServiceSpecRollbackConfigOrderStartFirst string = "start-first" )
const ( // ServiceSpecUpdateConfigFailureActionContinue captures enum value "continue" ServiceSpecUpdateConfigFailureActionContinue string = "continue" // ServiceSpecUpdateConfigFailureActionPause captures enum value "pause" ServiceSpecUpdateConfigFailureActionPause string = "pause" // ServiceSpecUpdateConfigFailureActionRollback captures enum value "rollback" ServiceSpecUpdateConfigFailureActionRollback string = "rollback" )
const ( // ServiceSpecUpdateConfigOrderStopFirst captures enum value "stop-first" ServiceSpecUpdateConfigOrderStopFirst string = "stop-first" // ServiceSpecUpdateConfigOrderStartFirst captures enum value "start-first" ServiceSpecUpdateConfigOrderStartFirst string = "start-first" )
const ( // SystemInfoCgroupDriverCgroupfs captures enum value "cgroupfs" SystemInfoCgroupDriverCgroupfs string = "cgroupfs" // SystemInfoCgroupDriverSystemd captures enum value "systemd" SystemInfoCgroupDriverSystemd string = "systemd" )
const ( // SystemInfoIsolationDefault captures enum value "default" SystemInfoIsolationDefault string = "default" // SystemInfoIsolationHyperv captures enum value "hyperv" SystemInfoIsolationHyperv string = "hyperv" // SystemInfoIsolationProcess captures enum value "process" SystemInfoIsolationProcess string = "process" )
const ( // TaskSpecContainerSpecIsolationDefault captures enum value "default" TaskSpecContainerSpecIsolationDefault string = "default" // TaskSpecContainerSpecIsolationProcess captures enum value "process" TaskSpecContainerSpecIsolationProcess string = "process" // TaskSpecContainerSpecIsolationHyperv captures enum value "hyperv" TaskSpecContainerSpecIsolationHyperv string = "hyperv" )
const ( // TaskSpecRestartPolicyConditionNone captures enum value "none" TaskSpecRestartPolicyConditionNone string = "none" // TaskSpecRestartPolicyConditionOnFailure captures enum value "on-failure" TaskSpecRestartPolicyConditionOnFailure string = "on-failure" // TaskSpecRestartPolicyConditionAny captures enum value "any" TaskSpecRestartPolicyConditionAny string = "any" )
const ( // VolumeScopeLocal captures enum value "local" VolumeScopeLocal string = "local" // VolumeScopeGlobal captures enum value "global" VolumeScopeGlobal string = "global" )
const ( // SwarmSpecCAConfigExternalCAsItems0ProtocolCfssl captures enum value "cfssl" SwarmSpecCAConfigExternalCAsItems0ProtocolCfssl string = "cfssl" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Address ¶
type Address struct { // IP address. Addr string `json:"Addr,omitempty"` // Mask length of the IP address. PrefixLen int64 `json:"PrefixLen,omitempty"` }
Address Address represents an IPv4 or IPv6 IP address. swagger:model Address
func (*Address) MarshalBinary ¶
MarshalBinary interface implementation
func (*Address) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AuthConfig ¶
type AuthConfig struct { // email Email string `json:"email,omitempty"` // password Password string `json:"password,omitempty"` // serveraddress Serveraddress string `json:"serveraddress,omitempty"` // username Username string `json:"username,omitempty"` }
AuthConfig auth config swagger:model AuthConfig
func (*AuthConfig) MarshalBinary ¶
func (m *AuthConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthConfig) UnmarshalBinary ¶
func (m *AuthConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BuildCache ¶
type BuildCache struct { // created at CreatedAt int64 `json:"CreatedAt,omitempty"` // description Description string `json:"Description,omitempty"` // ID ID string `json:"ID,omitempty"` // in use InUse bool `json:"InUse,omitempty"` // last used at LastUsedAt *int64 `json:"LastUsedAt,omitempty"` // parent Parent string `json:"Parent,omitempty"` Shared bool `json:"Shared,omitempty"` // size Size int64 `json:"Size,omitempty"` // type Type string `json:"Type,omitempty"` // usage count UsageCount int64 `json:"UsageCount,omitempty"` }
BuildCache build cache swagger:model BuildCache
func (*BuildCache) MarshalBinary ¶
func (m *BuildCache) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BuildCache) UnmarshalBinary ¶
func (m *BuildCache) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BuildInfo ¶
type BuildInfo struct { // aux Aux *ImageID `json:"aux,omitempty"` // error Error string `json:"error,omitempty"` // error detail ErrorDetail *ErrorDetail `json:"errorDetail,omitempty"` // id ID string `json:"id,omitempty"` // progress Progress string `json:"progress,omitempty"` // progress detail ProgressDetail *ProgressDetail `json:"progressDetail,omitempty"` // status Status string `json:"status,omitempty"` // stream Stream string `json:"stream,omitempty"` }
BuildInfo build info swagger:model BuildInfo
func (*BuildInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*BuildInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ClusterInfo ¶
type ClusterInfo struct { // Date and time at which the swarm was initialised in // [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. // CreatedAt string `json:"CreatedAt,omitempty"` // DataPathPort specifies the data path port number for data traffic. // Acceptable port range is 1024 to 49151. // If no port is set or is set to 0, the default port (4789) is used. // DataPathPort *uint32 `json:"DataPathPort,omitempty"` // Default Address Pool specifies default subnet pools for global scope networks. // DefaultAddrPool []string `json:"DefaultAddrPool"` // The ID of the swarm. ID string `json:"ID,omitempty"` // Whether there is currently a root CA rotation in progress for the swarm RootRotationInProgress bool `json:"RootRotationInProgress,omitempty"` // spec Spec *SwarmSpec `json:"Spec,omitempty"` // SubnetSize specifies the subnet size of the networks created from the default subnet pool // // Maximum: 29 SubnetSize uint32 `json:"SubnetSize,omitempty"` // TLS info TLSInfo *TLSInfo `json:"TLSInfo,omitempty"` // Date and time at which the swarm was last updated in // [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. // UpdatedAt string `json:"UpdatedAt,omitempty"` // version Version *ObjectVersion `json:"Version,omitempty"` }
ClusterInfo ClusterInfo represents information about the swarm as is returned by the "/info" endpoint. Join-tokens are not included.
swagger:model ClusterInfo
func (*ClusterInfo) MarshalBinary ¶
func (m *ClusterInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterInfo) UnmarshalBinary ¶
func (m *ClusterInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Commit ¶
type Commit struct { // Commit ID of external tool expected by dockerd as set at build time. // Expected string `json:"Expected,omitempty"` // Actual commit ID of external tool. ID string `json:"ID,omitempty"` }
Commit Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as `containerd`, or `runC`.
swagger:model Commit
func (*Commit) MarshalBinary ¶
MarshalBinary interface implementation
func (*Commit) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Config ¶
type Config struct { // created at CreatedAt string `json:"CreatedAt,omitempty"` // ID ID string `json:"ID,omitempty"` // spec Spec *ConfigSpec `json:"Spec,omitempty"` // updated at UpdatedAt string `json:"UpdatedAt,omitempty"` // version Version *ObjectVersion `json:"Version,omitempty"` }
Config config swagger:model Config
func (*Config) MarshalBinary ¶
MarshalBinary interface implementation
func (*Config) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ConfigSpec ¶
type ConfigSpec struct { // Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-3.2)) // config data. // Data string `json:"Data,omitempty"` // User-defined key/value metadata. Labels map[string]string `json:"Labels,omitempty"` // User-defined name of the config. Name string `json:"Name,omitempty"` // Templating driver, if applicable // // Templating controls whether and how to evaluate the config payload as // a template. If no driver is set, no templating is used. // Templating *Driver `json:"Templating,omitempty"` }
ConfigSpec config spec swagger:model ConfigSpec
func (*ConfigSpec) MarshalBinary ¶
func (m *ConfigSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConfigSpec) UnmarshalBinary ¶
func (m *ConfigSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerConfig ¶
type ContainerConfig struct { // Command is already escaped (Windows only) ArgsEscaped bool `json:"ArgsEscaped,omitempty"` // Whether to attach to `stderr`. AttachStderr *bool `json:"AttachStderr,omitempty"` // Whether to attach to `stdin`. AttachStdin *bool `json:"AttachStdin,omitempty"` // Whether to attach to `stdout`. AttachStdout *bool `json:"AttachStdout,omitempty"` // Command to run specified as a string or an array of strings. Cmd []string `json:"Cmd"` // The domain name to use for the container. Domainname string `json:"Domainname,omitempty"` // The entry point for the container as a string or an array of strings. // // If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). // Entrypoint []string `json:"Entrypoint"` // A list of environment variables to set inside the container in the form `["VAR=value", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. // Env []string `json:"Env"` // An object mapping ports to an empty object in the form: // // `{"<port>/<tcp|udp|sctp>": {}}` // ExposedPorts map[string]interface{} `json:"ExposedPorts,omitempty"` // healthcheck Healthcheck *HealthConfig `json:"Healthcheck,omitempty"` // The hostname to use for the container, as a valid RFC 1123 hostname. Hostname string `json:"Hostname,omitempty"` // The name of the image to use when creating the container Image string `json:"Image,omitempty"` // User-defined key/value metadata. Labels map[string]string `json:"Labels,omitempty"` // MAC address of the container. MacAddress string `json:"MacAddress,omitempty"` // Disable networking for the container. NetworkDisabled bool `json:"NetworkDisabled,omitempty"` // `ONBUILD` metadata that were defined in the image's `Dockerfile`. OnBuild []string `json:"OnBuild"` // Open `stdin` OpenStdin *bool `json:"OpenStdin,omitempty"` // Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. Shell []string `json:"Shell"` // Close `stdin` after one attached client disconnects StdinOnce *bool `json:"StdinOnce,omitempty"` // Signal to stop a container as a string or unsigned integer. StopSignal *string `json:"StopSignal,omitempty"` // Timeout to stop a container in seconds. StopTimeout *int64 `json:"StopTimeout,omitempty"` // Attach standard streams to a TTY, including `stdin` if it is not closed. Tty *bool `json:"Tty,omitempty"` // The user that commands are run as inside the container. User string `json:"User,omitempty"` // An object mapping mount point paths inside the container to empty objects. Volumes map[string]interface{} `json:"Volumes,omitempty"` // The working directory for commands to run in. WorkingDir string `json:"WorkingDir,omitempty"` }
ContainerConfig Configuration for a container that is portable between hosts swagger:model ContainerConfig
func (*ContainerConfig) MarshalBinary ¶
func (m *ContainerConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerConfig) UnmarshalBinary ¶
func (m *ContainerConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerSummary ¶
type ContainerSummary []*ContainerSummaryItems0
ContainerSummary container summary swagger:model ContainerSummary
type ContainerSummaryItems0 ¶
type ContainerSummaryItems0 struct { // Command to run when starting the container Command string `json:"Command,omitempty"` // When the container was created Created int64 `json:"Created,omitempty"` // host config HostConfig *ContainerSummaryItems0HostConfig `json:"HostConfig,omitempty"` // The ID of this container ID string `json:"Id,omitempty"` // The name of the image used when creating this container Image string `json:"Image,omitempty"` // The ID of the image that this container was created from ImageID string `json:"ImageID,omitempty"` // User-defined key/value metadata. Labels map[string]string `json:"Labels,omitempty"` // mounts Mounts []*Mount `json:"Mounts"` // The names that this container has been given Names []string `json:"Names"` // network settings NetworkSettings *ContainerSummaryItems0NetworkSettings `json:"NetworkSettings,omitempty"` // The ports exposed by this container Ports []*Port `json:"Ports"` // The total size of all the files in this container SizeRootFs int64 `json:"SizeRootFs,omitempty"` // The size of files that have been created or changed by this container SizeRw int64 `json:"SizeRw,omitempty"` // The state of this container (e.g. `Exited`) State string `json:"State,omitempty"` // Additional human-readable status of this container (e.g. `Exit 0`) Status string `json:"Status,omitempty"` }
ContainerSummaryItems0 container summary items0 swagger:model ContainerSummaryItems0
func (*ContainerSummaryItems0) MarshalBinary ¶
func (m *ContainerSummaryItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerSummaryItems0) UnmarshalBinary ¶
func (m *ContainerSummaryItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerSummaryItems0HostConfig ¶
type ContainerSummaryItems0HostConfig struct { // network mode NetworkMode string `json:"NetworkMode,omitempty"` }
ContainerSummaryItems0HostConfig container summary items0 host config swagger:model ContainerSummaryItems0HostConfig
func (*ContainerSummaryItems0HostConfig) MarshalBinary ¶
func (m *ContainerSummaryItems0HostConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerSummaryItems0HostConfig) UnmarshalBinary ¶
func (m *ContainerSummaryItems0HostConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerSummaryItems0NetworkSettings ¶
type ContainerSummaryItems0NetworkSettings struct { // networks Networks map[string]EndpointSettings `json:"Networks,omitempty"` }
ContainerSummaryItems0NetworkSettings A summary of the container's network settings swagger:model ContainerSummaryItems0NetworkSettings
func (*ContainerSummaryItems0NetworkSettings) MarshalBinary ¶
func (m *ContainerSummaryItems0NetworkSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerSummaryItems0NetworkSettings) UnmarshalBinary ¶
func (m *ContainerSummaryItems0NetworkSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateImageInfo ¶
type CreateImageInfo struct { // error Error string `json:"error,omitempty"` // id ID string `json:"id,omitempty"` // progress Progress string `json:"progress,omitempty"` // progress detail ProgressDetail *ProgressDetail `json:"progressDetail,omitempty"` // status Status string `json:"status,omitempty"` }
CreateImageInfo create image info swagger:model CreateImageInfo
func (*CreateImageInfo) MarshalBinary ¶
func (m *CreateImageInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateImageInfo) UnmarshalBinary ¶
func (m *CreateImageInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceMapping ¶
type DeviceMapping struct { // cgroup permissions CgroupPermissions string `json:"CgroupPermissions,omitempty"` // path in container PathInContainer string `json:"PathInContainer,omitempty"` // path on host PathOnHost string `json:"PathOnHost,omitempty"` }
DeviceMapping A device mapping between the host and container swagger:model DeviceMapping
func (*DeviceMapping) MarshalBinary ¶
func (m *DeviceMapping) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceMapping) UnmarshalBinary ¶
func (m *DeviceMapping) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceRequest ¶
type DeviceRequest struct { // A list of capabilities; an OR list of AND lists of capabilities. // Capabilities [][]string `json:"Capabilities"` // count Count int64 `json:"Count,omitempty"` // device ids DeviceIds []string `json:"DeviceIDs"` // driver Driver string `json:"Driver,omitempty"` // Driver-specific options, specified as a key/value pairs. These options // are passed directly to the driver. // Options map[string]string `json:"Options,omitempty"` }
DeviceRequest A request for devices to be sent to device drivers swagger:model DeviceRequest
func (*DeviceRequest) MarshalBinary ¶
func (m *DeviceRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceRequest) UnmarshalBinary ¶
func (m *DeviceRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Driver ¶
type Driver struct { // Name of the driver. // Required: true Name string `json:"Name"` // Key/value map of driver-specific options. Options map[string]string `json:"Options,omitempty"` }
Driver Driver represents a driver (network, logging, secrets). swagger:model Driver
func (*Driver) MarshalBinary ¶
MarshalBinary interface implementation
func (*Driver) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type EndpointIPAMConfig ¶
type EndpointIPAMConfig struct { // ipv4 address IPV4Address string `json:"IPv4Address,omitempty"` // ipv6 address IPV6Address string `json:"IPv6Address,omitempty"` // link local ips LinkLocalIps []string `json:"LinkLocalIPs"` }
EndpointIPAMConfig EndpointIPAMConfig represents an endpoint's IPAM configuration.
swagger:model EndpointIPAMConfig
func (*EndpointIPAMConfig) MarshalBinary ¶
func (m *EndpointIPAMConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointIPAMConfig) UnmarshalBinary ¶
func (m *EndpointIPAMConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EndpointPortConfig ¶
type EndpointPortConfig struct { // name Name string `json:"Name,omitempty"` // protocol // Enum: [tcp udp sctp] Protocol string `json:"Protocol,omitempty"` // The mode in which port is published. // // <p><br /></p> // // - "ingress" makes the target port accessible on on every node, // regardless of whether there is a task for the service running on // that node or not. // - "host" bypasses the routing mesh and publish the port directly on // the swarm node where that service is running. // // Enum: [ingress host] PublishMode *string `json:"PublishMode,omitempty"` // The port on the swarm hosts. PublishedPort int64 `json:"PublishedPort,omitempty"` // The port inside the container. TargetPort int64 `json:"TargetPort,omitempty"` }
EndpointPortConfig endpoint port config swagger:model EndpointPortConfig
func (*EndpointPortConfig) MarshalBinary ¶
func (m *EndpointPortConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointPortConfig) UnmarshalBinary ¶
func (m *EndpointPortConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EndpointSettings ¶
type EndpointSettings struct { // aliases Aliases []string `json:"Aliases"` // DriverOpts is a mapping of driver options and values. These options // are passed directly to the driver and are driver specific. // DriverOpts map[string]string `json:"DriverOpts,omitempty"` // Unique ID for the service endpoint in a Sandbox. // EndpointID string `json:"EndpointID,omitempty"` // Gateway address for this network. // Gateway string `json:"Gateway,omitempty"` // Global IPv6 address. // GlobalIPV6Address string `json:"GlobalIPv6Address,omitempty"` // Mask length of the global IPv6 address. // GlobalIPV6PrefixLen int64 `json:"GlobalIPv6PrefixLen,omitempty"` // IP a m config IPAMConfig *EndpointIPAMConfig `json:"IPAMConfig,omitempty"` // IPv4 address. // IPAddress string `json:"IPAddress,omitempty"` // Mask length of the IPv4 address. // IPPrefixLen int64 `json:"IPPrefixLen,omitempty"` // IPv6 gateway address. // IPV6Gateway string `json:"IPv6Gateway,omitempty"` // links Links []string `json:"Links"` // MAC address for the endpoint on this network. // MacAddress string `json:"MacAddress,omitempty"` // Unique ID of the network. // NetworkID string `json:"NetworkID,omitempty"` }
EndpointSettings Configuration for a network endpoint. swagger:model EndpointSettings
func (*EndpointSettings) MarshalBinary ¶
func (m *EndpointSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointSettings) UnmarshalBinary ¶
func (m *EndpointSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EndpointSpec ¶
type EndpointSpec struct { // The mode of resolution to use for internal load balancing between tasks. // Enum: [vip dnsrr] Mode *string `json:"Mode,omitempty"` // List of exposed ports that this service is accessible on from the outside. Ports can only be provided if `vip` resolution mode is used. Ports []*EndpointPortConfig `json:"Ports"` }
EndpointSpec Properties that can be configured to access and load balance a service. swagger:model EndpointSpec
func (*EndpointSpec) MarshalBinary ¶
func (m *EndpointSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointSpec) UnmarshalBinary ¶
func (m *EndpointSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EngineDescription ¶
type EngineDescription struct { // engine version EngineVersion string `json:"EngineVersion,omitempty"` // labels Labels map[string]string `json:"Labels,omitempty"` // plugins Plugins []*EngineDescriptionPluginsItems0 `json:"Plugins"` }
EngineDescription EngineDescription provides information about an engine. swagger:model EngineDescription
func (*EngineDescription) MarshalBinary ¶
func (m *EngineDescription) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EngineDescription) UnmarshalBinary ¶
func (m *EngineDescription) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EngineDescriptionPluginsItems0 ¶
type EngineDescriptionPluginsItems0 struct { // name Name string `json:"Name,omitempty"` // type Type string `json:"Type,omitempty"` }
EngineDescriptionPluginsItems0 engine description plugins items0 swagger:model EngineDescriptionPluginsItems0
func (*EngineDescriptionPluginsItems0) MarshalBinary ¶
func (m *EngineDescriptionPluginsItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EngineDescriptionPluginsItems0) UnmarshalBinary ¶
func (m *EngineDescriptionPluginsItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ErrorDetail ¶
type ErrorDetail struct { // code Code int64 `json:"code,omitempty"` // message Message string `json:"message,omitempty"` }
ErrorDetail error detail swagger:model ErrorDetail
func (*ErrorDetail) MarshalBinary ¶
func (m *ErrorDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ErrorDetail) UnmarshalBinary ¶
func (m *ErrorDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ErrorResponse ¶
type ErrorResponse struct { // The error message. // Required: true Message string `json:"message"` }
ErrorResponse Represents an error. swagger:model ErrorResponse
func (*ErrorResponse) MarshalBinary ¶
func (m *ErrorResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ErrorResponse) UnmarshalBinary ¶
func (m *ErrorResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GenericResources ¶
type GenericResources []*GenericResourcesItems0
GenericResources User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`) swagger:model GenericResources
type GenericResourcesItems0 ¶
type GenericResourcesItems0 struct { // discrete resource spec DiscreteResourceSpec *GenericResourcesItems0DiscreteResourceSpec `json:"DiscreteResourceSpec,omitempty"` // named resource spec NamedResourceSpec *GenericResourcesItems0NamedResourceSpec `json:"NamedResourceSpec,omitempty"` }
GenericResourcesItems0 generic resources items0 swagger:model GenericResourcesItems0
func (*GenericResourcesItems0) MarshalBinary ¶
func (m *GenericResourcesItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GenericResourcesItems0) UnmarshalBinary ¶
func (m *GenericResourcesItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GenericResourcesItems0DiscreteResourceSpec ¶
type GenericResourcesItems0DiscreteResourceSpec struct { // kind Kind string `json:"Kind,omitempty"` // value Value int64 `json:"Value,omitempty"` }
GenericResourcesItems0DiscreteResourceSpec generic resources items0 discrete resource spec swagger:model GenericResourcesItems0DiscreteResourceSpec
func (*GenericResourcesItems0DiscreteResourceSpec) MarshalBinary ¶
func (m *GenericResourcesItems0DiscreteResourceSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GenericResourcesItems0DiscreteResourceSpec) UnmarshalBinary ¶
func (m *GenericResourcesItems0DiscreteResourceSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GenericResourcesItems0NamedResourceSpec ¶
type GenericResourcesItems0NamedResourceSpec struct { // kind Kind string `json:"Kind,omitempty"` // value Value string `json:"Value,omitempty"` }
GenericResourcesItems0NamedResourceSpec generic resources items0 named resource spec swagger:model GenericResourcesItems0NamedResourceSpec
func (*GenericResourcesItems0NamedResourceSpec) MarshalBinary ¶
func (m *GenericResourcesItems0NamedResourceSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GenericResourcesItems0NamedResourceSpec) UnmarshalBinary ¶
func (m *GenericResourcesItems0NamedResourceSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GraphDriverData ¶
type GraphDriverData struct { // data // Required: true Data map[string]string `json:"Data"` // name // Required: true Name string `json:"Name"` }
GraphDriverData Information about a container's graph driver. swagger:model GraphDriverData
func (*GraphDriverData) MarshalBinary ¶
func (m *GraphDriverData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GraphDriverData) UnmarshalBinary ¶
func (m *GraphDriverData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HealthConfig ¶
type HealthConfig struct { // The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. Interval int64 `json:"Interval,omitempty"` // The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit. Retries int64 `json:"Retries,omitempty"` // Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. StartPeriod int64 `json:"StartPeriod,omitempty"` // The test to perform. Possible values are: // // - `[]` inherit healthcheck from image or parent image // - `["NONE"]` disable healthcheck // - `["CMD", args...]` exec arguments directly // - `["CMD-SHELL", command]` run command with system's default shell // Test []string `json:"Test"` // The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit. Timeout int64 `json:"Timeout,omitempty"` }
HealthConfig A test to perform to check that the container is healthy. swagger:model HealthConfig
func (*HealthConfig) MarshalBinary ¶
func (m *HealthConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HealthConfig) UnmarshalBinary ¶
func (m *HealthConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HostConfig ¶
type HostConfig struct { Resources // Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set. AutoRemove bool `json:"AutoRemove,omitempty"` // A list of volume bindings for this container. Each volume binding is a string in one of these forms: // // - `host-src:container-dest` to bind-mount a host path into the container. Both `host-src`, and `container-dest` must be an _absolute_ path. // - `host-src:container-dest:ro` to make the bind mount read-only inside the container. Both `host-src`, and `container-dest` must be an _absolute_ path. // - `volume-name:container-dest` to bind-mount a volume managed by a volume driver into the container. `container-dest` must be an _absolute_ path. // - `volume-name:container-dest:ro` to mount the volume read-only inside the container. `container-dest` must be an _absolute_ path. // Binds []string `json:"Binds"` // A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities' CapAdd []string `json:"CapAdd"` // A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities' CapDrop []string `json:"CapDrop"` // A list of kernel capabilities to be available for container (this overrides the default set). // // Conflicts with options 'CapAdd' and 'CapDrop'" // Capabilities []string `json:"Capabilities"` // Cgroup to use for the container. Cgroup string `json:"Cgroup,omitempty"` // Initial console size, as an `[height, width]` array. (Windows only) // Max Items: 2 // Min Items: 2 ConsoleSize []*int64 `json:"ConsoleSize"` // Path to a file where the container ID is written ContainerIDFile string `json:"ContainerIDFile,omitempty"` // A list of DNS servers for the container to use. DNS []string `json:"Dns"` // A list of DNS options. DNSOptions []string `json:"DnsOptions"` // A list of DNS search domains. DNSSearch []string `json:"DnsSearch"` // A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `["hostname:IP"]`. // ExtraHosts []string `json:"ExtraHosts"` // A list of additional groups that the container process will run as. GroupAdd []string `json:"GroupAdd"` // IPC sharing mode for the container. Possible values are: // // - `"none"`: own private IPC namespace, with /dev/shm not mounted // - `"private"`: own private IPC namespace // - `"shareable"`: own private IPC namespace, with a possibility to share it with other containers // - `"container:<name|id>"`: join another (shareable) container's IPC namespace // - `"host"`: use the host system's IPC namespace // // If not specified, daemon default is used, which can either be `"private"` // or `"shareable"`, depending on daemon version and configuration. // IpcMode string `json:"IpcMode,omitempty"` // Isolation technology of the container. (Windows only) // Enum: [default process hyperv] Isolation string `json:"Isolation,omitempty"` // A list of links for the container in the form `container_name:alias`. Links []string `json:"Links"` // log config LogConfig *HostConfigAO1LogConfig `json:"LogConfig,omitempty"` // The list of paths to be masked inside the container (this overrides the default set of paths) MaskedPaths []string `json:"MaskedPaths"` // Specification for mounts to be added to the container. Mounts []*Mount `json:"Mounts"` // Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value is taken as a custom network's name to which this container should connect to. NetworkMode string `json:"NetworkMode,omitempty"` // An integer value containing the score given to the container in order to tune OOM killer preferences. OomScoreAdj int64 `json:"OomScoreAdj,omitempty"` // Set the PID (Process) Namespace mode for the container. It can be either: // // - `"container:<name|id>"`: joins another container's PID namespace // - `"host"`: use the host's PID namespace inside the container // PidMode string `json:"PidMode,omitempty"` // port bindings PortBindings PortMap `json:"PortBindings,omitempty"` // Gives the container full access to the host. Privileged bool `json:"Privileged,omitempty"` // Allocates an ephemeral host port for all of a container's // exposed ports. // // Ports are de-allocated when the container stops and allocated when the container starts. // The allocated port might be changed when restarting the container. // // The port is selected from the ephemeral port range that depends on the kernel. // For example, on Linux the range is defined by `/proc/sys/net/ipv4/ip_local_port_range`. // PublishAllPorts bool `json:"PublishAllPorts,omitempty"` // The list of paths to be set as read-only inside the container (this overrides the default set of paths) ReadonlyPaths []string `json:"ReadonlyPaths"` // Mount the container's root filesystem as read only. ReadonlyRootfs bool `json:"ReadonlyRootfs,omitempty"` // restart policy RestartPolicy *RestartPolicy `json:"RestartPolicy,omitempty"` // Runtime to use with this container. Runtime string `json:"Runtime,omitempty"` // A list of string values to customize labels for MLS systems, such as SELinux. SecurityOpt []string `json:"SecurityOpt"` // Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. // Minimum: 0 ShmSize *int64 `json:"ShmSize,omitempty"` // Storage driver options for this container, in the form `{"size": "120G"}`. // StorageOpt map[string]string `json:"StorageOpt,omitempty"` // A list of kernel parameters (sysctls) to set in the container. For example: `{"net.ipv4.ip_forward": "1"}` // Sysctls map[string]string `json:"Sysctls,omitempty"` // A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: `{ "/run": "rw,noexec,nosuid,size=65536k" }`. // Tmpfs map[string]string `json:"Tmpfs,omitempty"` // UTS namespace to use for the container. UTSMode string `json:"UTSMode,omitempty"` // Sets the usernamespace mode for the container when usernamespace remapping option is enabled. UsernsMode string `json:"UsernsMode,omitempty"` // Driver that this container uses to mount volumes. VolumeDriver string `json:"VolumeDriver,omitempty"` // A list of volumes to inherit from another container, specified in the form `<container name>[:<ro|rw>]`. VolumesFrom []string `json:"VolumesFrom"` }
HostConfig Container configuration that depends on the host we are running on swagger:model HostConfig
func (*HostConfig) MarshalBinary ¶
func (m *HostConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (HostConfig) MarshalJSON ¶
func (m HostConfig) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*HostConfig) UnmarshalBinary ¶
func (m *HostConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*HostConfig) UnmarshalJSON ¶
func (m *HostConfig) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type HostConfigAO1LogConfig ¶
type HostConfigAO1LogConfig struct { // config Config map[string]string `json:"Config,omitempty"` // type // Enum: [json-file syslog journald gelf fluentd awslogs splunk etwlogs none] Type string `json:"Type,omitempty"` }
HostConfigAO1LogConfig The logging configuration for this container swagger:model HostConfigAO1LogConfig
func (*HostConfigAO1LogConfig) MarshalBinary ¶
func (m *HostConfigAO1LogConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HostConfigAO1LogConfig) UnmarshalBinary ¶
func (m *HostConfigAO1LogConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IDResponse ¶
type IDResponse struct { // The id of the newly created object. // Required: true ID string `json:"Id"` }
IDResponse Response to an API call that returns just an Id swagger:model IdResponse
func (*IDResponse) MarshalBinary ¶
func (m *IDResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IDResponse) UnmarshalBinary ¶
func (m *IDResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IPAM ¶
type IPAM struct { // List of IPAM configuration options, specified as a map: `{"Subnet": <CIDR>, "IPRange": <CIDR>, "Gateway": <IP address>, "AuxAddress": <device_name:IP address>}` Config []map[string]string `json:"Config"` // Name of the IPAM driver to use. Driver *string `json:"Driver,omitempty"` // Driver-specific options, specified as a map. Options map[string]string `json:"Options,omitempty"` }
IPAM IP a m swagger:model IPAM
func (*IPAM) MarshalBinary ¶
MarshalBinary interface implementation
func (*IPAM) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Image ¶
type Image struct { // architecture // Required: true Architecture string `json:"Architecture"` // author // Required: true Author string `json:"Author"` // comment // Required: true Comment string `json:"Comment"` // config Config *ContainerConfig `json:"Config,omitempty"` // container // Required: true Container string `json:"Container"` // container config ContainerConfig *ContainerConfig `json:"ContainerConfig,omitempty"` // created // Required: true Created string `json:"Created"` // docker version // Required: true DockerVersion string `json:"DockerVersion"` // graph driver // Required: true GraphDriver *GraphDriverData `json:"GraphDriver"` // Id // Required: true ID string `json:"Id"` // metadata Metadata *ImageMetadata `json:"Metadata,omitempty"` // os // Required: true Os string `json:"Os"` // os version OsVersion string `json:"OsVersion,omitempty"` // parent // Required: true Parent string `json:"Parent"` // repo digests RepoDigests []string `json:"RepoDigests"` // repo tags RepoTags []string `json:"RepoTags"` // root f s // Required: true RootFS *ImageRootFS `json:"RootFS"` // size // Required: true Size int64 `json:"Size"` // virtual size // Required: true VirtualSize int64 `json:"VirtualSize"` }
Image image swagger:model Image
func (*Image) MarshalBinary ¶
MarshalBinary interface implementation
func (*Image) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ImageDeleteResponseItem ¶
type ImageDeleteResponseItem struct { // The image ID of an image that was deleted Deleted string `json:"Deleted,omitempty"` // The image ID of an image that was untagged Untagged string `json:"Untagged,omitempty"` }
ImageDeleteResponseItem image delete response item swagger:model ImageDeleteResponseItem
func (*ImageDeleteResponseItem) MarshalBinary ¶
func (m *ImageDeleteResponseItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageDeleteResponseItem) UnmarshalBinary ¶
func (m *ImageDeleteResponseItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ImageID ¶
type ImageID struct { // ID ID string `json:"ID,omitempty"` }
ImageID Image ID or Digest swagger:model ImageID
func (*ImageID) MarshalBinary ¶
MarshalBinary interface implementation
func (*ImageID) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ImageMetadata ¶
type ImageMetadata struct { // last tag time LastTagTime string `json:"LastTagTime,omitempty"` }
ImageMetadata image metadata swagger:model ImageMetadata
func (*ImageMetadata) MarshalBinary ¶
func (m *ImageMetadata) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageMetadata) UnmarshalBinary ¶
func (m *ImageMetadata) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ImageRootFS ¶
type ImageRootFS struct { // base layer BaseLayer string `json:"BaseLayer,omitempty"` // layers Layers []string `json:"Layers"` // type // Required: true Type string `json:"Type"` }
ImageRootFS image root f s swagger:model ImageRootFS
func (*ImageRootFS) MarshalBinary ¶
func (m *ImageRootFS) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageRootFS) UnmarshalBinary ¶
func (m *ImageRootFS) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ImageSummary ¶
type ImageSummary struct { // containers // Required: true Containers int64 `json:"Containers"` // created // Required: true Created int64 `json:"Created"` // Id // Required: true ID string `json:"Id"` // labels // Required: true Labels map[string]string `json:"Labels"` // parent Id // Required: true ParentID string `json:"ParentId"` // repo digests // Required: true RepoDigests []string `json:"RepoDigests"` // repo tags // Required: true RepoTags []string `json:"RepoTags"` // Required: true SharedSize int64 `json:"SharedSize"` // size // Required: true Size int64 `json:"Size"` // virtual size // Required: true VirtualSize int64 `json:"VirtualSize"` }
ImageSummary image summary swagger:model ImageSummary
func (*ImageSummary) MarshalBinary ¶
func (m *ImageSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageSummary) UnmarshalBinary ¶
func (m *ImageSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IndexInfo ¶
type IndexInfo struct { // List of mirrors, expressed as URIs. // Mirrors []string `json:"Mirrors"` // Name of the registry, such as "docker.io". // Name string `json:"Name,omitempty"` // Indicates whether this is an official registry (i.e., Docker Hub / docker.io) // Official bool `json:"Official,omitempty"` // Indicates if the registry is part of the list of insecure // registries. // // If `false`, the registry is insecure. Insecure registries accept // un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from // unknown CAs) communication. // // > **Warning**: Insecure registries can be useful when running a local // > registry. However, because its use creates security vulnerabilities // > it should ONLY be enabled for testing purposes. For increased // > security, users should add their CA to their system's list of // > trusted CAs instead of enabling this option. // Secure bool `json:"Secure,omitempty"` }
IndexInfo IndexInfo contains information about a registry. swagger:model IndexInfo
func (*IndexInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*IndexInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type JoinTokens ¶
type JoinTokens struct { // The token managers can use to join the swarm. // Manager string `json:"Manager,omitempty"` // The token workers can use to join the swarm. // Worker string `json:"Worker,omitempty"` }
JoinTokens JoinTokens contains the tokens workers and managers need to join the swarm.
swagger:model JoinTokens
func (*JoinTokens) MarshalBinary ¶
func (m *JoinTokens) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*JoinTokens) UnmarshalBinary ¶
func (m *JoinTokens) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LocalNodeState ¶
type LocalNodeState string
LocalNodeState Current local status of this node. swagger:model LocalNodeState
const ( // LocalNodeState captures enum value "" LocalNodeStateEmpty LocalNodeState = "" // LocalNodeStateInactive captures enum value "inactive" LocalNodeStateInactive LocalNodeState = "inactive" // LocalNodeStatePending captures enum value "pending" LocalNodeStatePending LocalNodeState = "pending" // LocalNodeStateActive captures enum value "active" LocalNodeStateActive LocalNodeState = "active" // LocalNodeStateError captures enum value "error" LocalNodeStateError LocalNodeState = "error" // LocalNodeStateLocked captures enum value "locked" LocalNodeStateLocked LocalNodeState = "locked" )
type ManagerStatus ¶
type ManagerStatus struct { // The IP address and port at which the manager is reachable. // Addr string `json:"Addr,omitempty"` // leader Leader *bool `json:"Leader,omitempty"` // reachability Reachability Reachability `json:"Reachability,omitempty"` }
ManagerStatus ManagerStatus represents the status of a manager.
It provides the current status of a node's manager component, if the node is a manager.
swagger:model ManagerStatus
func (*ManagerStatus) MarshalBinary ¶
func (m *ManagerStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ManagerStatus) UnmarshalBinary ¶
func (m *ManagerStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Mount ¶
type Mount struct { // bind options BindOptions *MountBindOptions `json:"BindOptions,omitempty"` // The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`. Consistency string `json:"Consistency,omitempty"` // Whether the mount should be read-only. ReadOnly bool `json:"ReadOnly,omitempty"` // Mount source (e.g. a volume name, a host path). Source string `json:"Source,omitempty"` // Container path. Target string `json:"Target,omitempty"` // tmpfs options TmpfsOptions *MountTmpfsOptions `json:"TmpfsOptions,omitempty"` // The mount type. Available types: // // - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. // - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. // - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. // - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container. // // Enum: [bind volume tmpfs npipe] Type string `json:"Type,omitempty"` // volume options VolumeOptions *MountVolumeOptions `json:"VolumeOptions,omitempty"` }
Mount mount swagger:model Mount
func (*Mount) MarshalBinary ¶
MarshalBinary interface implementation
func (*Mount) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MountBindOptions ¶
type MountBindOptions struct { // Disable recursive bind mount. NonRecursive *bool `json:"NonRecursive,omitempty"` // A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`. // Enum: [private rprivate shared rshared slave rslave] Propagation string `json:"Propagation,omitempty"` }
MountBindOptions Optional configuration for the `bind` type. swagger:model MountBindOptions
func (*MountBindOptions) MarshalBinary ¶
func (m *MountBindOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MountBindOptions) UnmarshalBinary ¶
func (m *MountBindOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MountPoint ¶
type MountPoint struct { // destination Destination string `json:"Destination,omitempty"` // driver Driver string `json:"Driver,omitempty"` // mode Mode string `json:"Mode,omitempty"` // name Name string `json:"Name,omitempty"` // propagation Propagation string `json:"Propagation,omitempty"` // r w RW bool `json:"RW,omitempty"` // source Source string `json:"Source,omitempty"` // type Type string `json:"Type,omitempty"` }
MountPoint A mount point inside a container swagger:model MountPoint
func (*MountPoint) MarshalBinary ¶
func (m *MountPoint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MountPoint) UnmarshalBinary ¶
func (m *MountPoint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MountTmpfsOptions ¶
type MountTmpfsOptions struct { // The permission mode for the tmpfs mount in an integer. Mode int64 `json:"Mode,omitempty"` // The size for the tmpfs mount in bytes. SizeBytes int64 `json:"SizeBytes,omitempty"` }
MountTmpfsOptions Optional configuration for the `tmpfs` type. swagger:model MountTmpfsOptions
func (*MountTmpfsOptions) MarshalBinary ¶
func (m *MountTmpfsOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MountTmpfsOptions) UnmarshalBinary ¶
func (m *MountTmpfsOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MountVolumeOptions ¶
type MountVolumeOptions struct { // driver config DriverConfig *MountVolumeOptionsDriverConfig `json:"DriverConfig,omitempty"` // User-defined key/value metadata. Labels map[string]string `json:"Labels,omitempty"` // Populate volume with data from the target. NoCopy *bool `json:"NoCopy,omitempty"` }
MountVolumeOptions Optional configuration for the `volume` type. swagger:model MountVolumeOptions
func (*MountVolumeOptions) MarshalBinary ¶
func (m *MountVolumeOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MountVolumeOptions) UnmarshalBinary ¶
func (m *MountVolumeOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MountVolumeOptionsDriverConfig ¶
type MountVolumeOptionsDriverConfig struct { // Name of the driver to use to create the volume. Name string `json:"Name,omitempty"` // key/value map of driver specific options. Options map[string]string `json:"Options,omitempty"` }
MountVolumeOptionsDriverConfig Map of driver specific options swagger:model MountVolumeOptionsDriverConfig
func (*MountVolumeOptionsDriverConfig) MarshalBinary ¶
func (m *MountVolumeOptionsDriverConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MountVolumeOptionsDriverConfig) UnmarshalBinary ¶
func (m *MountVolumeOptionsDriverConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Network ¶
type Network struct { // attachable Attachable bool `json:"Attachable,omitempty"` // containers Containers map[string]NetworkContainer `json:"Containers,omitempty"` // created Created string `json:"Created,omitempty"` // driver Driver string `json:"Driver,omitempty"` // enable ipv6 EnableIPV6 bool `json:"EnableIPv6,omitempty"` // IP a m IPAM *IPAM `json:"IPAM,omitempty"` // Id ID string `json:"Id,omitempty"` // ingress Ingress bool `json:"Ingress,omitempty"` // internal Internal bool `json:"Internal,omitempty"` // labels Labels map[string]string `json:"Labels,omitempty"` // name Name string `json:"Name,omitempty"` // options Options map[string]string `json:"Options,omitempty"` // scope Scope string `json:"Scope,omitempty"` }
Network network swagger:model Network
func (*Network) MarshalBinary ¶
MarshalBinary interface implementation
func (*Network) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type NetworkContainer ¶
type NetworkContainer struct { // endpoint ID EndpointID string `json:"EndpointID,omitempty"` // ipv4 address IPV4Address string `json:"IPv4Address,omitempty"` // ipv6 address IPV6Address string `json:"IPv6Address,omitempty"` // mac address MacAddress string `json:"MacAddress,omitempty"` // name Name string `json:"Name,omitempty"` }
NetworkContainer network container swagger:model NetworkContainer
func (*NetworkContainer) MarshalBinary ¶
func (m *NetworkContainer) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkContainer) UnmarshalBinary ¶
func (m *NetworkContainer) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkSettings ¶
type NetworkSettings struct { // Name of the network'a bridge (for example, `docker0`). Bridge string `json:"Bridge,omitempty"` // EndpointID uniquely represents a service endpoint in a Sandbox. // // <p><br /></p> // // > **Deprecated**: This field is only propagated when attached to the // > default "bridge" network. Use the information from the "bridge" // > network inside the `Networks` map instead, which contains the same // > information. This field was deprecated in Docker 1.9 and is scheduled // > to be removed in Docker 17.12.0 // EndpointID string `json:"EndpointID,omitempty"` // Gateway address for the default "bridge" network. // // <p><br /></p> // // > **Deprecated**: This field is only propagated when attached to the // > default "bridge" network. Use the information from the "bridge" // > network inside the `Networks` map instead, which contains the same // > information. This field was deprecated in Docker 1.9 and is scheduled // > to be removed in Docker 17.12.0 // Gateway string `json:"Gateway,omitempty"` // Global IPv6 address for the default "bridge" network. // // <p><br /></p> // // > **Deprecated**: This field is only propagated when attached to the // > default "bridge" network. Use the information from the "bridge" // > network inside the `Networks` map instead, which contains the same // > information. This field was deprecated in Docker 1.9 and is scheduled // > to be removed in Docker 17.12.0 // GlobalIPV6Address string `json:"GlobalIPv6Address,omitempty"` // Mask length of the global IPv6 address. // // <p><br /></p> // // > **Deprecated**: This field is only propagated when attached to the // > default "bridge" network. Use the information from the "bridge" // > network inside the `Networks` map instead, which contains the same // > information. This field was deprecated in Docker 1.9 and is scheduled // > to be removed in Docker 17.12.0 // GlobalIPV6PrefixLen int64 `json:"GlobalIPv6PrefixLen,omitempty"` // Indicates if hairpin NAT should be enabled on the virtual interface. // HairpinMode bool `json:"HairpinMode,omitempty"` // IPv4 address for the default "bridge" network. // // <p><br /></p> // // > **Deprecated**: This field is only propagated when attached to the // > default "bridge" network. Use the information from the "bridge" // > network inside the `Networks` map instead, which contains the same // > information. This field was deprecated in Docker 1.9 and is scheduled // > to be removed in Docker 17.12.0 // IPAddress string `json:"IPAddress,omitempty"` // Mask length of the IPv4 address. // // <p><br /></p> // // > **Deprecated**: This field is only propagated when attached to the // > default "bridge" network. Use the information from the "bridge" // > network inside the `Networks` map instead, which contains the same // > information. This field was deprecated in Docker 1.9 and is scheduled // > to be removed in Docker 17.12.0 // IPPrefixLen int64 `json:"IPPrefixLen,omitempty"` // IPv6 gateway address for this network. // // <p><br /></p> // // > **Deprecated**: This field is only propagated when attached to the // > default "bridge" network. Use the information from the "bridge" // > network inside the `Networks` map instead, which contains the same // > information. This field was deprecated in Docker 1.9 and is scheduled // > to be removed in Docker 17.12.0 // IPV6Gateway string `json:"IPv6Gateway,omitempty"` // IPv6 unicast address using the link-local prefix. LinkLocalIPV6Address string `json:"LinkLocalIPv6Address,omitempty"` // Prefix length of the IPv6 unicast address. LinkLocalIPV6PrefixLen int64 `json:"LinkLocalIPv6PrefixLen,omitempty"` // MAC address for the container on the default "bridge" network. // // <p><br /></p> // // > **Deprecated**: This field is only propagated when attached to the // > default "bridge" network. Use the information from the "bridge" // > network inside the `Networks` map instead, which contains the same // > information. This field was deprecated in Docker 1.9 and is scheduled // > to be removed in Docker 17.12.0 // MacAddress string `json:"MacAddress,omitempty"` // Information about all networks that the container is connected to. // Networks map[string]EndpointSettings `json:"Networks,omitempty"` // ports Ports PortMap `json:"Ports,omitempty"` // SandboxID uniquely represents a container's network stack. SandboxID string `json:"SandboxID,omitempty"` // SandboxKey identifies the sandbox SandboxKey string `json:"SandboxKey,omitempty"` // secondary IP addresses SecondaryIPAddresses []*Address `json:"SecondaryIPAddresses"` // secondary ipv6 addresses SecondaryIPV6Addresses []*Address `json:"SecondaryIPv6Addresses"` }
NetworkSettings NetworkSettings exposes the network settings in the API swagger:model NetworkSettings
func (*NetworkSettings) MarshalBinary ¶
func (m *NetworkSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkSettings) UnmarshalBinary ¶
func (m *NetworkSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Node ¶
type Node struct { // Date and time at which the node was added to the swarm in // [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. // CreatedAt string `json:"CreatedAt,omitempty"` // description Description *NodeDescription `json:"Description,omitempty"` // ID ID string `json:"ID,omitempty"` // manager status ManagerStatus *ManagerStatus `json:"ManagerStatus,omitempty"` // spec Spec *NodeSpec `json:"Spec,omitempty"` // status Status *NodeStatus `json:"Status,omitempty"` // Date and time at which the node was last updated in // [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. // UpdatedAt string `json:"UpdatedAt,omitempty"` // version Version *ObjectVersion `json:"Version,omitempty"` }
Node node swagger:model Node
func (*Node) MarshalBinary ¶
MarshalBinary interface implementation
func (*Node) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type NodeDescription ¶
type NodeDescription struct { // engine Engine *EngineDescription `json:"Engine,omitempty"` // hostname Hostname string `json:"Hostname,omitempty"` // platform Platform *Platform `json:"Platform,omitempty"` // resources Resources *ResourceObject `json:"Resources,omitempty"` // TLS info TLSInfo *TLSInfo `json:"TLSInfo,omitempty"` }
NodeDescription NodeDescription encapsulates the properties of the Node as reported by the agent.
swagger:model NodeDescription
func (*NodeDescription) MarshalBinary ¶
func (m *NodeDescription) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NodeDescription) UnmarshalBinary ¶
func (m *NodeDescription) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NodeSpec ¶
type NodeSpec struct { // Availability of the node. // Enum: [active pause drain] Availability string `json:"Availability,omitempty"` // User-defined key/value metadata. Labels map[string]string `json:"Labels,omitempty"` // Name for the node. Name string `json:"Name,omitempty"` // Role of the node. // Enum: [worker manager] Role string `json:"Role,omitempty"` }
NodeSpec node spec swagger:model NodeSpec
func (*NodeSpec) MarshalBinary ¶
MarshalBinary interface implementation
func (*NodeSpec) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type NodeState ¶
type NodeState string
NodeState NodeState represents the state of a node. swagger:model NodeState
const ( // NodeStateUnknown captures enum value "unknown" NodeStateUnknown NodeState = "unknown" // NodeStateDown captures enum value "down" NodeStateDown NodeState = "down" // NodeStateReady captures enum value "ready" NodeStateReady NodeState = "ready" // NodeStateDisconnected captures enum value "disconnected" NodeStateDisconnected NodeState = "disconnected" )
type NodeStatus ¶
type NodeStatus struct { // IP address of the node. Addr string `json:"Addr,omitempty"` // message Message string `json:"Message,omitempty"` // state State NodeState `json:"State,omitempty"` }
NodeStatus NodeStatus represents the status of a node.
It provides the current status of the node, as seen by the manager.
swagger:model NodeStatus
func (*NodeStatus) MarshalBinary ¶
func (m *NodeStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NodeStatus) UnmarshalBinary ¶
func (m *NodeStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ObjectVersion ¶
type ObjectVersion struct { // index Index uint64 `json:"Index,omitempty"` }
ObjectVersion The version number of the object such as node, service, etc. This is needed to avoid conflicting writes. The client must send the version number along with the modified specification when updating these objects. This approach ensures safe concurrency and determinism in that the change on the object may not be applied if the version number has changed from the last read. In other words, if two update requests specify the same base version, only one of the requests can succeed. As a result, two separate update requests that happen at the same time will not unintentionally overwrite each other.
swagger:model ObjectVersion
func (*ObjectVersion) MarshalBinary ¶
func (m *ObjectVersion) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ObjectVersion) UnmarshalBinary ¶
func (m *ObjectVersion) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PeerNode ¶
type PeerNode struct { // IP address and ports at which this node can be reached. // Addr string `json:"Addr,omitempty"` // Unique identifier of for this node in the swarm. NodeID string `json:"NodeID,omitempty"` }
PeerNode Represents a peer-node in the swarm swagger:model PeerNode
func (*PeerNode) MarshalBinary ¶
MarshalBinary interface implementation
func (*PeerNode) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Platform ¶
type Platform struct { // Architecture represents the hardware architecture (for example, // `x86_64`). // Architecture string `json:"Architecture,omitempty"` // OS represents the Operating System (for example, `linux` or `windows`). // OS string `json:"OS,omitempty"` }
Platform Platform represents the platform (Arch/OS).
swagger:model Platform
func (*Platform) MarshalBinary ¶
MarshalBinary interface implementation
func (*Platform) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Plugin ¶
type Plugin struct { // config // Required: true Config PluginConfig `json:"Config"` // True if the plugin is running. False if the plugin is not running, only installed. // Required: true Enabled bool `json:"Enabled"` // Id ID string `json:"Id,omitempty"` // name // Required: true Name string `json:"Name"` // plugin remote reference used to push/pull the plugin PluginReference string `json:"PluginReference,omitempty"` // settings // Required: true Settings PluginSettings `json:"Settings"` }
Plugin A plugin for the Engine API swagger:model Plugin
func (*Plugin) MarshalBinary ¶
MarshalBinary interface implementation
func (*Plugin) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PluginConfig ¶
type PluginConfig struct { // args // Required: true Args PluginConfigArgs `json:"Args"` // description // Required: true Description string `json:"Description"` // Docker Version used to create the plugin DockerVersion string `json:"DockerVersion,omitempty"` // documentation // Required: true Documentation string `json:"Documentation"` // entrypoint // Required: true Entrypoint []string `json:"Entrypoint"` // env // Required: true Env []PluginEnv `json:"Env"` // interface // Required: true Interface PluginConfigInterface `json:"Interface"` // ipc host // Required: true IpcHost bool `json:"IpcHost"` // linux // Required: true Linux PluginConfigLinux `json:"Linux"` // mounts // Required: true Mounts []PluginMount `json:"Mounts"` // network // Required: true Network PluginConfigNetwork `json:"Network"` // pid host // Required: true PidHost bool `json:"PidHost"` // propagated mount // Required: true PropagatedMount string `json:"PropagatedMount"` // user User PluginConfigUser `json:"User,omitempty"` // work dir // Required: true WorkDir string `json:"WorkDir"` // rootfs Rootfs *PluginConfigRootfs `json:"rootfs,omitempty"` }
PluginConfig The config of a plugin. swagger:model PluginConfig
func (*PluginConfig) MarshalBinary ¶
func (m *PluginConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfig) UnmarshalBinary ¶
func (m *PluginConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigArgs ¶
type PluginConfigArgs struct { // description // Required: true Description string `json:"Description"` // name // Required: true Name string `json:"Name"` // settable // Required: true Settable []string `json:"Settable"` // value // Required: true Value []string `json:"Value"` }
PluginConfigArgs plugin config args swagger:model PluginConfigArgs
func (*PluginConfigArgs) MarshalBinary ¶
func (m *PluginConfigArgs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigArgs) UnmarshalBinary ¶
func (m *PluginConfigArgs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigInterface ¶
type PluginConfigInterface struct { // Protocol to use for clients connecting to the plugin. // Enum: [ moby.plugins.http/v1] ProtocolScheme string `json:"ProtocolScheme,omitempty"` // socket // Required: true Socket string `json:"Socket"` // types // Required: true Types []PluginInterfaceType `json:"Types"` }
PluginConfigInterface The interface between Docker and the plugin swagger:model PluginConfigInterface
func (*PluginConfigInterface) MarshalBinary ¶
func (m *PluginConfigInterface) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigInterface) UnmarshalBinary ¶
func (m *PluginConfigInterface) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigLinux ¶
type PluginConfigLinux struct { // allow all devices // Required: true AllowAllDevices bool `json:"AllowAllDevices"` // capabilities // Required: true Capabilities []string `json:"Capabilities"` // devices // Required: true Devices []PluginDevice `json:"Devices"` }
PluginConfigLinux plugin config linux swagger:model PluginConfigLinux
func (*PluginConfigLinux) MarshalBinary ¶
func (m *PluginConfigLinux) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigLinux) UnmarshalBinary ¶
func (m *PluginConfigLinux) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigNetwork ¶
type PluginConfigNetwork struct { // type // Required: true Type string `json:"Type"` }
PluginConfigNetwork plugin config network swagger:model PluginConfigNetwork
func (*PluginConfigNetwork) MarshalBinary ¶
func (m *PluginConfigNetwork) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigNetwork) UnmarshalBinary ¶
func (m *PluginConfigNetwork) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigRootfs ¶
type PluginConfigRootfs struct { // diff ids DiffIds []string `json:"diff_ids"` // type Type string `json:"type,omitempty"` }
PluginConfigRootfs plugin config rootfs swagger:model PluginConfigRootfs
func (*PluginConfigRootfs) MarshalBinary ¶
func (m *PluginConfigRootfs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigRootfs) UnmarshalBinary ¶
func (m *PluginConfigRootfs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigUser ¶
type PluginConfigUser struct { // g ID GID uint32 `json:"GID,omitempty"` // UID UID uint32 `json:"UID,omitempty"` }
PluginConfigUser plugin config user swagger:model PluginConfigUser
func (*PluginConfigUser) MarshalBinary ¶
func (m *PluginConfigUser) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigUser) UnmarshalBinary ¶
func (m *PluginConfigUser) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginDevice ¶
type PluginDevice struct { // description // Required: true Description string `json:"Description"` // name // Required: true Name string `json:"Name"` // path // Required: true Path *string `json:"Path"` // settable // Required: true Settable []string `json:"Settable"` }
PluginDevice plugin device swagger:model PluginDevice
func (*PluginDevice) MarshalBinary ¶
func (m *PluginDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginDevice) UnmarshalBinary ¶
func (m *PluginDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginEnv ¶
type PluginEnv struct { // description // Required: true Description string `json:"Description"` // name // Required: true Name string `json:"Name"` // settable // Required: true Settable []string `json:"Settable"` // value // Required: true Value *string `json:"Value"` }
PluginEnv plugin env swagger:model PluginEnv
func (*PluginEnv) MarshalBinary ¶
MarshalBinary interface implementation
func (*PluginEnv) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PluginInterfaceType ¶
type PluginInterfaceType struct { // capability // Required: true Capability string `json:"Capability"` // prefix // Required: true Prefix string `json:"Prefix"` // version // Required: true Version string `json:"Version"` }
PluginInterfaceType plugin interface type swagger:model PluginInterfaceType
func (*PluginInterfaceType) MarshalBinary ¶
func (m *PluginInterfaceType) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginInterfaceType) UnmarshalBinary ¶
func (m *PluginInterfaceType) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginMount ¶
type PluginMount struct { // description // Required: true Description string `json:"Description"` // destination // Required: true Destination string `json:"Destination"` // name // Required: true Name string `json:"Name"` // options // Required: true Options []string `json:"Options"` // settable // Required: true Settable []string `json:"Settable"` // source // Required: true Source *string `json:"Source"` // type // Required: true Type string `json:"Type"` }
PluginMount plugin mount swagger:model PluginMount
func (*PluginMount) MarshalBinary ¶
func (m *PluginMount) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginMount) UnmarshalBinary ¶
func (m *PluginMount) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginSettings ¶
type PluginSettings struct { // args // Required: true Args []string `json:"Args"` // devices // Required: true Devices []PluginDevice `json:"Devices"` // env // Required: true Env []string `json:"Env"` // mounts // Required: true Mounts []PluginMount `json:"Mounts"` }
PluginSettings Settings that can be modified by users. swagger:model PluginSettings
func (*PluginSettings) MarshalBinary ¶
func (m *PluginSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginSettings) UnmarshalBinary ¶
func (m *PluginSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginsInfo ¶
type PluginsInfo struct { // Names of available authorization plugins. Authorization []string `json:"Authorization"` // Names of available logging-drivers, and logging-driver plugins. Log []string `json:"Log"` // Names of available network-drivers, and network-driver plugins. Network []string `json:"Network"` // Names of available volume-drivers, and network-driver plugins. Volume []string `json:"Volume"` }
PluginsInfo Available plugins per type.
<p><br /></p>
> **Note**: Only unmanaged (V1) plugins are included in this list. > V1 plugins are "lazily" loaded, and are not returned in this list > if there is no resource using the plugin.
swagger:model PluginsInfo
func (*PluginsInfo) MarshalBinary ¶
func (m *PluginsInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginsInfo) UnmarshalBinary ¶
func (m *PluginsInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Port ¶
type Port struct { // Host IP address that the container's port is mapped to IP string `json:"IP,omitempty"` // Port on the container // Required: true PrivatePort uint16 `json:"PrivatePort"` // Port exposed on the host PublicPort uint16 `json:"PublicPort,omitempty"` // type // Required: true // Enum: [tcp udp sctp] Type string `json:"Type"` }
Port An open port on a container swagger:model Port
func (*Port) MarshalBinary ¶
MarshalBinary interface implementation
func (*Port) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PortBinding ¶
type PortBinding struct { // Host IP address that the container's port is mapped to. HostIP string `json:"HostIp,omitempty"` // Host port number that the container's port is mapped to. HostPort string `json:"HostPort,omitempty"` }
PortBinding PortBinding represents a binding between a host IP address and a host port.
swagger:model PortBinding
func (*PortBinding) MarshalBinary ¶
func (m *PortBinding) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PortBinding) UnmarshalBinary ¶
func (m *PortBinding) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PortMap ¶
type PortMap map[string][]PortBinding
PortMap PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`.
If a container's port is mapped for multiple protocols, separate entries are added to the mapping table.
swagger:model PortMap
type ProcessConfig ¶
type ProcessConfig struct { // arguments Arguments []string `json:"arguments"` // entrypoint Entrypoint string `json:"entrypoint,omitempty"` // privileged Privileged bool `json:"privileged,omitempty"` // tty Tty bool `json:"tty,omitempty"` // user User string `json:"user,omitempty"` }
ProcessConfig process config swagger:model ProcessConfig
func (*ProcessConfig) MarshalBinary ¶
func (m *ProcessConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProcessConfig) UnmarshalBinary ¶
func (m *ProcessConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProgressDetail ¶
type ProgressDetail struct { // current Current int64 `json:"current,omitempty"` // total Total int64 `json:"total,omitempty"` }
ProgressDetail progress detail swagger:model ProgressDetail
func (*ProgressDetail) MarshalBinary ¶
func (m *ProgressDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProgressDetail) UnmarshalBinary ¶
func (m *ProgressDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PushImageInfo ¶
type PushImageInfo struct { // error Error string `json:"error,omitempty"` // progress Progress string `json:"progress,omitempty"` // progress detail ProgressDetail *ProgressDetail `json:"progressDetail,omitempty"` // status Status string `json:"status,omitempty"` }
PushImageInfo push image info swagger:model PushImageInfo
func (*PushImageInfo) MarshalBinary ¶
func (m *PushImageInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PushImageInfo) UnmarshalBinary ¶
func (m *PushImageInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Reachability ¶
type Reachability string
Reachability Reachability represents the reachability of a node. swagger:model Reachability
const ( // ReachabilityUnknown captures enum value "unknown" ReachabilityUnknown Reachability = "unknown" // ReachabilityUnreachable captures enum value "unreachable" ReachabilityUnreachable Reachability = "unreachable" // ReachabilityReachable captures enum value "reachable" ReachabilityReachable Reachability = "reachable" )
type RegistryServiceConfig ¶
type RegistryServiceConfig struct { // List of IP ranges to which nondistributable artifacts can be pushed, // using the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632). // // Some images (for example, Windows base images) contain artifacts // whose distribution is restricted by license. When these images are // pushed to a registry, restricted artifacts are not included. // // This configuration override this behavior, and enables the daemon to // push nondistributable artifacts to all registries whose resolved IP // address is within the subnet described by the CIDR syntax. // // This option is useful when pushing images containing // nondistributable artifacts to a registry on an air-gapped network so // hosts on that network can pull the images without connecting to // another server. // // > **Warning**: Nondistributable artifacts typically have restrictions // > on how and where they can be distributed and shared. Only use this // > feature to push artifacts to private registries and ensure that you // > are in compliance with any terms that cover redistributing // > nondistributable artifacts. // AllowNondistributableArtifactsCIDRs []string `json:"AllowNondistributableArtifactsCIDRs"` // List of registry hostnames to which nondistributable artifacts can be // pushed, using the format `<hostname>[:<port>]` or `<IP address>[:<port>]`. // // Some images (for example, Windows base images) contain artifacts // whose distribution is restricted by license. When these images are // pushed to a registry, restricted artifacts are not included. // // This configuration override this behavior for the specified // registries. // // This option is useful when pushing images containing // nondistributable artifacts to a registry on an air-gapped network so // hosts on that network can pull the images without connecting to // another server. // // > **Warning**: Nondistributable artifacts typically have restrictions // > on how and where they can be distributed and shared. Only use this // > feature to push artifacts to private registries and ensure that you // > are in compliance with any terms that cover redistributing // > nondistributable artifacts. // AllowNondistributableArtifactsHostnames []string `json:"AllowNondistributableArtifactsHostnames"` // index configs IndexConfigs map[string]IndexInfo `json:"IndexConfigs,omitempty"` // List of IP ranges of insecure registries, using the CIDR syntax // ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries // accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates // from unknown CAs) communication. // // By default, local registries (`127.0.0.0/8`) are configured as // insecure. All other registries are secure. Communicating with an // insecure registry is not possible if the daemon assumes that registry // is secure. // // This configuration override this behavior, insecure communication with // registries whose resolved IP address is within the subnet described by // the CIDR syntax. // // Registries can also be marked insecure by hostname. Those registries // are listed under `IndexConfigs` and have their `Secure` field set to // `false`. // // > **Warning**: Using this option can be useful when running a local // > registry, but introduces security vulnerabilities. This option // > should therefore ONLY be used for testing purposes. For increased // > security, users should add their CA to their system's list of trusted // > CAs instead of enabling this option. // InsecureRegistryCIDRs []string `json:"InsecureRegistryCIDRs"` // List of registry URLs that act as a mirror for the official // (`docker.io`) registry. // Mirrors []string `json:"Mirrors"` }
RegistryServiceConfig RegistryServiceConfig stores daemon registry services configuration.
swagger:model RegistryServiceConfig
func (*RegistryServiceConfig) MarshalBinary ¶
func (m *RegistryServiceConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RegistryServiceConfig) UnmarshalBinary ¶
func (m *RegistryServiceConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ResourceObject ¶
type ResourceObject struct { // generic resources GenericResources GenericResources `json:"GenericResources,omitempty"` // memory bytes MemoryBytes int64 `json:"MemoryBytes,omitempty"` // nano cpus NanoCpus int64 `json:"NanoCPUs,omitempty"` }
ResourceObject An object describing the resources which can be advertised by a node and requested by a task swagger:model ResourceObject
func (*ResourceObject) MarshalBinary ¶
func (m *ResourceObject) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResourceObject) UnmarshalBinary ¶
func (m *ResourceObject) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Resources ¶
type Resources struct { // Limit read rate (bytes per second) from a device, in the form `[{"Path": "device_path", "Rate": rate}]`. // BlkioDeviceReadBps []*ThrottleDevice `json:"BlkioDeviceReadBps"` // Limit read rate (IO per second) from a device, in the form `[{"Path": "device_path", "Rate": rate}]`. // BlkioDeviceReadIOps []*ThrottleDevice `json:"BlkioDeviceReadIOps"` // Limit write rate (bytes per second) to a device, in the form `[{"Path": "device_path", "Rate": rate}]`. // BlkioDeviceWriteBps []*ThrottleDevice `json:"BlkioDeviceWriteBps"` // Limit write rate (IO per second) to a device, in the form `[{"Path": "device_path", "Rate": rate}]`. // BlkioDeviceWriteIOps []*ThrottleDevice `json:"BlkioDeviceWriteIOps"` // Block IO weight (relative weight). // Maximum: 1000 // Minimum: 0 BlkioWeight *int64 `json:"BlkioWeight,omitempty"` // Block IO weight (relative device weight) in the form `[{"Path": "device_path", "Weight": weight}]`. // BlkioWeightDevice []*ResourcesBlkioWeightDeviceItems0 `json:"BlkioWeightDevice"` // Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. CgroupParent string `json:"CgroupParent,omitempty"` // The number of usable CPUs (Windows only). // // On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. // CPUCount int64 `json:"CpuCount,omitempty"` // The usable percentage of the available CPUs (Windows only). // // On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. // CPUPercent int64 `json:"CpuPercent,omitempty"` // The length of a CPU period in microseconds. CPUPeriod int64 `json:"CpuPeriod,omitempty"` // Microseconds of CPU time that the container can get in a CPU period. CPUQuota int64 `json:"CpuQuota,omitempty"` // The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. CPURealtimePeriod int64 `json:"CpuRealtimePeriod,omitempty"` // The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. CPURealtimeRuntime int64 `json:"CpuRealtimeRuntime,omitempty"` CPUShares int64 `json:"CpuShares,omitempty"` // CPUs in which to allow execution (e.g., `0-3`, `0,1`) CpusetCpus string `json:"CpusetCpus,omitempty"` // Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. CpusetMems string `json:"CpusetMems,omitempty"` // a list of cgroup rules to apply to the container DeviceCgroupRules []string `json:"DeviceCgroupRules"` // a list of requests for devices to be sent to device drivers DeviceRequests []*DeviceRequest `json:"DeviceRequests"` // A list of devices to add to the container. Devices []*DeviceMapping `json:"Devices"` // Disk limit (in bytes). DiskQuota int64 `json:"DiskQuota,omitempty"` // Maximum IO in bytes per second for the container system drive (Windows only) IOMaximumBandwidth int64 `json:"IOMaximumBandwidth,omitempty"` // Maximum IOps for the container system drive (Windows only) IOMaximumIOps int64 `json:"IOMaximumIOps,omitempty"` // Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. Init *bool `json:"Init,omitempty"` // Kernel memory limit in bytes. KernelMemory int64 `json:"KernelMemory,omitempty"` // Hard limit for kernel TCP buffer memory (in bytes). KernelMemoryTCP int64 `json:"KernelMemoryTCP,omitempty"` // Memory limit in bytes. Memory int64 `json:"Memory,omitempty"` // Memory soft limit in bytes. MemoryReservation int64 `json:"MemoryReservation,omitempty"` // Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. MemorySwap int64 `json:"MemorySwap,omitempty"` // Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. // Maximum: 100 // Minimum: 0 MemorySwappiness *int64 `json:"MemorySwappiness,omitempty"` // CPU quota in units of 10<sup>-9</sup> CPUs. NanoCpus int64 `json:"NanoCPUs,omitempty"` // Disable OOM Killer for the container. OomKillDisable bool `json:"OomKillDisable,omitempty"` // Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. // PidsLimit *int64 `json:"PidsLimit,omitempty"` // A list of resource limits to set in the container. For example: `{"Name": "nofile", "Soft": 1024, "Hard": 2048}`" // Ulimits []*ResourcesUlimitsItems0 `json:"Ulimits"` }
Resources A container's resources (cgroups config, ulimits, etc) swagger:model Resources
func (*Resources) MarshalBinary ¶
MarshalBinary interface implementation
func (*Resources) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ResourcesBlkioWeightDeviceItems0 ¶
type ResourcesBlkioWeightDeviceItems0 struct { // path Path string `json:"Path,omitempty"` // weight // Minimum: 0 Weight *int64 `json:"Weight,omitempty"` }
ResourcesBlkioWeightDeviceItems0 resources blkio weight device items0 swagger:model ResourcesBlkioWeightDeviceItems0
func (*ResourcesBlkioWeightDeviceItems0) MarshalBinary ¶
func (m *ResourcesBlkioWeightDeviceItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResourcesBlkioWeightDeviceItems0) UnmarshalBinary ¶
func (m *ResourcesBlkioWeightDeviceItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ResourcesUlimitsItems0 ¶
type ResourcesUlimitsItems0 struct { // Hard limit Hard int64 `json:"Hard,omitempty"` // Name of ulimit Name string `json:"Name,omitempty"` // Soft limit Soft int64 `json:"Soft,omitempty"` }
ResourcesUlimitsItems0 resources ulimits items0 swagger:model ResourcesUlimitsItems0
func (*ResourcesUlimitsItems0) MarshalBinary ¶
func (m *ResourcesUlimitsItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResourcesUlimitsItems0) UnmarshalBinary ¶
func (m *ResourcesUlimitsItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RestartPolicy ¶
type RestartPolicy struct { // If `on-failure` is used, the number of times to retry before giving up MaximumRetryCount int64 `json:"MaximumRetryCount,omitempty"` // - Empty string means not to restart // - `always` Always restart // - `unless-stopped` Restart always except when the user has manually stopped the container // - `on-failure` Restart only when the container exit code is non-zero // // Enum: [ always unless-stopped on-failure] Name string `json:"Name,omitempty"` }
RestartPolicy The behavior to apply when the container exits. The default is not to restart.
An ever increasing delay (double the previous delay, starting at 100ms) is added before each restart to prevent flooding the server.
swagger:model RestartPolicy
func (*RestartPolicy) MarshalBinary ¶
func (m *RestartPolicy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RestartPolicy) UnmarshalBinary ¶
func (m *RestartPolicy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Runtime ¶
type Runtime struct { // Name and, optional, path, of the OCI executable binary. // // If the path is omitted, the daemon searches the host's `$PATH` for the // binary and uses the first result. // Path string `json:"path,omitempty"` // List of command-line arguments to pass to the runtime when invoked. // RuntimeArgs []string `json:"runtimeArgs"` }
Runtime Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec) runtime.
The runtime is invoked by the daemon via the `containerd` daemon. OCI runtimes act as an interface to the Linux kernel namespaces, cgroups, and SELinux.
swagger:model Runtime
func (*Runtime) MarshalBinary ¶
MarshalBinary interface implementation
func (*Runtime) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Secret ¶
type Secret struct { // created at CreatedAt string `json:"CreatedAt,omitempty"` // ID ID string `json:"ID,omitempty"` // spec Spec *SecretSpec `json:"Spec,omitempty"` // updated at UpdatedAt string `json:"UpdatedAt,omitempty"` // version Version *ObjectVersion `json:"Version,omitempty"` }
Secret secret swagger:model Secret
func (*Secret) MarshalBinary ¶
MarshalBinary interface implementation
func (*Secret) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SecretSpec ¶
type SecretSpec struct { // Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-3.2)) // data to store as secret. // // This field is only used to _create_ a secret, and is not returned by // other endpoints. // Data string `json:"Data,omitempty"` // Name of the secrets driver used to fetch the secret's value from an external secret store Driver *Driver `json:"Driver,omitempty"` // User-defined key/value metadata. Labels map[string]string `json:"Labels,omitempty"` // User-defined name of the secret. Name string `json:"Name,omitempty"` // Templating driver, if applicable // // Templating controls whether and how to evaluate the config payload as // a template. If no driver is set, no templating is used. // Templating *Driver `json:"Templating,omitempty"` }
SecretSpec secret spec swagger:model SecretSpec
func (*SecretSpec) MarshalBinary ¶
func (m *SecretSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecretSpec) UnmarshalBinary ¶
func (m *SecretSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Service ¶
type Service struct { // created at CreatedAt string `json:"CreatedAt,omitempty"` // endpoint Endpoint *ServiceEndpoint `json:"Endpoint,omitempty"` // ID ID string `json:"ID,omitempty"` // spec Spec *ServiceSpec `json:"Spec,omitempty"` // update status UpdateStatus *ServiceUpdateStatus `json:"UpdateStatus,omitempty"` // updated at UpdatedAt string `json:"UpdatedAt,omitempty"` // version Version *ObjectVersion `json:"Version,omitempty"` }
Service service swagger:model Service
func (*Service) MarshalBinary ¶
MarshalBinary interface implementation
func (*Service) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ServiceEndpoint ¶
type ServiceEndpoint struct { // ports Ports []*EndpointPortConfig `json:"Ports"` // spec Spec *EndpointSpec `json:"Spec,omitempty"` // virtual ips VirtualIps []*ServiceEndpointVirtualIpsItems0 `json:"VirtualIPs"` }
ServiceEndpoint service endpoint swagger:model ServiceEndpoint
func (*ServiceEndpoint) MarshalBinary ¶
func (m *ServiceEndpoint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceEndpoint) UnmarshalBinary ¶
func (m *ServiceEndpoint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceEndpointVirtualIpsItems0 ¶
type ServiceEndpointVirtualIpsItems0 struct { // addr Addr string `json:"Addr,omitempty"` // network ID NetworkID string `json:"NetworkID,omitempty"` }
ServiceEndpointVirtualIpsItems0 service endpoint virtual ips items0 swagger:model ServiceEndpointVirtualIpsItems0
func (*ServiceEndpointVirtualIpsItems0) MarshalBinary ¶
func (m *ServiceEndpointVirtualIpsItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceEndpointVirtualIpsItems0) UnmarshalBinary ¶
func (m *ServiceEndpointVirtualIpsItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceSpec ¶
type ServiceSpec struct { // endpoint spec EndpointSpec *EndpointSpec `json:"EndpointSpec,omitempty"` // User-defined key/value metadata. Labels map[string]string `json:"Labels,omitempty"` // mode Mode *ServiceSpecMode `json:"Mode,omitempty"` // Name of the service. Name string `json:"Name,omitempty"` // Array of network names or IDs to attach the service to. Networks []*ServiceSpecNetworksItems0 `json:"Networks"` // rollback config RollbackConfig *ServiceSpecRollbackConfig `json:"RollbackConfig,omitempty"` // task template TaskTemplate *TaskSpec `json:"TaskTemplate,omitempty"` // update config UpdateConfig *ServiceSpecUpdateConfig `json:"UpdateConfig,omitempty"` }
ServiceSpec User modifiable configuration for a service. swagger:model ServiceSpec
func (*ServiceSpec) MarshalBinary ¶
func (m *ServiceSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceSpec) UnmarshalBinary ¶
func (m *ServiceSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceSpecMode ¶
type ServiceSpecMode struct { // global Global interface{} `json:"Global,omitempty"` // replicated Replicated *ServiceSpecModeReplicated `json:"Replicated,omitempty"` }
ServiceSpecMode Scheduling mode for the service. swagger:model ServiceSpecMode
func (*ServiceSpecMode) MarshalBinary ¶
func (m *ServiceSpecMode) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceSpecMode) UnmarshalBinary ¶
func (m *ServiceSpecMode) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceSpecModeReplicated ¶
type ServiceSpecModeReplicated struct { // replicas Replicas int64 `json:"Replicas,omitempty"` }
ServiceSpecModeReplicated service spec mode replicated swagger:model ServiceSpecModeReplicated
func (*ServiceSpecModeReplicated) MarshalBinary ¶
func (m *ServiceSpecModeReplicated) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceSpecModeReplicated) UnmarshalBinary ¶
func (m *ServiceSpecModeReplicated) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceSpecNetworksItems0 ¶
type ServiceSpecNetworksItems0 struct { // aliases Aliases []string `json:"Aliases"` // target Target string `json:"Target,omitempty"` }
ServiceSpecNetworksItems0 service spec networks items0 swagger:model ServiceSpecNetworksItems0
func (*ServiceSpecNetworksItems0) MarshalBinary ¶
func (m *ServiceSpecNetworksItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceSpecNetworksItems0) UnmarshalBinary ¶
func (m *ServiceSpecNetworksItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceSpecRollbackConfig ¶
type ServiceSpecRollbackConfig struct { // Amount of time between rollback iterations, in nanoseconds. Delay int64 `json:"Delay,omitempty"` // Action to take if an rolled back task fails to run, or stops running during the rollback. // Enum: [continue pause] FailureAction string `json:"FailureAction,omitempty"` // The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1. MaxFailureRatio float64 `json:"MaxFailureRatio,omitempty"` // Amount of time to monitor each rolled back task for failures, in nanoseconds. Monitor int64 `json:"Monitor,omitempty"` // The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. // Enum: [stop-first start-first] Order string `json:"Order,omitempty"` // Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism). Parallelism int64 `json:"Parallelism,omitempty"` }
ServiceSpecRollbackConfig Specification for the rollback strategy of the service. swagger:model ServiceSpecRollbackConfig
func (*ServiceSpecRollbackConfig) MarshalBinary ¶
func (m *ServiceSpecRollbackConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceSpecRollbackConfig) UnmarshalBinary ¶
func (m *ServiceSpecRollbackConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceSpecUpdateConfig ¶
type ServiceSpecUpdateConfig struct { // Amount of time between updates, in nanoseconds. Delay int64 `json:"Delay,omitempty"` // Action to take if an updated task fails to run, or stops running during the update. // Enum: [continue pause rollback] FailureAction string `json:"FailureAction,omitempty"` // The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1. MaxFailureRatio float64 `json:"MaxFailureRatio,omitempty"` // Amount of time to monitor each updated task for failures, in nanoseconds. Monitor int64 `json:"Monitor,omitempty"` // The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. // Enum: [stop-first start-first] Order string `json:"Order,omitempty"` // Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism). Parallelism int64 `json:"Parallelism,omitempty"` }
ServiceSpecUpdateConfig Specification for the update strategy of the service. swagger:model ServiceSpecUpdateConfig
func (*ServiceSpecUpdateConfig) MarshalBinary ¶
func (m *ServiceSpecUpdateConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceSpecUpdateConfig) UnmarshalBinary ¶
func (m *ServiceSpecUpdateConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceUpdateResponse ¶
type ServiceUpdateResponse struct { // Optional warning messages Warnings []string `json:"Warnings"` }
ServiceUpdateResponse service update response swagger:model ServiceUpdateResponse
func (*ServiceUpdateResponse) MarshalBinary ¶
func (m *ServiceUpdateResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceUpdateResponse) UnmarshalBinary ¶
func (m *ServiceUpdateResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceUpdateStatus ¶
type ServiceUpdateStatus struct { // completed at CompletedAt string `json:"CompletedAt,omitempty"` // message Message string `json:"Message,omitempty"` // started at StartedAt string `json:"StartedAt,omitempty"` // state // Enum: [updating paused completed] State string `json:"State,omitempty"` }
ServiceUpdateStatus The status of a service update. swagger:model ServiceUpdateStatus
func (*ServiceUpdateStatus) MarshalBinary ¶
func (m *ServiceUpdateStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceUpdateStatus) UnmarshalBinary ¶
func (m *ServiceUpdateStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Swarm ¶
type Swarm struct { ClusterInfo // join tokens JoinTokens *JoinTokens `json:"JoinTokens,omitempty"` }
Swarm swarm swagger:model Swarm
func (*Swarm) MarshalBinary ¶
MarshalBinary interface implementation
func (Swarm) MarshalJSON ¶
MarshalJSON marshals this object to a JSON structure
func (*Swarm) UnmarshalBinary ¶
UnmarshalBinary interface implementation
func (*Swarm) UnmarshalJSON ¶
UnmarshalJSON unmarshals this object from a JSON structure
type SwarmInfo ¶
type SwarmInfo struct { // cluster Cluster *ClusterInfo `json:"Cluster,omitempty"` // control available ControlAvailable *bool `json:"ControlAvailable,omitempty"` // error Error string `json:"Error,omitempty"` // local node state LocalNodeState LocalNodeState `json:"LocalNodeState,omitempty"` // Total number of managers in the swarm. Managers *int64 `json:"Managers,omitempty"` // IP address at which this node can be reached by other nodes in the // swarm. // NodeAddr string `json:"NodeAddr,omitempty"` // Unique identifier of for this node in the swarm. NodeID string `json:"NodeID,omitempty"` // Total number of nodes in the swarm. Nodes *int64 `json:"Nodes,omitempty"` // List of ID's and addresses of other managers in the swarm. // RemoteManagers []*PeerNode `json:"RemoteManagers"` }
SwarmInfo Represents generic information about swarm.
swagger:model SwarmInfo
func (*SwarmInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*SwarmInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SwarmSpec ¶
type SwarmSpec struct { // c a config CAConfig *SwarmSpecCAConfig `json:"CAConfig,omitempty"` // dispatcher Dispatcher *SwarmSpecDispatcher `json:"Dispatcher,omitempty"` // encryption config EncryptionConfig *SwarmSpecEncryptionConfig `json:"EncryptionConfig,omitempty"` // User-defined key/value metadata. Labels map[string]string `json:"Labels,omitempty"` // Name of the swarm. Name string `json:"Name,omitempty"` // orchestration Orchestration *SwarmSpecOrchestration `json:"Orchestration,omitempty"` // raft Raft *SwarmSpecRaft `json:"Raft,omitempty"` // task defaults TaskDefaults *SwarmSpecTaskDefaults `json:"TaskDefaults,omitempty"` }
SwarmSpec User modifiable swarm configuration. swagger:model SwarmSpec
func (*SwarmSpec) MarshalBinary ¶
MarshalBinary interface implementation
func (*SwarmSpec) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SwarmSpecCAConfig ¶
type SwarmSpecCAConfig struct { // Configuration for forwarding signing requests to an external certificate authority. ExternalCAs []*SwarmSpecCAConfigExternalCAsItems0 `json:"ExternalCAs"` // An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in `SigningCACert` and `SigningCAKey` ForceRotate uint64 `json:"ForceRotate,omitempty"` // The duration node certificates are issued for. NodeCertExpiry int64 `json:"NodeCertExpiry,omitempty"` // The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. SigningCACert string `json:"SigningCACert,omitempty"` // The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. SigningCAKey string `json:"SigningCAKey,omitempty"` }
SwarmSpecCAConfig CA configuration. swagger:model SwarmSpecCAConfig
func (*SwarmSpecCAConfig) MarshalBinary ¶
func (m *SwarmSpecCAConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecCAConfig) UnmarshalBinary ¶
func (m *SwarmSpecCAConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwarmSpecCAConfigExternalCAsItems0 ¶
type SwarmSpecCAConfigExternalCAsItems0 struct { // The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided). CACert string `json:"CACert,omitempty"` // An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver. Options map[string]string `json:"Options,omitempty"` // Protocol for communication with the external CA (currently only `cfssl` is supported). // Enum: [cfssl] Protocol *string `json:"Protocol,omitempty"` // URL where certificate signing requests should be sent. URL string `json:"URL,omitempty"` }
SwarmSpecCAConfigExternalCAsItems0 swarm spec c a config external c as items0 swagger:model SwarmSpecCAConfigExternalCAsItems0
func (*SwarmSpecCAConfigExternalCAsItems0) MarshalBinary ¶
func (m *SwarmSpecCAConfigExternalCAsItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecCAConfigExternalCAsItems0) UnmarshalBinary ¶
func (m *SwarmSpecCAConfigExternalCAsItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwarmSpecDispatcher ¶
type SwarmSpecDispatcher struct { // The delay for an agent to send a heartbeat to the dispatcher. HeartbeatPeriod int64 `json:"HeartbeatPeriod,omitempty"` }
SwarmSpecDispatcher Dispatcher configuration. swagger:model SwarmSpecDispatcher
func (*SwarmSpecDispatcher) MarshalBinary ¶
func (m *SwarmSpecDispatcher) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecDispatcher) UnmarshalBinary ¶
func (m *SwarmSpecDispatcher) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwarmSpecEncryptionConfig ¶
type SwarmSpecEncryptionConfig struct { // If set, generate a key and use it to lock data stored on the managers. AutoLockManagers bool `json:"AutoLockManagers,omitempty"` }
SwarmSpecEncryptionConfig Parameters related to encryption-at-rest. swagger:model SwarmSpecEncryptionConfig
func (*SwarmSpecEncryptionConfig) MarshalBinary ¶
func (m *SwarmSpecEncryptionConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecEncryptionConfig) UnmarshalBinary ¶
func (m *SwarmSpecEncryptionConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwarmSpecOrchestration ¶
type SwarmSpecOrchestration struct { // The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks. TaskHistoryRetentionLimit int64 `json:"TaskHistoryRetentionLimit,omitempty"` }
SwarmSpecOrchestration Orchestration configuration. swagger:model SwarmSpecOrchestration
func (*SwarmSpecOrchestration) MarshalBinary ¶
func (m *SwarmSpecOrchestration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecOrchestration) UnmarshalBinary ¶
func (m *SwarmSpecOrchestration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwarmSpecRaft ¶
type SwarmSpecRaft struct { // The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. `ElectionTick` must be greater than `HeartbeatTick`. // // A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. // ElectionTick int64 `json:"ElectionTick,omitempty"` // The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers. // // A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. // HeartbeatTick int64 `json:"HeartbeatTick,omitempty"` // The number of snapshots to keep beyond the current snapshot. KeepOldSnapshots uint64 `json:"KeepOldSnapshots,omitempty"` // The number of log entries to keep around to sync up slow followers after a snapshot is created. LogEntriesForSlowFollowers uint64 `json:"LogEntriesForSlowFollowers,omitempty"` // The number of log entries between snapshots. SnapshotInterval uint64 `json:"SnapshotInterval,omitempty"` }
SwarmSpecRaft Raft configuration. swagger:model SwarmSpecRaft
func (*SwarmSpecRaft) MarshalBinary ¶
func (m *SwarmSpecRaft) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecRaft) UnmarshalBinary ¶
func (m *SwarmSpecRaft) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwarmSpecTaskDefaults ¶
type SwarmSpecTaskDefaults struct { // log driver LogDriver *SwarmSpecTaskDefaultsLogDriver `json:"LogDriver,omitempty"` }
SwarmSpecTaskDefaults Defaults for creating tasks in this cluster. swagger:model SwarmSpecTaskDefaults
func (*SwarmSpecTaskDefaults) MarshalBinary ¶
func (m *SwarmSpecTaskDefaults) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecTaskDefaults) UnmarshalBinary ¶
func (m *SwarmSpecTaskDefaults) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwarmSpecTaskDefaultsLogDriver ¶
type SwarmSpecTaskDefaultsLogDriver struct { // The log driver to use as a default for new tasks. // Name string `json:"Name,omitempty"` // Driver-specific options for the selectd log driver, specified // as key/value pairs. // Options map[string]string `json:"Options,omitempty"` }
SwarmSpecTaskDefaultsLogDriver The log driver to use for tasks created in the orchestrator if unspecified by a service.
Updating this value only affects new tasks. Existing tasks continue to use their previously configured log driver until recreated.
swagger:model SwarmSpecTaskDefaultsLogDriver
func (*SwarmSpecTaskDefaultsLogDriver) MarshalBinary ¶
func (m *SwarmSpecTaskDefaultsLogDriver) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwarmSpecTaskDefaultsLogDriver) UnmarshalBinary ¶
func (m *SwarmSpecTaskDefaultsLogDriver) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SystemInfo ¶
type SystemInfo struct { // Hardware architecture of the host, as returned by the Go runtime // (`GOARCH`). // // A full list of possible values can be found in the [Go documentation](https://golang.org/doc/install/source#environment). // Architecture string `json:"Architecture,omitempty"` // Indicates if `bridge-nf-call-ip6tables` is available on the host. BridgeNfIp6tables bool `json:"BridgeNfIp6tables,omitempty"` // Indicates if `bridge-nf-call-iptables` is available on the host. BridgeNfIptables bool `json:"BridgeNfIptables,omitempty"` // Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. // // See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt) // CPUSet bool `json:"CPUSet,omitempty"` CPUShares bool `json:"CPUShares,omitempty"` // The driver to use for managing cgroups. // // Enum: [cgroupfs systemd] CgroupDriver *string `json:"CgroupDriver,omitempty"` // The network endpoint that the Engine advertises for the purpose of // node discovery. ClusterAdvertise is a `host:port` combination on which // the daemon is reachable by other hosts. // // <p><br /></p> // // > **Note**: This field is only propagated when using standalone Swarm // > mode, and overlay networking using an external k/v store. Overlay // > networks with Swarm mode enabled use the built-in raft store, and // > this field will be empty. // ClusterAdvertise string `json:"ClusterAdvertise,omitempty"` // URL of the distributed storage backend. // // // The storage backend is used for multihost networking (to store // network and endpoint information) and by the node discovery mechanism. // // <p><br /></p> // // > **Note**: This field is only propagated when using standalone Swarm // > mode, and overlay networking using an external k/v store. Overlay // > networks with Swarm mode enabled use the built-in raft store, and // > this field will be empty. // ClusterStore string `json:"ClusterStore,omitempty"` // containerd commit ContainerdCommit *Commit `json:"ContainerdCommit,omitempty"` // Total number of containers on the host. Containers int64 `json:"Containers,omitempty"` // Number of containers with status `"paused"`. // ContainersPaused int64 `json:"ContainersPaused,omitempty"` // Number of containers with status `"running"`. // ContainersRunning int64 `json:"ContainersRunning,omitempty"` // Number of containers with status `"stopped"`. // ContainersStopped int64 `json:"ContainersStopped,omitempty"` // Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host. CPUCfsPeriod bool `json:"CpuCfsPeriod,omitempty"` // Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host. CPUCfsQuota bool `json:"CpuCfsQuota,omitempty"` // Indicates if the daemon is running in debug-mode / with debug-level logging enabled. Debug bool `json:"Debug,omitempty"` // Name of the default OCI runtime that is used when starting containers. // // The default can be overridden per-container at create time. // DefaultRuntime *string `json:"DefaultRuntime,omitempty"` // Root directory of persistent Docker state. // // Defaults to `/var/lib/docker` on Linux, and `C:\ProgramData\docker` // on Windows. // DockerRootDir string `json:"DockerRootDir,omitempty"` // Name of the storage driver in use. Driver string `json:"Driver,omitempty"` // Information specific to the storage driver, provided as // "label" / "value" pairs. // // This information is provided by the storage driver, and formatted // in a way consistent with the output of `docker info` on the command // line. // // <p><br /></p> // // > **Note**: The information returned in this field, including the // > formatting of values and labels, should not be considered stable, // > and may change without notice. // DriverStatus [][]string `json:"DriverStatus"` // Indicates if experimental features are enabled on the daemon. // ExperimentalBuild bool `json:"ExperimentalBuild,omitempty"` // generic resources GenericResources GenericResources `json:"GenericResources,omitempty"` // HTTP-proxy configured for the daemon. This value is obtained from the // [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. // Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL // are masked in the API response. // // Containers do not automatically inherit this configuration. // HTTPProxy string `json:"HttpProxy,omitempty"` // HTTPS-proxy configured for the daemon. This value is obtained from the // [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. // Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL // are masked in the API response. // // Containers do not automatically inherit this configuration. // HTTPSProxy string `json:"HttpsProxy,omitempty"` // Unique identifier of the daemon. // // <p><br /></p> // // > **Note**: The format of the ID itself is not part of the API, and // > should not be considered stable. // ID string `json:"ID,omitempty"` // Indicates IPv4 forwarding is enabled. IPV4Forwarding bool `json:"IPv4Forwarding,omitempty"` // Total number of images on the host. // // Both _tagged_ and _untagged_ (dangling) images are counted. // Images int64 `json:"Images,omitempty"` // Address / URL of the index server that is used for image search, // and as a default for user authentication for Docker Hub and Docker Cloud. // IndexServerAddress *string `json:"IndexServerAddress,omitempty"` // Name and, optional, path of the `docker-init` binary. // // If the path is omitted, the daemon searches the host's `$PATH` for the // binary and uses the first result. // InitBinary string `json:"InitBinary,omitempty"` // init commit InitCommit *Commit `json:"InitCommit,omitempty"` // Represents the isolation technology to use as a default for containers. // The supported values are platform-specific. // // If no isolation value is specified on daemon start, on Windows client, // the default is `hyperv`, and on Windows server, the default is `process`. // // This option is currently not used on other platforms. // // Enum: [default hyperv process] Isolation *string `json:"Isolation,omitempty"` // Indicates if the host has kernel memory limit support enabled. KernelMemory bool `json:"KernelMemory,omitempty"` // Kernel version of the host. // // On Linux, this information obtained from `uname`. On Windows this // information is queried from the <kbd>HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\</kbd> // registry value, for example _"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)"_. // KernelVersion string `json:"KernelVersion,omitempty"` // User-defined labels (key/value metadata) as set on the daemon. // // <p><br /></p> // // > **Note**: When part of a Swarm, nodes can both have _daemon_ labels, // > set through the daemon configuration, and _node_ labels, set from a // > manager node in the Swarm. Node labels are not included in this // > field. Node labels can be retrieved using the `/nodes/(id)` endpoint // > on a manager node in the Swarm. // Labels []string `json:"Labels"` // Indicates if live restore is enabled. // // If enabled, containers are kept running when the daemon is shutdown // or upon daemon start if running containers are detected. // LiveRestoreEnabled *bool `json:"LiveRestoreEnabled,omitempty"` // The logging driver to use as a default for new containers. // LoggingDriver string `json:"LoggingDriver,omitempty"` // Total amount of physical memory available on the host, in kilobytes (kB). // MemTotal int64 `json:"MemTotal,omitempty"` // Indicates if the host has memory limit support enabled. MemoryLimit bool `json:"MemoryLimit,omitempty"` // The number of logical CPUs usable by the daemon. // // The number of available CPUs is checked by querying the operating // system when the daemon starts. Changes to operating system CPU // allocation after the daemon is started are not reflected. // NCPU int64 `json:"NCPU,omitempty"` // Number of event listeners subscribed. NEventsListener int64 `json:"NEventsListener,omitempty"` // The total number of file Descriptors in use by the daemon process. // // This information is only returned if debug-mode is enabled. // NFd int64 `json:"NFd,omitempty"` // The number of goroutines that currently exist. // // This information is only returned if debug-mode is enabled. // NGoroutines int64 `json:"NGoroutines,omitempty"` // Hostname of the host. Name string `json:"Name,omitempty"` // Comma-separated list of domain extensions for which no proxy should be // used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) // environment variable. // // Containers do not automatically inherit this configuration. // NoProxy string `json:"NoProxy,omitempty"` // Generic type of the operating system of the host, as returned by the // Go runtime (`GOOS`). // // Currently returned values are "linux" and "windows". A full list of // possible values can be found in the [Go documentation](https://golang.org/doc/install/source#environment). // OSType string `json:"OSType,omitempty"` // Indicates if OOM killer disable is supported on the host. OomKillDisable bool `json:"OomKillDisable,omitempty"` // Name of the host's operating system, for example: "Ubuntu 16.04.2 LTS" // or "Windows Server 2016 Datacenter" // OperatingSystem string `json:"OperatingSystem,omitempty"` // Indicates if the host kernel has PID limit support enabled. PidsLimit bool `json:"PidsLimit,omitempty"` // plugins Plugins *PluginsInfo `json:"Plugins,omitempty"` // Reports a summary of the product license on the daemon. // // If a commercial license has been applied to the daemon, information // such as number of nodes, and expiration are included. // ProductLicense string `json:"ProductLicense,omitempty"` // registry config RegistryConfig *RegistryServiceConfig `json:"RegistryConfig,omitempty"` // runc commit RuncCommit *Commit `json:"RuncCommit,omitempty"` // List of [OCI compliant](https://github.com/opencontainers/runtime-spec) // runtimes configured on the daemon. Keys hold the "name" used to // reference the runtime. // // The Docker daemon relies on an OCI compliant runtime (invoked via the // `containerd` daemon) as its interface to the Linux kernel namespaces, // cgroups, and SELinux. // // The default runtime is `runc`, and automatically configured. Additional // runtimes can be configured by the user and will be listed here. // Runtimes map[string]Runtime `json:"Runtimes,omitempty"` // List of security features that are enabled on the daemon, such as // apparmor, seccomp, SELinux, and user-namespaces (userns). // // Additional configuration options for each security feature may // be present, and are included as a comma-separated list of key/value // pairs. // SecurityOptions []string `json:"SecurityOptions"` // Version string of the daemon. // // > **Note**: the [standalone Swarm API](https://docs.docker.com/swarm/swarm-api/) // > returns the Swarm version instead of the daemon version, for example // > `swarm/1.2.8`. // ServerVersion string `json:"ServerVersion,omitempty"` // Indicates if the host has memory swap limit support enabled. SwapLimit bool `json:"SwapLimit,omitempty"` // swarm Swarm *SwarmInfo `json:"Swarm,omitempty"` // Status information about this node (standalone Swarm API). // // <p><br /></p> // // > **Note**: The information returned in this field is only propagated // > by the Swarm standalone API, and is empty (`null`) when using // > built-in swarm mode. // SystemStatus [][]string `json:"SystemStatus"` // Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) // format with nano-seconds. // SystemTime string `json:"SystemTime,omitempty"` // List of warnings / informational messages about missing features, or // issues related to the daemon configuration. // // These messages can be printed by the client as information to the user. // Warnings []string `json:"Warnings"` }
SystemInfo system info swagger:model SystemInfo
func (*SystemInfo) MarshalBinary ¶
func (m *SystemInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SystemInfo) UnmarshalBinary ¶
func (m *SystemInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TLSInfo ¶
type TLSInfo struct { // The base64-url-safe-encoded raw public key bytes of the issuer CertIssuerPublicKey string `json:"CertIssuerPublicKey,omitempty"` // The base64-url-safe-encoded raw subject bytes of the issuer CertIssuerSubject string `json:"CertIssuerSubject,omitempty"` // The root CA certificate(s) that are used to validate leaf TLS certificates TrustRoot string `json:"TrustRoot,omitempty"` }
TLSInfo Information about the issuer of leaf TLS certificates and the trusted root CA certificate swagger:model TLSInfo
func (*TLSInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*TLSInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Task ¶
type Task struct { // assigned generic resources AssignedGenericResources GenericResources `json:"AssignedGenericResources,omitempty"` // created at CreatedAt string `json:"CreatedAt,omitempty"` // desired state DesiredState TaskState `json:"DesiredState,omitempty"` // The ID of the task. ID string `json:"ID,omitempty"` // User-defined key/value metadata. Labels map[string]string `json:"Labels,omitempty"` // Name of the task. Name string `json:"Name,omitempty"` // The ID of the node that this task is on. NodeID string `json:"NodeID,omitempty"` // The ID of the service this task is part of. ServiceID string `json:"ServiceID,omitempty"` // slot Slot int64 `json:"Slot,omitempty"` // spec Spec *TaskSpec `json:"Spec,omitempty"` // status Status *TaskStatus `json:"Status,omitempty"` // updated at UpdatedAt string `json:"UpdatedAt,omitempty"` // version Version *ObjectVersion `json:"Version,omitempty"` }
Task task swagger:model Task
func (*Task) MarshalBinary ¶
MarshalBinary interface implementation
func (*Task) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type TaskSpec ¶
type TaskSpec struct { // container spec ContainerSpec *TaskSpecContainerSpec `json:"ContainerSpec,omitempty"` // A counter that triggers an update even if no relevant parameters have been changed. ForceUpdate int64 `json:"ForceUpdate,omitempty"` // log driver LogDriver *TaskSpecLogDriver `json:"LogDriver,omitempty"` // network attachment spec NetworkAttachmentSpec *TaskSpecNetworkAttachmentSpec `json:"NetworkAttachmentSpec,omitempty"` // networks Networks []*TaskSpecNetworksItems0 `json:"Networks"` // placement Placement *TaskSpecPlacement `json:"Placement,omitempty"` // plugin spec PluginSpec *TaskSpecPluginSpec `json:"PluginSpec,omitempty"` // resources Resources *TaskSpecResources `json:"Resources,omitempty"` // restart policy RestartPolicy *TaskSpecRestartPolicy `json:"RestartPolicy,omitempty"` // Runtime is the type of runtime specified for the task executor. Runtime string `json:"Runtime,omitempty"` }
TaskSpec User modifiable task configuration. swagger:model TaskSpec
func (*TaskSpec) MarshalBinary ¶
MarshalBinary interface implementation
func (*TaskSpec) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type TaskSpecContainerSpec ¶
type TaskSpecContainerSpec struct { // Arguments to the command. Args []string `json:"Args"` // The command to be run in the image. Command []string `json:"Command"` // Configs contains references to zero or more configs that will be exposed to the service. Configs []*TaskSpecContainerSpecConfigsItems0 `json:"Configs"` // DNS config DNSConfig *TaskSpecContainerSpecDNSConfig `json:"DNSConfig,omitempty"` // The working directory for commands to run in. Dir string `json:"Dir,omitempty"` // A list of environment variables in the form `VAR=value`. Env []string `json:"Env"` // A list of additional groups that the container process will run as. Groups []string `json:"Groups"` // health check HealthCheck *HealthConfig `json:"HealthCheck,omitempty"` // The hostname to use for the container, as a valid RFC 1123 hostname. Hostname string `json:"Hostname,omitempty"` // A list of hostname/IP mappings to add to the container's `hosts` // file. The format of extra hosts is specified in the // [hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html) // man page: // // IP_address canonical_hostname [aliases...] // Hosts []string `json:"Hosts"` // The image name to use for the container Image string `json:"Image,omitempty"` // Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. Init *bool `json:"Init,omitempty"` // Isolation technology of the containers running the service. (Windows only) // Enum: [default process hyperv] Isolation string `json:"Isolation,omitempty"` // User-defined key/value data. Labels map[string]string `json:"Labels,omitempty"` // Specification for mounts to be added to containers created as part of the service. Mounts []*Mount `json:"Mounts"` // Open `stdin` OpenStdin bool `json:"OpenStdin,omitempty"` // privileges Privileges *TaskSpecContainerSpecPrivileges `json:"Privileges,omitempty"` // Mount the container's root filesystem as read only. ReadOnly bool `json:"ReadOnly,omitempty"` // Secrets contains references to zero or more secrets that will be exposed to the service. Secrets []*TaskSpecContainerSpecSecretsItems0 `json:"Secrets"` // Amount of time to wait for the container to terminate before forcefully killing it. StopGracePeriod int64 `json:"StopGracePeriod,omitempty"` // Signal to stop the container. StopSignal string `json:"StopSignal,omitempty"` // Set kernel namedspaced parameters (sysctls) in the container. // The Sysctls option on services accepts the same sysctls as the // are supported on containers. Note that while the same sysctls are // supported, no guarantees or checks are made about their // suitability for a clustered environment, and it's up to the user // to determine whether a given sysctl will work properly in a // Service. // Sysctls map[string]string `json:"Sysctls,omitempty"` // Whether a pseudo-TTY should be allocated. TTY bool `json:"TTY,omitempty"` // The user inside the container. User string `json:"User,omitempty"` }
TaskSpecContainerSpec Container spec for the service.
<p><br /></p>
> **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime > field is set to `attachment`.
swagger:model TaskSpecContainerSpec
func (*TaskSpecContainerSpec) MarshalBinary ¶
func (m *TaskSpecContainerSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpec) UnmarshalBinary ¶
func (m *TaskSpecContainerSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecConfigsItems0 ¶
type TaskSpecContainerSpecConfigsItems0 struct { // ConfigID represents the ID of the specific config that we're referencing. ConfigID string `json:"ConfigID,omitempty"` // ConfigName is the name of the config that this references, but this is just provided for // lookup/display purposes. The config in the reference will be identified by its ID. // ConfigName string `json:"ConfigName,omitempty"` // file File *TaskSpecContainerSpecConfigsItems0File `json:"File,omitempty"` // Runtime represents a target that is not mounted into the container but is used by the task // // <p><br /><p> // // > **Note**: `Configs.File` and `Configs.Runtime` are mutually exclusive // Runtime interface{} `json:"Runtime,omitempty"` }
TaskSpecContainerSpecConfigsItems0 task spec container spec configs items0 swagger:model TaskSpecContainerSpecConfigsItems0
func (*TaskSpecContainerSpecConfigsItems0) MarshalBinary ¶
func (m *TaskSpecContainerSpecConfigsItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecConfigsItems0) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecConfigsItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecConfigsItems0File ¶
type TaskSpecContainerSpecConfigsItems0File struct { // GID represents the file GID. GID string `json:"GID,omitempty"` // Mode represents the FileMode of the file. Mode uint32 `json:"Mode,omitempty"` // Name represents the final filename in the filesystem. Name string `json:"Name,omitempty"` // UID represents the file UID. UID string `json:"UID,omitempty"` }
TaskSpecContainerSpecConfigsItems0File File represents a specific target that is backed by a file.
<p><br /><p>
> **Note**: `Configs.File` and `Configs.Runtime` are mutually exclusive
swagger:model TaskSpecContainerSpecConfigsItems0File
func (*TaskSpecContainerSpecConfigsItems0File) MarshalBinary ¶
func (m *TaskSpecContainerSpecConfigsItems0File) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecConfigsItems0File) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecConfigsItems0File) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecDNSConfig ¶
type TaskSpecContainerSpecDNSConfig struct { // The IP addresses of the name servers. Nameservers []string `json:"Nameservers"` // A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.). Options []string `json:"Options"` // A search list for host-name lookup. Search []string `json:"Search"` }
TaskSpecContainerSpecDNSConfig Specification for DNS related configurations in resolver configuration file (`resolv.conf`). swagger:model TaskSpecContainerSpecDNSConfig
func (*TaskSpecContainerSpecDNSConfig) MarshalBinary ¶
func (m *TaskSpecContainerSpecDNSConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecDNSConfig) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecDNSConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecPrivileges ¶
type TaskSpecContainerSpecPrivileges struct { // credential spec CredentialSpec *TaskSpecContainerSpecPrivilegesCredentialSpec `json:"CredentialSpec,omitempty"` // s e linux context SELinuxContext *TaskSpecContainerSpecPrivilegesSELinuxContext `json:"SELinuxContext,omitempty"` }
TaskSpecContainerSpecPrivileges Security options for the container swagger:model TaskSpecContainerSpecPrivileges
func (*TaskSpecContainerSpecPrivileges) MarshalBinary ¶
func (m *TaskSpecContainerSpecPrivileges) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecPrivileges) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecPrivileges) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecPrivilegesCredentialSpec ¶
type TaskSpecContainerSpecPrivilegesCredentialSpec struct { // Load credential spec from a Swarm Config with the given ID. // The specified config must also be present in the Configs field with the Runtime property set. // // <p><br /></p> // // // > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, and `CredentialSpec.Config` are mutually exclusive. // Config string `json:"Config,omitempty"` // Load credential spec from this file. The file is read by the daemon, and must be present in the // `CredentialSpecs` subdirectory in the docker data directory, which defaults to // `C:\ProgramData\Docker\` on Windows. // // For example, specifying `spec.json` loads `C:\ProgramData\Docker\CredentialSpecs\spec.json`. // // <p><br /></p> // // > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, and `CredentialSpec.Config` are mutually exclusive. // File string `json:"File,omitempty"` // Load credential spec from this value in the Windows registry. The specified registry value must be // located in: // // `HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Virtualization\Containers\CredentialSpecs` // // <p><br /></p> // // // > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, and `CredentialSpec.Config` are mutually exclusive. // Registry string `json:"Registry,omitempty"` }
TaskSpecContainerSpecPrivilegesCredentialSpec CredentialSpec for managed service account (Windows only) swagger:model TaskSpecContainerSpecPrivilegesCredentialSpec
func (*TaskSpecContainerSpecPrivilegesCredentialSpec) MarshalBinary ¶
func (m *TaskSpecContainerSpecPrivilegesCredentialSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecPrivilegesCredentialSpec) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecPrivilegesCredentialSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecPrivilegesSELinuxContext ¶
type TaskSpecContainerSpecPrivilegesSELinuxContext struct { // Disable SELinux Disable bool `json:"Disable,omitempty"` // SELinux level label Level string `json:"Level,omitempty"` // SELinux role label Role string `json:"Role,omitempty"` // SELinux type label Type string `json:"Type,omitempty"` // SELinux user label User string `json:"User,omitempty"` }
TaskSpecContainerSpecPrivilegesSELinuxContext SELinux labels of the container swagger:model TaskSpecContainerSpecPrivilegesSELinuxContext
func (*TaskSpecContainerSpecPrivilegesSELinuxContext) MarshalBinary ¶
func (m *TaskSpecContainerSpecPrivilegesSELinuxContext) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecPrivilegesSELinuxContext) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecPrivilegesSELinuxContext) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecSecretsItems0 ¶
type TaskSpecContainerSpecSecretsItems0 struct { // file File *TaskSpecContainerSpecSecretsItems0File `json:"File,omitempty"` // SecretID represents the ID of the specific secret that we're referencing. SecretID string `json:"SecretID,omitempty"` // SecretName is the name of the secret that this references, but this is just provided for // lookup/display purposes. The secret in the reference will be identified by its ID. // SecretName string `json:"SecretName,omitempty"` }
TaskSpecContainerSpecSecretsItems0 task spec container spec secrets items0 swagger:model TaskSpecContainerSpecSecretsItems0
func (*TaskSpecContainerSpecSecretsItems0) MarshalBinary ¶
func (m *TaskSpecContainerSpecSecretsItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecSecretsItems0) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecSecretsItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecContainerSpecSecretsItems0File ¶
type TaskSpecContainerSpecSecretsItems0File struct { // GID represents the file GID. GID string `json:"GID,omitempty"` // Mode represents the FileMode of the file. Mode uint32 `json:"Mode,omitempty"` // Name represents the final filename in the filesystem. Name string `json:"Name,omitempty"` // UID represents the file UID. UID string `json:"UID,omitempty"` }
TaskSpecContainerSpecSecretsItems0File File represents a specific target that is backed by a file. swagger:model TaskSpecContainerSpecSecretsItems0File
func (*TaskSpecContainerSpecSecretsItems0File) MarshalBinary ¶
func (m *TaskSpecContainerSpecSecretsItems0File) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecContainerSpecSecretsItems0File) UnmarshalBinary ¶
func (m *TaskSpecContainerSpecSecretsItems0File) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecLogDriver ¶
type TaskSpecLogDriver struct { // name Name string `json:"Name,omitempty"` // options Options map[string]string `json:"Options,omitempty"` }
TaskSpecLogDriver Specifies the log driver to use for tasks created from this spec. If not present, the default one for the swarm will be used, finally falling back to the engine default if not specified. swagger:model TaskSpecLogDriver
func (*TaskSpecLogDriver) MarshalBinary ¶
func (m *TaskSpecLogDriver) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecLogDriver) UnmarshalBinary ¶
func (m *TaskSpecLogDriver) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecNetworkAttachmentSpec ¶
type TaskSpecNetworkAttachmentSpec struct { // ID of the container represented by this task ContainerID string `json:"ContainerID,omitempty"` }
TaskSpecNetworkAttachmentSpec Read-only spec type for non-swarm containers attached to swarm overlay networks.
<p><br /></p>
> **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime > field is set to `attachment`.
swagger:model TaskSpecNetworkAttachmentSpec
func (*TaskSpecNetworkAttachmentSpec) MarshalBinary ¶
func (m *TaskSpecNetworkAttachmentSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecNetworkAttachmentSpec) UnmarshalBinary ¶
func (m *TaskSpecNetworkAttachmentSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecNetworksItems0 ¶
type TaskSpecNetworksItems0 struct { // aliases Aliases []string `json:"Aliases"` // target Target string `json:"Target,omitempty"` }
TaskSpecNetworksItems0 task spec networks items0 swagger:model TaskSpecNetworksItems0
func (*TaskSpecNetworksItems0) MarshalBinary ¶
func (m *TaskSpecNetworksItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecNetworksItems0) UnmarshalBinary ¶
func (m *TaskSpecNetworksItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecPlacement ¶
type TaskSpecPlacement struct { // An array of constraints. Constraints []string `json:"Constraints"` // Maximum number of replicas for per node (default value is 0, which is unlimited) MaxReplicas int64 `json:"MaxReplicas,omitempty"` // Platforms stores all the platforms that the service's image can // run on. This field is used in the platform filter for scheduling. // If empty, then the platform filter is off, meaning there are no // scheduling restrictions. // Platforms []*Platform `json:"Platforms"` // Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence. Preferences []*TaskSpecPlacementPreferencesItems0 `json:"Preferences"` }
TaskSpecPlacement task spec placement swagger:model TaskSpecPlacement
func (*TaskSpecPlacement) MarshalBinary ¶
func (m *TaskSpecPlacement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecPlacement) UnmarshalBinary ¶
func (m *TaskSpecPlacement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecPlacementPreferencesItems0 ¶
type TaskSpecPlacementPreferencesItems0 struct { // spread Spread *TaskSpecPlacementPreferencesItems0Spread `json:"Spread,omitempty"` }
TaskSpecPlacementPreferencesItems0 task spec placement preferences items0 swagger:model TaskSpecPlacementPreferencesItems0
func (*TaskSpecPlacementPreferencesItems0) MarshalBinary ¶
func (m *TaskSpecPlacementPreferencesItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecPlacementPreferencesItems0) UnmarshalBinary ¶
func (m *TaskSpecPlacementPreferencesItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecPlacementPreferencesItems0Spread ¶
type TaskSpecPlacementPreferencesItems0Spread struct { // label descriptor, such as engine.labels.az SpreadDescriptor string `json:"SpreadDescriptor,omitempty"` }
TaskSpecPlacementPreferencesItems0Spread task spec placement preferences items0 spread swagger:model TaskSpecPlacementPreferencesItems0Spread
func (*TaskSpecPlacementPreferencesItems0Spread) MarshalBinary ¶
func (m *TaskSpecPlacementPreferencesItems0Spread) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecPlacementPreferencesItems0Spread) UnmarshalBinary ¶
func (m *TaskSpecPlacementPreferencesItems0Spread) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecPluginSpec ¶
type TaskSpecPluginSpec struct { // Disable the plugin once scheduled. Disabled bool `json:"Disabled,omitempty"` // The name or 'alias' to use for the plugin. Name string `json:"Name,omitempty"` // plugin privilege PluginPrivilege []*TaskSpecPluginSpecPluginPrivilegeItems0 `json:"PluginPrivilege"` // The plugin image reference to use. Remote string `json:"Remote,omitempty"` }
TaskSpecPluginSpec Plugin spec for the service. *(Experimental release only.)*
<p><br /></p>
> **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime > field is set to `attachment`.
swagger:model TaskSpecPluginSpec
func (*TaskSpecPluginSpec) MarshalBinary ¶
func (m *TaskSpecPluginSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecPluginSpec) UnmarshalBinary ¶
func (m *TaskSpecPluginSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecPluginSpecPluginPrivilegeItems0 ¶
type TaskSpecPluginSpecPluginPrivilegeItems0 struct { // description Description string `json:"Description,omitempty"` // name Name string `json:"Name,omitempty"` // value Value []string `json:"Value"` }
TaskSpecPluginSpecPluginPrivilegeItems0 Describes a permission accepted by the user upon installing the plugin. swagger:model TaskSpecPluginSpecPluginPrivilegeItems0
func (*TaskSpecPluginSpecPluginPrivilegeItems0) MarshalBinary ¶
func (m *TaskSpecPluginSpecPluginPrivilegeItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecPluginSpecPluginPrivilegeItems0) UnmarshalBinary ¶
func (m *TaskSpecPluginSpecPluginPrivilegeItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecResources ¶
type TaskSpecResources struct { // Define resources limits. Limits *ResourceObject `json:"Limits,omitempty"` // Define resources reservation. Reservation *ResourceObject `json:"Reservation,omitempty"` }
TaskSpecResources Resource requirements which apply to each individual container created as part of the service. swagger:model TaskSpecResources
func (*TaskSpecResources) MarshalBinary ¶
func (m *TaskSpecResources) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecResources) UnmarshalBinary ¶
func (m *TaskSpecResources) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSpecRestartPolicy ¶
type TaskSpecRestartPolicy struct { // Condition for restart. // Enum: [none on-failure any] Condition string `json:"Condition,omitempty"` // Delay between restart attempts. Delay int64 `json:"Delay,omitempty"` // Maximum attempts to restart a given container before giving up (default value is 0, which is ignored). MaxAttempts int64 `json:"MaxAttempts,omitempty"` // Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded). Window int64 `json:"Window,omitempty"` }
TaskSpecRestartPolicy Specification for the restart policy which applies to containers created as part of this service. swagger:model TaskSpecRestartPolicy
func (*TaskSpecRestartPolicy) MarshalBinary ¶
func (m *TaskSpecRestartPolicy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSpecRestartPolicy) UnmarshalBinary ¶
func (m *TaskSpecRestartPolicy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskState ¶
type TaskState string
TaskState task state swagger:model TaskState
const ( // TaskStateNew captures enum value "new" TaskStateNew TaskState = "new" // TaskStateAllocated captures enum value "allocated" TaskStateAllocated TaskState = "allocated" // TaskStatePending captures enum value "pending" TaskStatePending TaskState = "pending" // TaskStateAssigned captures enum value "assigned" TaskStateAssigned TaskState = "assigned" // TaskStateAccepted captures enum value "accepted" TaskStateAccepted TaskState = "accepted" // TaskStatePreparing captures enum value "preparing" TaskStatePreparing TaskState = "preparing" // TaskStateReady captures enum value "ready" TaskStateReady TaskState = "ready" // TaskStateStarting captures enum value "starting" TaskStateStarting TaskState = "starting" // TaskStateRunning captures enum value "running" TaskStateRunning TaskState = "running" // TaskStateComplete captures enum value "complete" TaskStateComplete TaskState = "complete" // TaskStateShutdown captures enum value "shutdown" TaskStateShutdown TaskState = "shutdown" // TaskStateFailed captures enum value "failed" TaskStateFailed TaskState = "failed" // TaskStateRejected captures enum value "rejected" TaskStateRejected TaskState = "rejected" // TaskStateRemove captures enum value "remove" TaskStateRemove TaskState = "remove" // TaskStateOrphaned captures enum value "orphaned" TaskStateOrphaned TaskState = "orphaned" )
type TaskStatus ¶
type TaskStatus struct { // container status ContainerStatus *TaskStatusContainerStatus `json:"ContainerStatus,omitempty"` // err Err string `json:"Err,omitempty"` // message Message string `json:"Message,omitempty"` // state State TaskState `json:"State,omitempty"` // timestamp Timestamp string `json:"Timestamp,omitempty"` }
TaskStatus task status swagger:model TaskStatus
func (*TaskStatus) MarshalBinary ¶
func (m *TaskStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskStatus) UnmarshalBinary ¶
func (m *TaskStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskStatusContainerStatus ¶
type TaskStatusContainerStatus struct { // container ID ContainerID string `json:"ContainerID,omitempty"` // exit code ExitCode int64 `json:"ExitCode,omitempty"` // p ID PID int64 `json:"PID,omitempty"` }
TaskStatusContainerStatus task status container status swagger:model TaskStatusContainerStatus
func (*TaskStatusContainerStatus) MarshalBinary ¶
func (m *TaskStatusContainerStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskStatusContainerStatus) UnmarshalBinary ¶
func (m *TaskStatusContainerStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ThrottleDevice ¶
type ThrottleDevice struct { // Device path Path string `json:"Path,omitempty"` // Rate // Minimum: 0 Rate *int64 `json:"Rate,omitempty"` }
ThrottleDevice throttle device swagger:model ThrottleDevice
func (*ThrottleDevice) MarshalBinary ¶
func (m *ThrottleDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ThrottleDevice) UnmarshalBinary ¶
func (m *ThrottleDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Volume ¶
type Volume struct { // Date/Time the volume was created. CreatedAt string `json:"CreatedAt,omitempty"` // Name of the volume driver used by the volume. // Required: true Driver string `json:"Driver"` // User-defined key/value metadata. // Required: true Labels map[string]string `json:"Labels"` // Mount path of the volume on the host. // Required: true Mountpoint string `json:"Mountpoint"` // Name of the volume. // Required: true Name string `json:"Name"` // The driver specific options used when creating the volume. // Required: true Options map[string]string `json:"Options"` // The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. // Required: true // Enum: [local global] Scope string `json:"Scope"` // Low-level details about the volume, provided by the volume driver. // Details are returned as a map with key/value pairs: // `{"key":"value","key2":"value2"}`. // // The `Status` field is optional, and is omitted if the volume driver // does not support this feature. // Status map[string]interface{} `json:"Status,omitempty"` // usage data UsageData *VolumeUsageData `json:"UsageData,omitempty"` }
Volume volume swagger:model Volume
func (*Volume) MarshalBinary ¶
MarshalBinary interface implementation
func (*Volume) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type VolumeUsageData ¶
type VolumeUsageData struct { // The number of containers referencing this volume. This field // is set to `-1` if the reference-count is not available. // // Required: true RefCount int64 `json:"RefCount"` // Amount of disk space used by the volume (in bytes). This information // is only available for volumes created with the `"local"` volume // driver. For volumes created with other volume drivers, this field // is set to `-1` ("not available") // // Required: true Size int64 `json:"Size"` }
VolumeUsageData Usage details about the volume. This information is used by the `GET /system/df` endpoint, and omitted in other endpoints.
swagger:model VolumeUsageData
func (*VolumeUsageData) MarshalBinary ¶
func (m *VolumeUsageData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VolumeUsageData) UnmarshalBinary ¶
func (m *VolumeUsageData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files ¶
- address.go
- auth_config.go
- build_cache.go
- build_info.go
- cluster_info.go
- commit.go
- config.go
- config_spec.go
- container_config.go
- container_summary.go
- create_image_info.go
- device_mapping.go
- device_request.go
- driver.go
- endpoint_ip_a_m_config.go
- endpoint_port_config.go
- endpoint_settings.go
- endpoint_spec.go
- engine_description.go
- error_detail.go
- error_response.go
- generic_resources.go
- graph_driver_data.go
- health_config.go
- host_config.go
- id_response.go
- image.go
- image_delete_response_item.go
- image_id.go
- image_summary.go
- index_info.go
- ip_a_m.go
- join_tokens.go
- local_node_state.go
- manager_status.go
- mount.go
- mount_point.go
- network.go
- network_container.go
- network_settings.go
- node.go
- node_description.go
- node_spec.go
- node_state.go
- node_status.go
- object_version.go
- peer_node.go
- platform.go
- plugin.go
- plugin_device.go
- plugin_env.go
- plugin_interface_type.go
- plugin_mount.go
- plugins_info.go
- port.go
- port_binding.go
- port_map.go
- process_config.go
- progress_detail.go
- push_image_info.go
- reachability.go
- registry_service_config.go
- resource_object.go
- resources.go
- restart_policy.go
- runtime.go
- secret.go
- secret_spec.go
- service.go
- service_spec.go
- service_update_response.go
- swarm.go
- swarm_info.go
- swarm_spec.go
- system_info.go
- task.go
- task_spec.go
- task_state.go
- throttle_device.go
- tls_info.go
- volume.go