package
17.12.1-ce-rc2+incompatible
Repository: https://github.com/docker-archive/engine.git
Documentation: pkg.go.dev
# Packages
Package runtime is a generated protocol buffer package.
# Constants
ExternalCAProtocolCFSSL CFSSL.
LocalNodeStateActive ACTIVE.
LocalNodeStateError ERROR.
LocalNodeStateInactive INACTIVE.
LocalNodeStateLocked LOCKED.
LocalNodeStatePending PENDING.
NodeAvailabilityActive ACTIVE.
NodeAvailabilityDrain DRAIN.
NodeAvailabilityPause PAUSE.
NodeRoleManager MANAGER.
NodeRoleWorker WORKER.
NodeStateDisconnected DISCONNECTED.
NodeStateDown DOWN.
NodeStateReady READY.
NodeStateUnknown UNKNOWN.
PortConfigProtocolTCP TCP.
PortConfigProtocolUDP UDP.
PortConfigPublishModeHost is used for ports published for direct host level access on the host where the task is running.
PortConfigPublishModeIngress is used for ports published for ingress load balancing using routing mesh.
ReachabilityReachable REACHABLE.
ReachabilityUnknown UNKNOWN.
ReachabilityUnreachable UNREACHABLE.
ResolutionModeDNSRR DNSRR.
ResolutionModeVIP VIP.
RestartPolicyConditionAny ANY.
RestartPolicyConditionNone NONE.
RestartPolicyConditionOnFailure ON_FAILURE.
RuntimeContainer is the container based runtime.
RuntimePlugin is the plugin based runtime.
RuntimeURLContainer is the proto url for the container type.
RuntimeURLPlugin is the proto url for the plugin type.
TaskStateAccepted ACCEPTED.
TaskStateAllocated ALLOCATED.
TaskStateAssigned ASSIGNED.
TaskStateComplete COMPLETE.
TaskStateFailed FAILED.
TaskStateNew NEW.
TaskStateOrphaned ORPHANED.
TaskStatePending PENDING.
TaskStatePreparing PREPARING.
TaskStateReady READY.
TaskStateRejected REJECTED.
TaskStateRemove REMOVE.
TaskStateRunning RUNNING.
TaskStateShutdown SHUTDOWN.
TaskStateStarting STARTING.
UpdateFailureActionContinue CONTINUE.
UpdateFailureActionPause PAUSE.
UpdateFailureActionRollback ROLLBACK.
UpdateOrderStartFirst START_FIRST.
UpdateOrderStopFirst STOP_FIRST.
UpdateStateCompleted is the completed state.
UpdateStatePaused is the paused state.
UpdateStateRollbackCompleted is the state with a rollback in progress.
UpdateStateRollbackPaused is the state with a rollback in progress.
UpdateStateRollbackStarted is the state with a rollback in progress.
UpdateStateUpdating is the updating state.
# Structs
Annotations represents how to describe an object.
CAConfig represents CA configuration.
ClusterInfo represents info about the cluster for outputting in "info" it contains the same information as "Swarm", but without the JoinTokens.
Config represents a config.
ConfigReference is a reference to a config in swarm.
ConfigReferenceFileTarget is a file target in a config reference.
ConfigSpec represents a config specification from a config in swarm.
ContainerSpec represents the spec of a container.
ContainerStatus represents the status of a container.
CredentialSpec for managed service account (Windows only).
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, ...).
DispatcherConfig represents dispatcher configuration.
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.
Driver represents a driver (network, logging, secrets backend).
EncryptionConfig controls at-rest encryption of data and keys.
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.
GenericResource represents a "user defined" resource which can be either an integer (e.g: SSD=3) or a string (e.g: SSD=sda1).
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 a base object inherited by most of the other once.
NamedGenericResource represents a "user defined" resource which is defined as a string.
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.
PlacementPreference provides a way to make the scheduler aware of factors such as topology.
Platform represents the platform (Arch/OS).
PluginDescription represents the description of an engine plugin.
PortConfig represents the config of a port.
PortStatus represents the port status of a task's host ports whose service has published host ports.
Privileges defines the security options for the container.
RaftConfig represents raft configuration.
ReplicatedService is a kind of ServiceMode.
ResourceRequirements represents resources requirements.
Resources represents resources (CPU/Memory).
RestartPolicy represents the restart policy.
Secret represents a secret.
SecretReference is a reference to a secret in swarm.
SecretReferenceFileTarget is a file target in a secret reference.
SecretSpec represents a secret specification from a secret in swarm.
SELinuxContext contains the SELinux labels of the container.
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.
SpreadOver is a scheduling preference that instructs the scheduler to spread tasks evenly over groups of nodes identified by labels.
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.
TLSInfo represents the TLS information about what CA certificate is trusted, and who the issuer for a TLS certificate is.
UnlockRequest is the request used to unlock a swarm.
UpdateConfig represents the update configuration.
UpdateFlags contains flags for SwarmUpdate.
UpdateStatus reports the status of a service update.
Version represents the internal object version.
# Type aliases
ExternalCAProtocol represents type of external CA.
LocalNodeState represents the state of the local node.
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.
PortConfigPublishMode represents the mode in which the port is to be published.
Reachability represents the reachability of a node.
ResolutionMode represents a resolution mode.
RestartPolicyCondition represents when to restart.
RuntimeType is the type of runtime used for the TaskSpec.
RuntimeURL is the proto type url.
TaskState represents the state of a task.
UpdateState is the state of a service update.