|
@@ -3352,7 +3352,7 @@ Instruct the driver to remove the network (`id`).
|
|
|
|
|
|
## 3.6 Nodes
|
|
|
|
|
|
-**Note**: Nodes operations require to first be part of a Swarm.
|
|
|
+**Note**: Node operations require the engine to be part of a swarm.
|
|
|
|
|
|
### List nodes
|
|
|
|
|
@@ -3613,12 +3613,12 @@ JSON Parameters:
|
|
|
|
|
|
## 3.7 Swarm
|
|
|
|
|
|
-### Initialize a new Swarm
|
|
|
+### Initialize a new swarm
|
|
|
|
|
|
|
|
|
`POST /swarm/init`
|
|
|
|
|
|
-Initialize a new Swarm
|
|
|
+Initialize a new swarm
|
|
|
|
|
|
**Example request**:
|
|
|
|
|
@@ -3647,7 +3647,7 @@ Initialize a new Swarm
|
|
|
|
|
|
- **200** – no error
|
|
|
- **400** – bad parameter
|
|
|
-- **406** – node is already part of a Swarm
|
|
|
+- **406** – node is already part of a swarm
|
|
|
|
|
|
JSON Parameters:
|
|
|
|
|
@@ -3661,9 +3661,9 @@ JSON Parameters:
|
|
|
number, like `eth0:4567`. If the port number is omitted, the port number from the listen
|
|
|
address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when
|
|
|
possible.
|
|
|
-- **ForceNewCluster** – Force creating a new Swarm even if already part of one.
|
|
|
-- **Spec** – Configuration settings of the new Swarm.
|
|
|
- - **Orchestration** – Configuration settings for the orchestration aspects of the Swarm.
|
|
|
+- **ForceNewCluster** – Force creation of a new swarm.
|
|
|
+- **Spec** – Configuration settings for the new swarm.
|
|
|
+ - **Orchestration** – Configuration settings for the orchestration aspects of the swarm.
|
|
|
- **TaskHistoryRetentionLimit** – Maximum number of tasks history stored.
|
|
|
- **Raft** – Raft related configuration.
|
|
|
- **SnapshotInterval** – Number of logs entries between snapshot.
|
|
@@ -3685,12 +3685,11 @@ JSON Parameters:
|
|
|
- **Options** - An object with key/value pairs that are interpreted
|
|
|
as protocol-specific options for the external CA driver.
|
|
|
|
|
|
-### Join an existing Swarm
|
|
|
-
|
|
|
+### Join an existing swarm
|
|
|
|
|
|
`POST /swarm/join`
|
|
|
|
|
|
-Join an existing new Swarm
|
|
|
+Join an existing swarm
|
|
|
|
|
|
**Example request**:
|
|
|
|
|
@@ -3714,7 +3713,7 @@ Join an existing new Swarm
|
|
|
|
|
|
- **200** – no error
|
|
|
- **400** – bad parameter
|
|
|
-- **406** – node is already part of a Swarm
|
|
|
+- **406** – node is already part of a swarm
|
|
|
|
|
|
JSON Parameters:
|
|
|
|
|
@@ -3725,15 +3724,15 @@ JSON Parameters:
|
|
|
number, like `eth0:4567`. If the port number is omitted, the port number from the listen
|
|
|
address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when
|
|
|
possible.
|
|
|
-- **RemoteAddr** – Address of any manager node already participating in the Swarm to join.
|
|
|
+- **RemoteAddr** – Address of any manager node already participating in the swarm.
|
|
|
- **JoinToken** – Secret token for joining this Swarm.
|
|
|
|
|
|
-### Leave a Swarm
|
|
|
+### Leave a swarm
|
|
|
|
|
|
|
|
|
`POST /swarm/leave`
|
|
|
|
|
|
-Leave a Swarm
|
|
|
+Leave a swarm
|
|
|
|
|
|
**Example request**:
|
|
|
|
|
@@ -3748,14 +3747,14 @@ Leave a Swarm
|
|
|
**Status codes**:
|
|
|
|
|
|
- **200** – no error
|
|
|
-- **406** – node is not part of a Swarm
|
|
|
+- **406** – node is not part of a swarm
|
|
|
|
|
|
-### Update a Swarm
|
|
|
+### Update a swarm
|
|
|
|
|
|
|
|
|
`POST /swarm/update`
|
|
|
|
|
|
-Update a Swarm
|
|
|
+Update a swarm
|
|
|
|
|
|
**Example request**:
|
|
|
|
|
@@ -3802,11 +3801,11 @@ Update a Swarm
|
|
|
|
|
|
- **200** – no error
|
|
|
- **400** – bad parameter
|
|
|
-- **406** – node is not part of a Swarm
|
|
|
+- **406** – node is not part of a swarm
|
|
|
|
|
|
JSON Parameters:
|
|
|
|
|
|
-- **Orchestration** – Configuration settings for the orchestration aspects of the Swarm.
|
|
|
+- **Orchestration** – Configuration settings for the orchestration aspects of the swarm.
|
|
|
- **TaskHistoryRetentionLimit** – Maximum number of tasks history stored.
|
|
|
- **Raft** – Raft related configuration.
|
|
|
- **SnapshotInterval** – Number of logs entries between snapshot.
|
|
@@ -3827,13 +3826,13 @@ JSON Parameters:
|
|
|
- **URL** - URL where certificate signing requests should be sent.
|
|
|
- **Options** - An object with key/value pairs that are interpreted
|
|
|
as protocol-specific options for the external CA driver.
|
|
|
-- **JoinTokens** - Tokens that can be used by other nodes to join the Swarm.
|
|
|
+- **JoinTokens** - Tokens that can be used by other nodes to join the swarm.
|
|
|
- **Worker** - Token to use for joining as a worker.
|
|
|
- **Manager** - Token to use for joining as a manager.
|
|
|
|
|
|
## 3.8 Services
|
|
|
|
|
|
-**Note**: Service operations require to first be part of a Swarm.
|
|
|
+**Note**: Service operations require to first be part of a swarm.
|
|
|
|
|
|
### List services
|
|
|
|
|
@@ -4019,7 +4018,7 @@ Create a service
|
|
|
**Status codes**:
|
|
|
|
|
|
- **201** – no error
|
|
|
-- **406** – server error or node is not part of a Swarm
|
|
|
+- **406** – server error or node is not part of a swarm
|
|
|
- **409** – name conflicts with an existing object
|
|
|
|
|
|
JSON Parameters:
|
|
@@ -4318,7 +4317,7 @@ Update the service `id`.
|
|
|
|
|
|
## 3.9 Tasks
|
|
|
|
|
|
-**Note**: Tasks operations require to first be part of a Swarm.
|
|
|
+**Note**: Task operations require the engine to be part of a swarm.
|
|
|
|
|
|
### List tasks
|
|
|
|