Skip to content

dsdk / v1.47 / SwarmSpec

Type Alias: SwarmSpec ​

SwarmSpec: object

User modifiable swarm configuration.

Type declaration ​

NameTypeDescription
CAConfig?object | nullCA configuration.
Dispatcher?object | nullDispatcher configuration.
EncryptionConfig?objectParameters related to encryption-at-rest.
EncryptionConfig.AutoLockManagers?booleanIf set, generate a key and use it to lock data stored on the managers.
Labels?objectUser-defined key/value metadata.
Name?stringName of the swarm.
Orchestration?object | nullOrchestration configuration.
Raft?objectRaft configuration.
Raft.ElectionTick?numberThe 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.
Raft.HeartbeatTick?numberThe 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.
Raft.KeepOldSnapshots?numberThe number of snapshots to keep beyond the current snapshot.
Raft.LogEntriesForSlowFollowers?numberThe number of log entries to keep around to sync up slow followers after a snapshot is created.
Raft.SnapshotInterval?numberThe number of log entries between snapshots.
TaskDefaults?objectDefaults for creating tasks in this cluster.
TaskDefaults.LogDriver?objectThe 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.
TaskDefaults.LogDriver.Name?stringThe log driver to use as a default for new tasks.
TaskDefaults.LogDriver.Options?objectDriver-specific options for the selected log driver, specified as key/value pairs.