Skip to content

Commit

Permalink
Update usage of "Swarm" for consistency
Browse files Browse the repository at this point in the history
Signed-off-by: Sebastiaan van Stijn <[email protected]>
  • Loading branch information
thaJeztah committed Jul 27, 2016
1 parent 1a7d339 commit f023004
Show file tree
Hide file tree
Showing 16 changed files with 73 additions and 75 deletions.
14 changes: 7 additions & 7 deletions daemon/cluster/cluster.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,16 @@ const (
)

// ErrNoSwarm is returned on leaving a cluster that was never initialized
var ErrNoSwarm = fmt.Errorf("This node is not part of swarm")
var ErrNoSwarm = fmt.Errorf("This node is not part of a swarm")

// ErrSwarmExists is returned on initialize or join request for a cluster that has already been activated
var ErrSwarmExists = fmt.Errorf("This node is already part of a swarm cluster. Use \"docker swarm leave\" to leave this cluster and join another one.")
var ErrSwarmExists = fmt.Errorf("This node is already part of a swarm. Use \"docker swarm leave\" to leave this swarm and join another one.")

// ErrPendingSwarmExists is returned on initialize or join request for a cluster that is already processing a similar request but has not succeeded yet.
var ErrPendingSwarmExists = fmt.Errorf("This node is processing an existing join request that has not succeeded yet. Use \"docker swarm leave\" to cancel the current request.")

// ErrSwarmJoinTimeoutReached is returned when cluster join could not complete before timeout was reached.
var ErrSwarmJoinTimeoutReached = fmt.Errorf("Timeout was reached before node was joined. Attempt to join the cluster will continue in the background. Use \"docker info\" command to see the current swarm status of your node.")
var ErrSwarmJoinTimeoutReached = fmt.Errorf("Timeout was reached before node was joined. The attempt to join the swarm will continue in the background. Use the \"docker info\" command to see the current swarm status of your node.")

// defaultSpec contains some sane defaults if cluster options are missing on init
var defaultSpec = types.Spec{
Expand Down Expand Up @@ -519,24 +519,24 @@ func (c *Cluster) Leave(force bool) error {
}

if node.Manager() != nil && !force {
msg := "You are attempting to leave cluster on a node that is participating as a manager. "
msg := "You are attempting to leave the swarm on a node that is participating as a manager. "
if c.isActiveManager() {
active, reachable, unreachable, err := c.managerStats()
if err == nil {
if active && reachable-2 <= unreachable {
if reachable == 1 && unreachable == 0 {
msg += "Removing the last manager will erase all current state of the cluster. Use `--force` to ignore this message. "
msg += "Removing the last manager erases all current state of the swarm. Use `--force` to ignore this message. "
c.Unlock()
return fmt.Errorf(msg)
}
msg += fmt.Sprintf("Leaving the cluster will leave you with %v managers out of %v. This means Raft quorum will be lost and your cluster will become inaccessible. ", reachable-1, reachable+unreachable)
msg += fmt.Sprintf("Removing this node leaves %v managers out of %v. Without a Raft quorum your swarm will be inaccessible. ", reachable-1, reachable+unreachable)
}
}
} else {
msg += "Doing so may lose the consensus of your cluster. "
}

msg += "The only way to restore a cluster that has lost consensus is to reinitialize it with `--force-new-cluster`. Use `--force` to ignore this message."
msg += "The only way to restore a swarm that has lost consensus is to reinitialize it with `--force-new-cluster`. Use `--force` to suppress this message."
c.Unlock()
return fmt.Errorf(msg)
}
Expand Down
47 changes: 23 additions & 24 deletions docs/reference/api/docker_remote_api_v1.24.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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**:

Expand Down Expand Up @@ -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:

Expand All @@ -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.
Expand All @@ -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**:

Expand All @@ -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"
}
Expand All @@ -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:

Expand All @@ -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**:

Expand All @@ -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**:

Expand Down Expand Up @@ -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.
Expand All @@ -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

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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

Expand Down
49 changes: 24 additions & 25 deletions docs/reference/api/docker_remote_api_v1.25.md
Original file line number Diff line number Diff line change
Expand Up @@ -2281,7 +2281,7 @@ Show the docker version information
Content-Type: application/json

{
"Version": "1.12.0-dev",
"Version": "1.13.0",
"Os": "linux",
"KernelVersion": "3.19.0-23-generic",
"GoVersion": "go1.6.3",
Expand Down Expand Up @@ -3324,7 +3324,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

Expand Down Expand Up @@ -3574,12 +3574,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**:

Expand Down Expand Up @@ -3608,7 +3608,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:

Expand All @@ -3622,9 +3622,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.
Expand All @@ -3646,12 +3646,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**:

Expand All @@ -3675,7 +3674,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:

Expand All @@ -3686,15 +3685,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**:

Expand All @@ -3709,14 +3708,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**:

Expand Down Expand Up @@ -3763,11 +3762,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.
Expand All @@ -3788,13 +3787,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

Expand Down Expand Up @@ -3980,7 +3979,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:

Expand Down Expand Up @@ -4074,7 +4073,7 @@ Stop and remove the service `id`
- **404** – no such service
- **500** – server error

### Inspect one or more service
### Inspect one or more services


`GET /services/(id or name)`
Expand Down Expand Up @@ -4278,7 +4277,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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commandline/info.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ available on the volume where `/var/lib/docker` is mounted.
## Display Docker system information

Here is a sample output for a daemon running on Ubuntu, using the overlay
storage driver and a node that is part of a 2 node swarm cluster:
storage driver and a node that is part of a 2-node swarm:

$ docker -D info
Containers: 14
Expand Down
Loading

0 comments on commit f023004

Please sign in to comment.