package
0.4.0
Repository: https://github.com/docker/engine-api.git
Documentation: pkg.go.dev

# Constants

ExternalCAProtocolCFSSL CFSSL.
LocalNodeStateActive ACTIVE.
LocalNodeStateError ERROR.
LocalNodeStateInactive INACTIVE.
LocalNodeStatePending PENDING.
MountPropagationPrivate PRIVATE.
MountPropagationRPrivate RPRIVATE.
MountPropagationRShared RSHARED.
MountPropagationRSlave RSLAVE.
MountPropagationShared SHARED.
MountPropagationSlave SLAVE.
MountTypeBind BIND.
MountTypeVolume VOLUME.
NodeAvailabilityActive ACTIVE.
NodeAvailabilityDrain DRAIN.
NodeAvailabilityPause PAUSE.
NodeRoleManager MANAGER.
NodeRoleWorker WORKER.
NodeStateDisconnected DISCONNECTED.
NodeStateDown DOWN.
NodeStateReady READY.
NodeStateUnknown UNKNOWN.
PortConfigProtocolTCP TCP.
PortConfigProtocolUDP UDP.
ReachabilityReachable REACHABLE.
ReachabilityUnknown UNKNOWN.
ReachabilityUnreachable UNREACHABLE.
ResolutionModeDNSRR DNSRR.
ResolutionModeVIP VIP.
RestartPolicyConditionAny ANY.
RestartPolicyConditionNone NONE.
RestartPolicyConditionOnFailure ON_FAILURE.
TaskStateAccepted ACCEPTED.
TaskStateAllocated ALLOCATED.
TaskStateAssigned ASSIGNED.
TaskStateComplete COMPLETE.
TaskStateFailed FAILED.
TaskStateNew NEW.
TaskStatePending PENDING.
TaskStatePreparing PREPARING.
TaskStateReady READY.
TaskStateRejected REJECTED.
TaskStateRunning RUNNING.
TaskStateShutdown SHUTDOWN.
TaskStateStarting STARTING.
UpdateFailureActionContinue CONTINUE.
UpdateFailureActionPause PAUSE.
UpdateStateCompleted is the completed state.
UpdateStatePaused is the paused state.
UpdateStateUpdating is the updating state.

# Structs

Annotations represents how to describe an object.
BindOptions defines options specific to mounts of type "bind".
CAConfig represents CA configuration.
ClusterInfo represents info about a the cluster for outputing in "info" it contains the same information as "Swarm", but without the JoinTokens.
ContainerSpec represents the spec of a container.
ContainerStatus represents the status of a container.
DispatcherConfig represents dispatcher configuration.
Driver represents a driver (network/volume).
Endpoint represents an endpoint.
EndpointSpec represents the spec of an endpoint.
EndpointVirtualIP represents the virtual ip of a port.
EngineDescription represents the description of an engine.
ExternalCA defines external CA to be used by the cluster.
GlobalService is a kind of ServiceMode.
Info represents generic information about swarm.
InitRequest is the request used to init a swarm.
IPAMConfig represents ipam configuration.
IPAMOptions represents ipam options.
JoinRequest is the request used to join a swarm.
JoinTokens contains the tokens workers and managers need to join the swarm.
ManagerStatus represents the status of a manager.
Meta is base object inherited by most of the other once.
Mount represents a mount (volume).
Network represents a network.
NetworkAttachment represents a network attachment.
NetworkAttachmentConfig represents the configuration of a network attachment.
NetworkSpec represents the spec of a network.
Node represents a node.
NodeDescription represents the description of a node.
NodeSpec represents the spec of a node.
NodeStatus represents the status of a node.
OrchestrationConfig represents orchestration configuration.
Peer represents a peer.
Placement represents orchestration parameters.
Platform represents the platfrom (Arch/OS).
PluginDescription represents the description of an engine plugin.
PortConfig represents the config of a port.
RaftConfig represents raft configuration.
ReplicatedService is a kind of ServiceMode.
ResourceRequirements represents resources requirements.
Resources represents resources (CPU/Memory).
RestartPolicy represents the restart policy.
Service represents a service.
ServiceMode represents the mode of a service.
ServiceSpec represents the spec of a service.
Spec represents the spec of a swarm.
Swarm represents a swarm.
Task represents a task.
TaskDefaults parameterizes cluster-level task creation with default values.
TaskSpec represents the spec of a task.
TaskStatus represents the status of a task.
UpdateConfig represents the update configuration.
UpdateFlags contains flags for SwarmUpdate.
UpdateStatus reports the status of a service update.
Version represent the internal object version.
VolumeOptions represents the options for a mount of type volume.

# Type aliases

ExternalCAProtocol represents type of external CA.
LocalNodeState represents the state of the local node.
MountPropagation represents the propagation of a mount.
MountType represents the type of a mount.
NodeAvailability represents the availability of a node.
NodeRole represents the role of a node.
NodeState represents the state of a node.
PortConfigProtocol represents the protocol of a port.
Reachability represents the reachability of a node.
ResolutionMode represents a resolution mode.
RestartPolicyCondition represents when to restart.
TaskState represents the state of a task.
UpdateState is the state of a service update.