Browse Source

Merge pull request #26156 from mstanleyjones/24905_swarm_noun_usage

Sanitize uses of Swarm as a proper and improper noun (Fixes #24905)
(cherry picked from commit 6f0502b89b29a7d23b02363d02104ec531a36e4a)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Charles Smith 8 years ago
parent
commit
dc98c76772

+ 2 - 2
docs/reference/api/docker_remote_api_v1.24.md

@@ -4009,7 +4009,7 @@ Return low-level information on the node `id`
 
 
 `DELETE /nodes/<id>`
 `DELETE /nodes/<id>`
 
 
-Remove a node [`id`] from the Swarm.
+Remove a node [`id`] from the swarm.
 
 
 **Example request**:
 **Example request**:
 
 
@@ -4253,7 +4253,7 @@ JSON Parameters:
   address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when
   address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when
   possible.
   possible.
 - **RemoteAddr** – Address of any manager node already participating in the swarm.
 - **RemoteAddr** – Address of any manager node already participating in the swarm.
-- **JoinToken** – Secret token for joining this Swarm.
+- **JoinToken** – Secret token for joining this swarm.
 
 
 ### Leave a swarm
 ### Leave a swarm
 
 

+ 2 - 2
docs/reference/api/docker_remote_api_v1.25.md

@@ -4034,7 +4034,7 @@ Return low-level information on the node `id`
 
 
 `DELETE /nodes/<id>`
 `DELETE /nodes/<id>`
 
 
-Remove a node [`id`] from the Swarm.
+Remove a node [`id`] from the swarm.
 
 
 **Example request**:
 **Example request**:
 
 
@@ -4274,7 +4274,7 @@ JSON Parameters:
   address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when
   address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when
   possible.
   possible.
 - **RemoteAddr** – Address of any manager node already participating in the swarm.
 - **RemoteAddr** – Address of any manager node already participating in the swarm.
-- **JoinToken** – Secret token for joining this Swarm.
+- **JoinToken** – Secret token for joining this swarm.
 
 
 ### Leave a swarm
 ### Leave a swarm
 
 

+ 1 - 1
docs/reference/commandline/swarm_init.md

@@ -74,7 +74,7 @@ This flag forces an existing node that was part of a quorum that was lost to res
 
 
 ### `--listen-addr value`
 ### `--listen-addr value`
 
 
-The node listens for inbound Swarm manager traffic on this address. The default is to listen on
+The node listens for inbound swarm manager traffic on this address. The default is to listen on
 0.0.0.0:2377. It is also possible to specify a network interface to listen on that interface's
 0.0.0.0:2377. It is also possible to specify a network interface to listen on that interface's
 address; for example `--listen-addr eth0:2377`.
 address; for example `--listen-addr eth0:2377`.
 
 

+ 1 - 1
docs/reference/commandline/swarm_join.md

@@ -61,7 +61,7 @@ dvfxp4zseq4s0rih1selh0d20 *  manager1  Ready   Active        Leader
 
 
 ### `--listen-addr value`
 ### `--listen-addr value`
 
 
-If the node is a manager, it will listen for inbound Swarm manager traffic on this
+If the node is a manager, it will listen for inbound swarm manager traffic on this
 address. The default is to listen on 0.0.0.0:2377. It is also possible to specify a
 address. The default is to listen on 0.0.0.0:2377. It is also possible to specify a
 network interface to listen on that interface's address; for example `--listen-addr eth0:2377`.
 network interface to listen on that interface's address; for example `--listen-addr eth0:2377`.
 
 

+ 1 - 1
docs/swarm/swarm-tutorial/drain-node.md

@@ -97,7 +97,7 @@ task assignments for the `redis` service:
     9bg7cezvedmkgg6c8yzvbhwsd  redis.3       redis:3.0.6  worker2   Running        Running 4 minutes
     9bg7cezvedmkgg6c8yzvbhwsd  redis.3       redis:3.0.6  worker2   Running        Running 4 minutes
     ```
     ```
 
 
-    The Swarm manager maintains the desired state by ending the task on a node
+    The swarm manager maintains the desired state by ending the task on a node
     with `Drain` availability and creating a new task on a node with `Active`
     with `Drain` availability and creating a new task on a node with `Active`
     availability.
     availability.
 
 

+ 15 - 15
docs/userguide/networking/get-started-overlay.md

@@ -71,7 +71,7 @@ store uses the hostnames to identify cluster members.
 Though Docker Machine and Docker Swarm are not mandatory to experience Docker
 Though Docker Machine and Docker Swarm are not mandatory to experience Docker
 multi-host networking with a key-value store, this example uses them to
 multi-host networking with a key-value store, this example uses them to
 illustrate how they are integrated. You'll use Machine to create both the
 illustrate how they are integrated. You'll use Machine to create both the
-key-value store server and the host cluster. This example creates a Swarm
+key-value store server and the host cluster. This example creates a swarm
 cluster.
 cluster.
 
 
 >**Note:** Docker Engine running in swarm mode is not compatible with networking
 >**Note:** Docker Engine running in swarm mode is not compatible with networking
@@ -135,11 +135,11 @@ Keep your terminal open and move onto the next step.
 
 
 In this step, you use `docker-machine` to provision the hosts for your network.
 In this step, you use `docker-machine` to provision the hosts for your network.
 At this point, you won't actually create the network. You'll create several
 At this point, you won't actually create the network. You'll create several
-machines in VirtualBox. One of the machines will act as the Swarm master;
+machines in VirtualBox. One of the machines will act as the swarm master;
 you'll create that first. As you create each host, you'll pass the Engine on
 you'll create that first. As you create each host, you'll pass the Engine on
 that machine options that are needed by the `overlay` network driver.
 that machine options that are needed by the `overlay` network driver.
 
 
-1. Create a Swarm master.
+1. Create a swarm master.
 
 
 		$ docker-machine create \
 		$ docker-machine create \
 		-d virtualbox \
 		-d virtualbox \
@@ -151,7 +151,7 @@ that machine options that are needed by the `overlay` network driver.
 
 
 	At creation time, you supply the Engine `daemon` with the ` --cluster-store` option. This option tells the Engine the location of the key-value store for the `overlay` network. The bash expansion `$(docker-machine ip mh-keystore)` resolves to the IP address of the Consul server you created in "STEP 1". The `--cluster-advertise` option advertises the machine on the network.
 	At creation time, you supply the Engine `daemon` with the ` --cluster-store` option. This option tells the Engine the location of the key-value store for the `overlay` network. The bash expansion `$(docker-machine ip mh-keystore)` resolves to the IP address of the Consul server you created in "STEP 1". The `--cluster-advertise` option advertises the machine on the network.
 
 
-2. Create another host and add it to the Swarm cluster.
+2. Create another host and add it to the swarm cluster.
 
 
 		$ docker-machine create -d virtualbox \
 		$ docker-machine create -d virtualbox \
 			--swarm \
 			--swarm \
@@ -178,13 +178,13 @@ Leave your terminal open and go onto the next step.
 
 
 To create an overlay network
 To create an overlay network
 
 
-1. Set your docker environment to the Swarm master.
+1. Set your docker environment to the swarm master.
 
 
 		$ eval $(docker-machine env --swarm mhs-demo0)
 		$ eval $(docker-machine env --swarm mhs-demo0)
 
 
-	Using the `--swarm` flag with `docker-machine` restricts the `docker` commands to Swarm information alone.
+	Using the `--swarm` flag with `docker-machine` restricts the `docker` commands to swarm information alone.
 
 
-2. Use the `docker info` command to view the Swarm.
+2. Use the `docker info` command to view the swarm.
 
 
 		$ docker info
 		$ docker info
 
 
@@ -214,7 +214,7 @@ To create an overlay network
 
 
 		$ docker network create --driver overlay --subnet=10.0.9.0/24 my-net
 		$ docker network create --driver overlay --subnet=10.0.9.0/24 my-net
 
 
-	You only need to create the network on a single host in the cluster. In this case, you used the Swarm master but you could easily have run it on any host in the cluster.
+	You only need to create the network on a single host in the cluster. In this case, you used the swarm master but you could easily have run it on any host in the cluster.
 
 
 > **Note** : It is highly recommended to use the `--subnet` option when creating
 > **Note** : It is highly recommended to use the `--subnet` option when creating
 > a network. If the `--subnet` is not specified, the docker daemon automatically
 > a network. If the `--subnet` is not specified, the docker daemon automatically
@@ -235,11 +235,11 @@ To create an overlay network
 		d0bb78cbe7bd        mhs-demo1/bridge    bridge
 		d0bb78cbe7bd        mhs-demo1/bridge    bridge
 		1c0eb8f69ebb        mhs-demo1/none      null
 		1c0eb8f69ebb        mhs-demo1/none      null
 
 
-	As you are in the Swarm master environment, you see all the networks on all
-	the Swarm agents: the default networks on each engine and the single overlay
+	As you are in the swarm master environment, you see all the networks on all
+	the swarm agents: the default networks on each engine and the single overlay
 	network. Notice that each `NETWORK ID` is unique.
 	network. Notice that each `NETWORK ID` is unique.
 
 
-5. Switch to each Swarm agent in turn and list the networks.
+5. Switch to each swarm agent in turn and list the networks.
 
 
 		$ eval $(docker-machine env mhs-demo0)
 		$ eval $(docker-machine env mhs-demo0)
 
 
@@ -268,7 +268,7 @@ To create an overlay network
 
 
 Once your network is created, you can start a container on any of the hosts and it automatically is part of the network.
 Once your network is created, you can start a container on any of the hosts and it automatically is part of the network.
 
 
-1. Point your environment to the Swarm master.
+1. Point your environment to the swarm master.
 
 
 		$ eval $(docker-machine env --swarm mhs-demo0)
 		$ eval $(docker-machine env --swarm mhs-demo0)
 
 
@@ -322,7 +322,7 @@ Additionally, containers connected to the multi-host network are automatically
 connected to the `docker_gwbridge` network. This network allows the containers
 connected to the `docker_gwbridge` network. This network allows the containers
 to have external connectivity outside of their cluster.
 to have external connectivity outside of their cluster.
 
 
-1. Change your environment to the Swarm agent.
+1. Change your environment to the swarm agent.
 
 
 		$ eval $(docker-machine env mhs-demo1)
 		$ eval $(docker-machine env mhs-demo1)
 
 
@@ -337,7 +337,7 @@ to have external connectivity outside of their cluster.
 		1aeead6dd890        host                host
 		1aeead6dd890        host                host
 		e1dbd5dff8be        docker_gwbridge     bridge
 		e1dbd5dff8be        docker_gwbridge     bridge
 
 
-3. Repeat steps 1 and 2 on the Swarm master.
+3. Repeat steps 1 and 2 on the swarm master.
 
 
 		$ eval $(docker-machine env mhs-demo0)
 		$ eval $(docker-machine env mhs-demo0)
 
 
@@ -381,7 +381,7 @@ to have external connectivity outside of their cluster.
 
 
 Please refer to the Networking feature introduced in [Compose V2 format]
 Please refer to the Networking feature introduced in [Compose V2 format]
 (https://docs.docker.com/compose/networking/) and execute the
 (https://docs.docker.com/compose/networking/) and execute the
-multi-host networking scenario in the Swarm cluster used above.
+multi-host networking scenario in the swarm cluster used above.
 
 
 ## Related information
 ## Related information
 
 

+ 1 - 1
docs/userguide/networking/index.md

@@ -495,7 +495,7 @@ Docker Engine for use with `overlay` network. There are three options to set:
     </tbody>
     </tbody>
 </table>
 </table>
 
 
-Create an `overlay` network on one of the machines in the Swarm.
+Create an `overlay` network on one of the machines in the swarm.
 
 
     $ docker network create --driver overlay my-multi-host-network
     $ docker network create --driver overlay my-multi-host-network