package
1.12.0
Repository: https://github.com/docker/swarm-v2.git
Documentation: pkg.go.dev

# README

Notice

Do not change .pb.go files directly. You need to change the corresponding .proto files and run the following command to regenerate the .pb.go files.

$ make generate

Click here for more information about protobuf.

# Packages

Package duration is a generated protocol buffer package.
No description provided by the author
Package timestamp is a generated protocol buffer package.

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Active nodes.
Drained nodes are paused and any task already running on them will be evicted.
Paused nodes won't be considered by the scheduler, preventing any further task to run on them.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Disconnected indicates the node is currently trying to find new manager.
Down indicates the node is down.
Ready indicates the node is ready to accept tasks.
Unknown indicates the node state cannot be resolved.
No description provided by the author
No description provided by the author
Reachable indicates that the node is healthy and reachable by other members.
Unknown indicates that the manager state cannot be resolved.
Unreachable indicates that the node cannot be contacted by other raft cluster members.
DNSRR resolution mode specifies that the service directly gets resolved to one of the backend IP and the client directly initiates a request towards the actual backend.
VIP resolution mode specifies that the service resolves to a logical IP and the requests are sent to that logical IP.
No description provided by the author
No description provided by the author
No description provided by the author
V0 is the initial version of the StoreSnapshot message.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
Annotations provide useful information to identify API objects.
No description provided by the author
No description provided by the author
Cluster provides global cluster settings.
ClusterSnapshot stores cluster membership information in snapshots.
ClusterSpec specifies global cluster settings.
Container specifies runtime parameters for a container.
PullOptions allows one to parameterize an image pull.
Container specific status.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DispatcherConfig defines cluster-level dispatcher settings.
Driver is a generic driver type to be used throughout the API.
Symmetric keys to encrypt inter-agent communication.
Endpoint specified all the network parameters required to correctly discover and load balance a service.
VirtualIP specifies a set of networks this endpoint will be attached to and the IP addresses the target service will be made available under.
EndpointSpec defines the properties that can be configured to access and loadbalance the service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GlobalService represents global service.
No description provided by the author
No description provided by the author
HeartbeatRequest provides identifying properties for a single heartbeat.
No description provided by the author
No description provided by the author
Contains one of many protobuf encoded objects to replicate over the raft backend with a request ID to track when the action is effectively applied.
IPAMConfig specifies parameters for IP Address Management.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
JoinToken contains the join tokens for workers and managers.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ManagerStatus provides informations about the state of a manager in the cluster.
Meta contains metadata about objects.
Mount describes volume mounts for a container.
BindOptions specifies options that are specific to a bind mount.
No description provided by the author
VolumeOptions contains parameters for mounting the volume.
No description provided by the author
NetworkAttachment specifies the network parameters of attachment to a single network by an object such as task or node.
NetworkSpec specifies user defined network parameters.
Node provides the internal node state as seen by the cluster.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OrchestrationConfig defines cluster-level orchestration settings.
Peer should be used anywhere where we are describing a remote peer.
Placement specifies task distribution constraints.
No description provided by the author
PluginDescription describes an engine plugin.
PortConfig specifies an exposed port which can be addressed using the given name.
No description provided by the author
No description provided by the author
RaftConfig defines raft settings for the cluster.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RemoveNodeRequest requests to delete the specified node from store.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ReplicatedService sets the reconciliation target to certain number of replicas.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServiceSpec defines the properties of a service.
No description provided by the author
NetworkAttachmentConfig specifies how a service should be attached to a particular network.
No description provided by the author
SessionMessage instructs an agent on various actions as part of the current session.
SessionRequest starts a session.
No description provided by the author
StoreAction defines a taret and operation to apply on the storage system.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
StoreSnapshot is used to store snapshots of the store.
Task specifies the parameters for implementing a Spec.
TaskDefaults specifies default values for task creation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UpdateConfig specifies the rate and policy of updates.
UpdateNodeRequest requests an update to the specified node.
No description provided by the author
No description provided by the author
No description provided by the author
UpdateStatus is the status of an update in progress.
No description provided by the author
No description provided by the author
No description provided by the author
Version tracks the last time an object in the store was updated.
WeightedPeer should be used anywhere where we are describing a remote peer with a weight.

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

Encryption algorithm that can implemented using this key.
ResolutionMode specifies the mode of resolution to use for internal loadbalancing between tasks which are all within the cluster.
No description provided by the author
No description provided by the author
AddressFamily specifies the network address family that this IPAMConfig belongs to.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TODO(aluzzardi) These should be using `gogoproto.enumvalue_customname`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
StoreActionKind defines the operation to take on the store for the target of a storage action.
TaskState enumerates the states that a task progresses through within an agent.
No description provided by the author
No description provided by the author