This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.Docker.
Summary
Settings for docker swarm update [OPTIONS].
Update the swarm
- Assembly
- Cake
.Docker .dll - Namespace
- Cake
.Docker - Base Types
-
- ToolSettings
- AutoToolSettings
graph BT
Type-->Base0["AutoToolSettings"]
click Base0 "/api/Cake.Docker/AutoToolSettings"
Base0-->Base1["ToolSettings"]
Type["DockerSwarmUpdateSettings"]
class Type type-node
Syntax
public sealed class DockerSwarmUpdateSettings : AutoToolSettingsConstructors
| Name | Summary |
|---|---|
| Docker |
Fields
| Name | Constant Value | Summary |
|---|---|---|
| SecretProperties |
Values of these properties shouldn't be displayed in the output.
Inherited from AutoToolSettings
|
Properties
| Name | Value | Summary |
|---|---|---|
| CertExpiry | string |
--cert-expiry
default: 90*24*time.Hour
Validity period for node certificates (ns|us|ms|s|m|h)
|
| DispatcherHeartbeat | string |
--dispatcher-heartbeat
default: 5*time.Second
Dispatcher heartbeat period (ns|us|ms|s|m|h)
|
| ExternalCa | string |
--external-ca
Specifications of one or more certificate signing endpoints
|
| MaxSnapshots | string |
--max-snapshots
|
| SnapshotInterval | string |
--snapshot-interval
|
| TaskHistoryLimit | Nullable |
--task-history-limit
default: 5
Task history retention limit
|
Methods
| Name | Value | Summary |
|---|---|---|
| Collect |
string[] |
Collects secret properties.
Inherited from AutoToolSettings
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|