Update usage of "Swarm" for consistency
Signed-off-by: Sebastiaan van Stijn <github@gone.nl> Upstream-commit: f0230049f0afd318217c60ebe486aab3b54538fd Component: engine
This commit is contained in:
Sebastiaan van Stijn
@ -3323,7 +3323,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
|
||||
|
||||
@ -3573,12 +3573,12 @@ Return low-level information on the node `id`
|
||||
|
||||
## 3.7 Swarm
|
||||
|
||||
### Initialize a new Swarm
|
||||
### Initialize a new swarm
|
||||
|
||||
|
||||
`POST /swarm/init`
|
||||
|
||||
Initialize a new Swarm
|
||||
Initialize a new swarm
|
||||
|
||||
**Example request**:
|
||||
|
||||
@ -3607,7 +3607,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:
|
||||
|
||||
@ -3621,9 +3621,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.
|
||||
@ -3645,12 +3645,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**:
|
||||
|
||||
@ -3659,7 +3658,7 @@ Join an existing new Swarm
|
||||
|
||||
{
|
||||
"ListenAddr": "0.0.0.0:4500",
|
||||
"AdvertiseAddr: "192.168.1.1:4500",
|
||||
"AdvertiseAddr": "192.168.1.1:4500",
|
||||
"RemoteAddrs": ["node1:4500"],
|
||||
"JoinToken": "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2"
|
||||
}
|
||||
@ -3674,7 +3673,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:
|
||||
|
||||
@ -3685,15 +3684,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**:
|
||||
|
||||
@ -3708,14 +3707,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**:
|
||||
|
||||
@ -3762,11 +3761,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.
|
||||
@ -3787,13 +3786,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
|
||||
|
||||
@ -3979,7 +3978,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
|
||||
|
||||
JSON Parameters:
|
||||
|
||||
@ -4277,7 +4276,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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user