Documentation
¶
Overview ¶
Package types catalogs github.com/moby/moby/api/types/swarm for wrapping by containerkit.
Code generated by go run ./tools/gencatalog; DO NOT EDIT.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm
Each identifier keeps the exact upstream type name. Domain isolation lives in the import path (internal/engine/swarm/types), not in renamed aliases.
Index ¶
- type Annotations
- type AppArmorMode
- type AppArmorOpts
- type CAConfig
- type ClusterInfo
- type Config
- type ConfigCreateResponse
- type ConfigReference
- type ConfigReferenceFileTarget
- type ConfigReferenceRuntimeTarget
- type ConfigSpec
- type ContainerSpec
- type ContainerStatus
- type CredentialSpec
- type DNSConfig
- type DiscreteGenericResource
- type DispatcherConfig
- type Driver
- type EncryptionConfig
- type Endpoint
- type EndpointSpec
- type EndpointVirtualIP
- type EngineDescription
- type ExternalCA
- type ExternalCAProtocol
- type FailureAction
- type GenericResource
- type GlobalJob
- type GlobalService
- type IPAMConfig
- type IPAMOptions
- type Info
- type InitRequest
- type JobStatus
- type JoinRequest
- type JoinTokens
- type Limit
- type LocalNodeState
- type ManagerStatus
- type Meta
- type NamedGenericResource
- type Network
- type NetworkAttachment
- type NetworkAttachmentConfig
- type NetworkAttachmentSpec
- type NetworkSpec
- type Node
- type NodeAvailability
- type NodeCSIInfo
- type NodeDescription
- type NodeRole
- type NodeSpec
- type NodeState
- type NodeStatus
- type OrchestrationConfig
- type Peer
- type Placement
- type PlacementPreference
- type Platform
- type PluginDescription
- type PortConfig
- type PortConfigPublishMode
- type PortStatus
- type Privileges
- type RaftConfig
- type Reachability
- type RegistryAuthSource
- type ReplicatedJob
- type ReplicatedService
- type ResolutionMode
- type ResourceRequirements
- type Resources
- type RestartPolicy
- type RestartPolicyCondition
- type RuntimePrivilege
- type RuntimeSpec
- type RuntimeType
- type RuntimeURL
- type SELinuxContext
- type SeccompMode
- type SeccompOpts
- type Secret
- type SecretCreateResponse
- type SecretReference
- type SecretReferenceFileTarget
- type SecretSpec
- type Service
- type ServiceCreateResponse
- type ServiceMode
- type ServiceSpec
- type ServiceStatus
- type ServiceUpdateResponse
- type Spec
- type SpreadOver
- type Swarm
- type TLSInfo
- type Task
- type TaskDefaults
- type TaskSpec
- type TaskState
- type TaskStatus
- type Topology
- type UnlockKeyResponse
- type UnlockRequest
- type UpdateConfig
- type UpdateOrder
- type UpdateState
- type UpdateStatus
- type Version
- type VolumeAttachment
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Annotations ¶
type Annotations = swarm.Annotations
Annotations wraps swarm.Annotations.
Annotations represents how to describe an object.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Annotations GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/common.go Kind: struct Usecase: wrap the Engine API type Annotations from swarm.
type AppArmorMode ¶
type AppArmorMode = swarm.AppArmorMode
AppArmorMode wraps swarm.AppArmorMode.
AppArmorMode is type used for the enumeration of possible AppArmor modes in AppArmorOpts
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#AppArmorMode GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/container.go Kind: named:string Underlying: string Usecase: wrap the Engine API type AppArmorMode from swarm.
type AppArmorOpts ¶
type AppArmorOpts = swarm.AppArmorOpts
AppArmorOpts wraps swarm.AppArmorOpts.
AppArmorOpts defines the options for configuring AppArmor on a swarm-managed container. Currently, custom AppArmor profiles are not supported.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#AppArmorOpts GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/container.go Kind: struct Usecase: wrap the Engine API type AppArmorOpts from swarm.
type CAConfig ¶
CAConfig wraps swarm.CAConfig.
CAConfig represents CA configuration.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#CAConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct References: time.Duration Usecase: wrap the Engine API type CAConfig from swarm.
type ClusterInfo ¶
type ClusterInfo = swarm.ClusterInfo
ClusterInfo wraps swarm.ClusterInfo.
ClusterInfo represents info about the cluster for outputting in "info" it contains the same information as "Swarm", but without the JoinTokens
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ClusterInfo GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct References: net/netip.Prefix Usecase: wrap the Engine API type ClusterInfo from swarm.
type Config ¶
Config wraps swarm.Config.
Config represents a config.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Config GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/config.go Kind: struct Usecase: wrap the Engine API type Config from swarm.
type ConfigCreateResponse ¶
type ConfigCreateResponse = swarm.ConfigCreateResponse
ConfigCreateResponse wraps swarm.ConfigCreateResponse.
ConfigCreateResponse contains the information returned to a client on the creation of a new config.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ConfigCreateResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/config.go Kind: struct Usecase: wrap the Engine API type ConfigCreateResponse from swarm.
type ConfigReference ¶
type ConfigReference = swarm.ConfigReference
ConfigReference wraps swarm.ConfigReference.
ConfigReference is a reference to a config in swarm ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ConfigReference GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/config.go Kind: struct Usecase: wrap the Engine API type ConfigReference from swarm.
type ConfigReferenceFileTarget ¶
type ConfigReferenceFileTarget = swarm.ConfigReferenceFileTarget
ConfigReferenceFileTarget wraps swarm.ConfigReferenceFileTarget.
ConfigReferenceFileTarget is a file target in a config reference ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ConfigReferenceFileTarget GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/config.go Kind: struct References: os.FileMode Usecase: wrap the Engine API type ConfigReferenceFileTarget from swarm.
type ConfigReferenceRuntimeTarget ¶
type ConfigReferenceRuntimeTarget = swarm.ConfigReferenceRuntimeTarget
ConfigReferenceRuntimeTarget wraps swarm.ConfigReferenceRuntimeTarget.
ConfigReferenceRuntimeTarget is a target for a config specifying that it isn't mounted into the container but instead has some other purpose.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ConfigReferenceRuntimeTarget GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/config.go Kind: struct Usecase: wrap the Engine API type ConfigReferenceRuntimeTarget from swarm.
type ConfigSpec ¶
type ConfigSpec = swarm.ConfigSpec
ConfigSpec wraps swarm.ConfigSpec.
ConfigSpec represents a config specification from a config in swarm ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ConfigSpec GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/config.go Kind: struct Usecase: wrap the Engine API type ConfigSpec from swarm.
type ContainerSpec ¶
type ContainerSpec = swarm.ContainerSpec
ContainerSpec wraps swarm.ContainerSpec.
ContainerSpec represents the spec of a container.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ContainerSpec GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/container.go Kind: struct References: github.com/moby/moby/api/types/container.HealthConfig, github.com/moby/moby/api/types/container.Isolation, github.com/moby/moby/api/types/container.Ulimit, github.com/moby/moby/api/types/mount.Mount, time.Duration Usecase: wrap the Engine API type ContainerSpec from swarm.
type ContainerStatus ¶
type ContainerStatus = swarm.ContainerStatus
ContainerStatus wraps swarm.ContainerStatus.
ContainerStatus represents the status of a container.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ContainerStatus GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct Usecase: wrap the Engine API type ContainerStatus from swarm.
type CredentialSpec ¶
type CredentialSpec = swarm.CredentialSpec
CredentialSpec wraps swarm.CredentialSpec.
CredentialSpec for managed service account (Windows only)
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#CredentialSpec GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/container.go Kind: struct Usecase: wrap the Engine API type CredentialSpec from swarm.
type DNSConfig ¶
DNSConfig wraps swarm.DNSConfig.
DNSConfig specifies DNS related configurations in resolver configuration file (resolv.conf) Detailed documentation is available in: http://man7.org/linux/man-pages/man5/resolv.conf.5.html `nameserver`, `search`, `options` have been supported. TODO: `domain` is not supported yet.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#DNSConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/container.go Kind: struct References: net/netip.Addr Usecase: wrap the Engine API type DNSConfig from swarm.
type DiscreteGenericResource ¶
type DiscreteGenericResource = swarm.DiscreteGenericResource
DiscreteGenericResource wraps swarm.DiscreteGenericResource.
DiscreteGenericResource represents a "user-defined" resource which is defined as an integer "Kind" is used to describe the Kind of a resource (e.g: "GPU", "FPGA", "SSD", ...) Value is used to count the resource (SSD=5, HDD=3, ...)
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#DiscreteGenericResource GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct Usecase: wrap the Engine API type DiscreteGenericResource from swarm.
type DispatcherConfig ¶
type DispatcherConfig = swarm.DispatcherConfig
DispatcherConfig wraps swarm.DispatcherConfig.
DispatcherConfig represents dispatcher configuration.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#DispatcherConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct References: time.Duration Usecase: wrap the Engine API type DispatcherConfig from swarm.
type Driver ¶
Driver wraps swarm.Driver.
Driver represents a driver (network, logging, secrets backend).
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Driver GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/common.go Kind: struct Usecase: wrap the Engine API type Driver from swarm.
type EncryptionConfig ¶
type EncryptionConfig = swarm.EncryptionConfig
EncryptionConfig wraps swarm.EncryptionConfig.
EncryptionConfig controls at-rest encryption of data and keys.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#EncryptionConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct Usecase: wrap the Engine API type EncryptionConfig from swarm.
type Endpoint ¶
Endpoint wraps swarm.Endpoint.
Endpoint represents an endpoint.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Endpoint GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/network.go Kind: struct Usecase: wrap the Engine API type Endpoint from swarm.
type EndpointSpec ¶
type EndpointSpec = swarm.EndpointSpec
EndpointSpec wraps swarm.EndpointSpec.
EndpointSpec represents the spec of an endpoint.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#EndpointSpec GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/network.go Kind: struct Usecase: wrap the Engine API type EndpointSpec from swarm.
type EndpointVirtualIP ¶
type EndpointVirtualIP = swarm.EndpointVirtualIP
EndpointVirtualIP wraps swarm.EndpointVirtualIP.
EndpointVirtualIP represents the virtual ip of a port.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#EndpointVirtualIP GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/network.go Kind: struct References: net/netip.Prefix Usecase: wrap the Engine API type EndpointVirtualIP from swarm.
type EngineDescription ¶
type EngineDescription = swarm.EngineDescription
EngineDescription wraps swarm.EngineDescription.
EngineDescription represents the description of an engine.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#EngineDescription GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/node.go Kind: struct Usecase: wrap the Engine API type EngineDescription from swarm.
type ExternalCA ¶
type ExternalCA = swarm.ExternalCA
ExternalCA wraps swarm.ExternalCA.
ExternalCA defines external CA to be used by the cluster.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ExternalCA GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct Usecase: wrap the Engine API type ExternalCA from swarm.
type ExternalCAProtocol ¶
type ExternalCAProtocol = swarm.ExternalCAProtocol
ExternalCAProtocol wraps swarm.ExternalCAProtocol.
ExternalCAProtocol represents type of external CA.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ExternalCAProtocol GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: named:string Underlying: string Usecase: wrap the Engine API type ExternalCAProtocol from swarm.
type FailureAction ¶
type FailureAction = swarm.FailureAction
FailureAction wraps swarm.FailureAction.
FailureAction is the action to perform when updating a service fails.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#FailureAction GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service.go Kind: named:string Underlying: string Usecase: wrap the Engine API type FailureAction from swarm.
type GenericResource ¶
type GenericResource = swarm.GenericResource
GenericResource wraps swarm.GenericResource.
GenericResource represents a "user-defined" resource which can be either an integer (e.g: SSD=3) or a string (e.g: SSD=sda1)
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#GenericResource GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct Usecase: wrap the Engine API type GenericResource from swarm.
type GlobalJob ¶
GlobalJob wraps swarm.GlobalJob.
GlobalJob is the type of a Service which executes a Task on every Node matching the Service's placement constraints. These tasks run to completion and then exit.
This type is deliberately empty.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#GlobalJob GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service.go Kind: struct Usecase: wrap the Engine API type GlobalJob from swarm.
type GlobalService ¶
type GlobalService = swarm.GlobalService
GlobalService wraps swarm.GlobalService.
GlobalService is a kind of ServiceMode.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#GlobalService GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service.go Kind: struct Usecase: wrap the Engine API type GlobalService from swarm.
type IPAMConfig ¶
type IPAMConfig = swarm.IPAMConfig
IPAMConfig wraps swarm.IPAMConfig.
IPAMConfig represents ipam configuration.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#IPAMConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/network.go Kind: struct References: net/netip.Addr, net/netip.Prefix Usecase: wrap the Engine API type IPAMConfig from swarm.
type IPAMOptions ¶
type IPAMOptions = swarm.IPAMOptions
IPAMOptions wraps swarm.IPAMOptions.
IPAMOptions represents ipam options.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#IPAMOptions GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/network.go Kind: struct Usecase: wrap the Engine API type IPAMOptions from swarm.
type Info ¶
Info wraps swarm.Info.
Info represents generic information about swarm.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Info GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct Usecase: wrap the Engine API type Info from swarm.
type InitRequest ¶
type InitRequest = swarm.InitRequest
InitRequest wraps swarm.InitRequest.
InitRequest is the request used to init a swarm.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#InitRequest GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct References: net/netip.Prefix Usecase: wrap the Engine API type InitRequest from swarm.
type JobStatus ¶
JobStatus wraps swarm.JobStatus.
JobStatus is the status of a job-type service.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#JobStatus GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service.go Kind: struct References: time.Time Usecase: wrap the Engine API type JobStatus from swarm.
type JoinRequest ¶
type JoinRequest = swarm.JoinRequest
JoinRequest wraps swarm.JoinRequest.
JoinRequest is the request used to join a swarm.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#JoinRequest GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct Usecase: wrap the Engine API type JoinRequest from swarm.
type JoinTokens ¶
type JoinTokens = swarm.JoinTokens
JoinTokens wraps swarm.JoinTokens.
JoinTokens contains the tokens workers and managers need to join the swarm.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#JoinTokens GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct Usecase: wrap the Engine API type JoinTokens from swarm.
type Limit ¶
Limit wraps swarm.Limit.
Limit describes limits on resources which can be requested by a task.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Limit GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct Usecase: wrap the Engine API type Limit from swarm.
type LocalNodeState ¶
type LocalNodeState = swarm.LocalNodeState
LocalNodeState wraps swarm.LocalNodeState.
LocalNodeState represents the state of the local node.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#LocalNodeState GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: named:string Underlying: string Usecase: wrap the Engine API type LocalNodeState from swarm.
type ManagerStatus ¶
type ManagerStatus = swarm.ManagerStatus
ManagerStatus wraps swarm.ManagerStatus.
ManagerStatus represents the status of a manager.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ManagerStatus GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/node.go Kind: struct Usecase: wrap the Engine API type ManagerStatus from swarm.
type Meta ¶
Meta wraps swarm.Meta.
Meta is a base object inherited by most of the other once.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Meta GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/common.go Kind: struct References: time.Time Usecase: wrap the Engine API type Meta from swarm.
type NamedGenericResource ¶
type NamedGenericResource = swarm.NamedGenericResource
NamedGenericResource wraps swarm.NamedGenericResource.
NamedGenericResource represents a "user-defined" resource which is defined as a string. "Kind" is used to describe the Kind of a resource (e.g: "GPU", "FPGA", "SSD", ...) Value is used to identify the resource (GPU="UUID-1", FPGA="/dev/sdb5", ...)
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#NamedGenericResource GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct Usecase: wrap the Engine API type NamedGenericResource from swarm.
type Network ¶
Network wraps swarm.Network.
Network represents a network.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Network GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/network.go Kind: struct Usecase: wrap the Engine API type Network from swarm.
type NetworkAttachment ¶
type NetworkAttachment = swarm.NetworkAttachment
NetworkAttachment wraps swarm.NetworkAttachment.
NetworkAttachment represents a network attachment.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#NetworkAttachment GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/network.go Kind: struct References: net/netip.Prefix Usecase: wrap the Engine API type NetworkAttachment from swarm.
type NetworkAttachmentConfig ¶
type NetworkAttachmentConfig = swarm.NetworkAttachmentConfig
NetworkAttachmentConfig wraps swarm.NetworkAttachmentConfig.
NetworkAttachmentConfig represents the configuration of a network attachment.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#NetworkAttachmentConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/network.go Kind: struct Usecase: wrap the Engine API type NetworkAttachmentConfig from swarm.
type NetworkAttachmentSpec ¶
type NetworkAttachmentSpec = swarm.NetworkAttachmentSpec
NetworkAttachmentSpec wraps swarm.NetworkAttachmentSpec.
NetworkAttachmentSpec represents the runtime spec type for network attachment tasks
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#NetworkAttachmentSpec GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/runtime.go Kind: struct Usecase: wrap the Engine API type NetworkAttachmentSpec from swarm.
type NetworkSpec ¶
type NetworkSpec = swarm.NetworkSpec
NetworkSpec wraps swarm.NetworkSpec.
NetworkSpec represents the spec of a network.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#NetworkSpec GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/network.go Kind: struct References: github.com/moby/moby/api/types/network.ConfigReference Usecase: wrap the Engine API type NetworkSpec from swarm.
type Node ¶
Node wraps swarm.Node.
Node represents a node.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Node GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/node.go Kind: struct Usecase: wrap the Engine API type Node from swarm.
type NodeAvailability ¶
type NodeAvailability = swarm.NodeAvailability
NodeAvailability wraps swarm.NodeAvailability.
NodeAvailability represents the availability of a node.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#NodeAvailability GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/node.go Kind: named:string Underlying: string Usecase: wrap the Engine API type NodeAvailability from swarm.
type NodeCSIInfo ¶
type NodeCSIInfo = swarm.NodeCSIInfo
NodeCSIInfo wraps swarm.NodeCSIInfo.
NodeCSIInfo represents information about a CSI plugin available on the node ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#NodeCSIInfo GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/node.go Kind: struct Usecase: wrap the Engine API type NodeCSIInfo from swarm.
type NodeDescription ¶
type NodeDescription = swarm.NodeDescription
NodeDescription wraps swarm.NodeDescription.
NodeDescription represents the description of a node.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#NodeDescription GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/node.go Kind: struct Usecase: wrap the Engine API type NodeDescription from swarm.
type NodeRole ¶
NodeRole wraps swarm.NodeRole.
NodeRole represents the role of a node.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#NodeRole GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/node.go Kind: named:string Underlying: string Usecase: wrap the Engine API type NodeRole from swarm.
type NodeSpec ¶
NodeSpec wraps swarm.NodeSpec.
NodeSpec represents the spec of a node.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#NodeSpec GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/node.go Kind: struct Usecase: wrap the Engine API type NodeSpec from swarm.
type NodeState ¶
NodeState wraps swarm.NodeState.
NodeState represents the state of a node.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#NodeState GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/node.go Kind: named:string Underlying: string Usecase: wrap the Engine API type NodeState from swarm.
type NodeStatus ¶
type NodeStatus = swarm.NodeStatus
NodeStatus wraps swarm.NodeStatus.
NodeStatus represents the status of a node.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#NodeStatus GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/node.go Kind: struct Usecase: wrap the Engine API type NodeStatus from swarm.
type OrchestrationConfig ¶
type OrchestrationConfig = swarm.OrchestrationConfig
OrchestrationConfig wraps swarm.OrchestrationConfig.
OrchestrationConfig represents orchestration configuration.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#OrchestrationConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct Usecase: wrap the Engine API type OrchestrationConfig from swarm.
type Peer ¶
Peer wraps swarm.Peer.
Peer represents a peer.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Peer GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct Usecase: wrap the Engine API type Peer from swarm.
type Placement ¶
Placement wraps swarm.Placement.
Placement represents orchestration parameters.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Placement GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct Usecase: wrap the Engine API type Placement from swarm.
type PlacementPreference ¶
type PlacementPreference = swarm.PlacementPreference
PlacementPreference wraps swarm.PlacementPreference.
PlacementPreference provides a way to make the scheduler aware of factors such as topology.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#PlacementPreference GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct Usecase: wrap the Engine API type PlacementPreference from swarm.
type Platform ¶
Platform wraps swarm.Platform.
Platform represents the platform (Arch/OS).
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Platform GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/node.go Kind: struct Usecase: wrap the Engine API type Platform from swarm.
type PluginDescription ¶
type PluginDescription = swarm.PluginDescription
PluginDescription wraps swarm.PluginDescription.
PluginDescription represents the description of an engine plugin.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#PluginDescription GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/node.go Kind: struct Usecase: wrap the Engine API type PluginDescription from swarm.
type PortConfig ¶
type PortConfig = swarm.PortConfig
PortConfig wraps swarm.PortConfig.
PortConfig represents the config of a port.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#PortConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/network.go Kind: struct References: github.com/moby/moby/api/types/network.IPProtocol Usecase: wrap the Engine API type PortConfig from swarm.
type PortConfigPublishMode ¶
type PortConfigPublishMode = swarm.PortConfigPublishMode
PortConfigPublishMode wraps swarm.PortConfigPublishMode.
PortConfigPublishMode represents the mode in which the port is to be published.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#PortConfigPublishMode GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/network.go Kind: named:string Underlying: string Usecase: wrap the Engine API type PortConfigPublishMode from swarm.
type PortStatus ¶
type PortStatus = swarm.PortStatus
PortStatus wraps swarm.PortStatus.
PortStatus represents the port status of a task's host ports whose service has published host ports
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#PortStatus GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct Usecase: wrap the Engine API type PortStatus from swarm.
type Privileges ¶
type Privileges = swarm.Privileges
Privileges wraps swarm.Privileges.
Privileges defines the security options for the container.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Privileges GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/container.go Kind: struct Usecase: wrap the Engine API type Privileges from swarm.
type RaftConfig ¶
type RaftConfig = swarm.RaftConfig
RaftConfig wraps swarm.RaftConfig.
RaftConfig represents raft configuration.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#RaftConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct Usecase: wrap the Engine API type RaftConfig from swarm.
type Reachability ¶
type Reachability = swarm.Reachability
Reachability wraps swarm.Reachability.
Reachability represents the reachability of a node.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Reachability GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/node.go Kind: named:string Underlying: string Usecase: wrap the Engine API type Reachability from swarm.
type RegistryAuthSource ¶
type RegistryAuthSource = swarm.RegistryAuthSource
RegistryAuthSource wraps swarm.RegistryAuthSource.
RegistryAuthSource defines options for the "registryAuthFrom" query parameter on service update.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#RegistryAuthSource GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service.go Kind: named:string Underlying: string Usecase: wrap the Engine API type RegistryAuthSource from swarm.
type ReplicatedJob ¶
type ReplicatedJob = swarm.ReplicatedJob
ReplicatedJob wraps swarm.ReplicatedJob.
ReplicatedJob is the a type of Service which executes a defined Tasks in parallel until the specified number of Tasks have succeeded.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ReplicatedJob GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service.go Kind: struct Usecase: wrap the Engine API type ReplicatedJob from swarm.
type ReplicatedService ¶
type ReplicatedService = swarm.ReplicatedService
ReplicatedService wraps swarm.ReplicatedService.
ReplicatedService is a kind of ServiceMode.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ReplicatedService GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service.go Kind: struct Usecase: wrap the Engine API type ReplicatedService from swarm.
type ResolutionMode ¶
type ResolutionMode = swarm.ResolutionMode
ResolutionMode wraps swarm.ResolutionMode.
ResolutionMode represents a resolution mode.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ResolutionMode GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/network.go Kind: named:string Underlying: string Usecase: wrap the Engine API type ResolutionMode from swarm.
type ResourceRequirements ¶
type ResourceRequirements = swarm.ResourceRequirements
ResourceRequirements wraps swarm.ResourceRequirements.
ResourceRequirements represents resources requirements.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ResourceRequirements GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct Usecase: wrap the Engine API type ResourceRequirements from swarm.
type Resources ¶
Resources wraps swarm.Resources.
Resources represents resources (CPU/Memory) which can be advertised by a node and requested to be reserved for a task.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Resources GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct Usecase: wrap the Engine API type Resources from swarm.
type RestartPolicy ¶
type RestartPolicy = swarm.RestartPolicy
RestartPolicy wraps swarm.RestartPolicy.
RestartPolicy represents the restart policy.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#RestartPolicy GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct References: time.Duration Usecase: wrap the Engine API type RestartPolicy from swarm.
type RestartPolicyCondition ¶
type RestartPolicyCondition = swarm.RestartPolicyCondition
RestartPolicyCondition wraps swarm.RestartPolicyCondition.
RestartPolicyCondition represents when to restart.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#RestartPolicyCondition GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: named:string Underlying: string Usecase: wrap the Engine API type RestartPolicyCondition from swarm.
type RuntimePrivilege ¶
type RuntimePrivilege = swarm.RuntimePrivilege
RuntimePrivilege wraps swarm.RuntimePrivilege.
RuntimePrivilege describes a permission the user has to accept upon installing a plugin.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#RuntimePrivilege GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/runtime.go Kind: struct Usecase: wrap the Engine API type RuntimePrivilege from swarm.
type RuntimeSpec ¶
type RuntimeSpec = swarm.RuntimeSpec
RuntimeSpec wraps swarm.RuntimeSpec.
RuntimeSpec defines the base payload which clients can specify for creating a service with the plugin runtime.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#RuntimeSpec GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/runtime.go Kind: struct Usecase: wrap the Engine API type RuntimeSpec from swarm.
type RuntimeType ¶
type RuntimeType = swarm.RuntimeType
RuntimeType wraps swarm.RuntimeType.
RuntimeType is the type of runtime used for the TaskSpec ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#RuntimeType GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/runtime.go Kind: named:string Underlying: string Usecase: wrap the Engine API type RuntimeType from swarm.
type RuntimeURL ¶
type RuntimeURL = swarm.RuntimeURL
RuntimeURL wraps swarm.RuntimeURL.
RuntimeURL is the proto type url ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#RuntimeURL GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/runtime.go Kind: named:string Underlying: string Usecase: wrap the Engine API type RuntimeURL from swarm.
type SELinuxContext ¶
type SELinuxContext = swarm.SELinuxContext
SELinuxContext wraps swarm.SELinuxContext.
SELinuxContext contains the SELinux labels of the container.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#SELinuxContext GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/container.go Kind: struct Usecase: wrap the Engine API type SELinuxContext from swarm.
type SeccompMode ¶
type SeccompMode = swarm.SeccompMode
SeccompMode wraps swarm.SeccompMode.
SeccompMode is the type used for the enumeration of possible seccomp modes in SeccompOpts
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#SeccompMode GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/container.go Kind: named:string Underlying: string Usecase: wrap the Engine API type SeccompMode from swarm.
type SeccompOpts ¶
type SeccompOpts = swarm.SeccompOpts
SeccompOpts wraps swarm.SeccompOpts.
SeccompOpts defines the options for configuring seccomp on a swarm-managed container.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#SeccompOpts GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/container.go Kind: struct Usecase: wrap the Engine API type SeccompOpts from swarm.
type Secret ¶
Secret wraps swarm.Secret.
Secret represents a secret.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Secret GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/secret.go Kind: struct Usecase: wrap the Engine API type Secret from swarm.
type SecretCreateResponse ¶
type SecretCreateResponse = swarm.SecretCreateResponse
SecretCreateResponse wraps swarm.SecretCreateResponse.
SecretCreateResponse contains the information returned to a client on the creation of a new secret.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#SecretCreateResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/secret.go Kind: struct Usecase: wrap the Engine API type SecretCreateResponse from swarm.
type SecretReference ¶
type SecretReference = swarm.SecretReference
SecretReference wraps swarm.SecretReference.
SecretReference is a reference to a secret in swarm ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#SecretReference GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/secret.go Kind: struct Usecase: wrap the Engine API type SecretReference from swarm.
type SecretReferenceFileTarget ¶
type SecretReferenceFileTarget = swarm.SecretReferenceFileTarget
SecretReferenceFileTarget wraps swarm.SecretReferenceFileTarget.
SecretReferenceFileTarget is a file target in a secret reference ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#SecretReferenceFileTarget GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/secret.go Kind: struct References: os.FileMode Usecase: wrap the Engine API type SecretReferenceFileTarget from swarm.
type SecretSpec ¶
type SecretSpec = swarm.SecretSpec
SecretSpec wraps swarm.SecretSpec.
SecretSpec represents a secret specification from a secret in swarm ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#SecretSpec GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/secret.go Kind: struct Usecase: wrap the Engine API type SecretSpec from swarm.
type Service ¶
Service wraps swarm.Service.
Service represents a service.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Service GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service.go Kind: struct Usecase: wrap the Engine API type Service from swarm.
type ServiceCreateResponse ¶
type ServiceCreateResponse = swarm.ServiceCreateResponse
ServiceCreateResponse wraps swarm.ServiceCreateResponse.
ServiceCreateResponse contains the information returned to a client on the creation of a new service.
swagger:model ServiceCreateResponse
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ServiceCreateResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service_create_response.go Kind: struct Usecase: wrap the Engine API type ServiceCreateResponse from swarm.
type ServiceMode ¶
type ServiceMode = swarm.ServiceMode
ServiceMode wraps swarm.ServiceMode.
ServiceMode represents the mode of a service.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ServiceMode GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service.go Kind: struct Usecase: wrap the Engine API type ServiceMode from swarm.
type ServiceSpec ¶
type ServiceSpec = swarm.ServiceSpec
ServiceSpec wraps swarm.ServiceSpec.
ServiceSpec represents the spec of a service.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ServiceSpec GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service.go Kind: struct Usecase: wrap the Engine API type ServiceSpec from swarm.
type ServiceStatus ¶
type ServiceStatus = swarm.ServiceStatus
ServiceStatus wraps swarm.ServiceStatus.
ServiceStatus represents the number of running tasks in a service and the number of tasks desired to be running.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ServiceStatus GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service.go Kind: struct Usecase: wrap the Engine API type ServiceStatus from swarm.
type ServiceUpdateResponse ¶
type ServiceUpdateResponse = swarm.ServiceUpdateResponse
ServiceUpdateResponse wraps swarm.ServiceUpdateResponse.
ServiceUpdateResponse service update response Example: {"Warnings":["unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found"]}
swagger:model ServiceUpdateResponse
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#ServiceUpdateResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service_update_response.go Kind: struct Usecase: wrap the Engine API type ServiceUpdateResponse from swarm.
type Spec ¶
Spec wraps swarm.Spec.
Spec represents the spec of a swarm.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Spec GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct Usecase: wrap the Engine API type Spec from swarm.
type SpreadOver ¶
type SpreadOver = swarm.SpreadOver
SpreadOver wraps swarm.SpreadOver.
SpreadOver is a scheduling preference that instructs the scheduler to spread tasks evenly over groups of nodes identified by labels.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#SpreadOver GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct Usecase: wrap the Engine API type SpreadOver from swarm.
type Swarm ¶
Swarm wraps swarm.Swarm.
Swarm represents a swarm.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Swarm GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct Usecase: wrap the Engine API type Swarm from swarm.
type TLSInfo ¶
TLSInfo wraps swarm.TLSInfo.
TLSInfo represents the TLS information about what CA certificate is trusted, and who the issuer for a TLS certificate is
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#TLSInfo GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/common.go Kind: struct Usecase: wrap the Engine API type TLSInfo from swarm.
type Task ¶
Task wraps swarm.Task.
Task represents a task.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Task GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct Usecase: wrap the Engine API type Task from swarm.
type TaskDefaults ¶
type TaskDefaults = swarm.TaskDefaults
TaskDefaults wraps swarm.TaskDefaults.
TaskDefaults parameterizes cluster-level task creation with default values.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#TaskDefaults GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct Usecase: wrap the Engine API type TaskDefaults from swarm.
type TaskSpec ¶
TaskSpec wraps swarm.TaskSpec.
TaskSpec represents the spec of a task.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#TaskSpec GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct Usecase: wrap the Engine API type TaskSpec from swarm.
type TaskState ¶
TaskState wraps swarm.TaskState.
TaskState represents the state of a task.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#TaskState GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: named:string Underlying: string Usecase: wrap the Engine API type TaskState from swarm.
type TaskStatus ¶
type TaskStatus = swarm.TaskStatus
TaskStatus wraps swarm.TaskStatus.
TaskStatus represents the status of a task.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#TaskStatus GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct References: time.Time Usecase: wrap the Engine API type TaskStatus from swarm.
type Topology ¶
Topology wraps swarm.Topology.
Topology defines the CSI topology of this node. This type is a duplicate of github.com/moby/moby/api/types/volume.Topology. Because the type definition is so simple and to avoid complicated structure or circular imports, we just duplicate it here. See that type for full documentation
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Topology GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/node.go Kind: struct Usecase: wrap the Engine API type Topology from swarm.
type UnlockKeyResponse ¶
type UnlockKeyResponse = swarm.UnlockKeyResponse
UnlockKeyResponse wraps swarm.UnlockKeyResponse.
UnlockKeyResponse contains the response for Engine API: GET /swarm/unlockkey
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#UnlockKeyResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct Usecase: wrap the Engine API type UnlockKeyResponse from swarm.
type UnlockRequest ¶
type UnlockRequest = swarm.UnlockRequest
UnlockRequest wraps swarm.UnlockRequest.
UnlockRequest is the request used to unlock a swarm.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#UnlockRequest GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/swarm.go Kind: struct Usecase: wrap the Engine API type UnlockRequest from swarm.
type UpdateConfig ¶
type UpdateConfig = swarm.UpdateConfig
UpdateConfig wraps swarm.UpdateConfig.
UpdateConfig represents the update configuration.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#UpdateConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service.go Kind: struct References: time.Duration Usecase: wrap the Engine API type UpdateConfig from swarm.
type UpdateOrder ¶
type UpdateOrder = swarm.UpdateOrder
UpdateOrder wraps swarm.UpdateOrder.
UpdateOrder is the order of operations when rolling out or rolling back an updated tasks for a service.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#UpdateOrder GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service.go Kind: named:string Underlying: string Usecase: wrap the Engine API type UpdateOrder from swarm.
type UpdateState ¶
type UpdateState = swarm.UpdateState
UpdateState wraps swarm.UpdateState.
UpdateState is the state of a service update.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#UpdateState GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service.go Kind: named:string Underlying: string Usecase: wrap the Engine API type UpdateState from swarm.
type UpdateStatus ¶
type UpdateStatus = swarm.UpdateStatus
UpdateStatus wraps swarm.UpdateStatus.
UpdateStatus reports the status of a service update.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#UpdateStatus GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/service.go Kind: struct References: time.Time Usecase: wrap the Engine API type UpdateStatus from swarm.
type Version ¶
Version wraps swarm.Version.
Version represents the internal object version.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#Version GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/common.go Kind: struct Usecase: wrap the Engine API type Version from swarm.
type VolumeAttachment ¶
type VolumeAttachment = swarm.VolumeAttachment
VolumeAttachment wraps swarm.VolumeAttachment.
VolumeAttachment contains the associating a Volume to a Task.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/swarm#VolumeAttachment GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/swarm/task.go Kind: struct Usecase: wrap the Engine API type VolumeAttachment from swarm.