Skip to content

Commit

Permalink
Change NAME to HOSTNAME in docs for docker node ls
Browse files Browse the repository at this point in the history 
In #24159, the title field of `docker node ls` has been
changed from NAME to HOSTNAME. However, in the docs the
NAMEs are still used for the output of `docker node ls`.

This fix updates docs so that NAME field is changed to
HOSTNAME for all `docker node ls`.

This fix is related to #24159 and #24090.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
  • Loading branch information
@yongtang
yongtang committed Jul 7, 2016
1 parent 28e9d93 commit 668b8a9
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions docs/reference/commandline/node_ls.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Lists all the nodes that the Docker Swarm manager knows about. You can filter us
Example output:

$ docker node ls
ID NAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
ID HOSTNAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Accepted Ready Active
38ciaotwjuritcdtn9npbnkuz swarm-worker1 Accepted Ready Active
e216jshn25ckzbvmwlnh5jr3g * swarm-manager1 Accepted Ready Active Reachable Yes
Expand All @@ -52,15 +52,15 @@ The `name` filter matches on all or part of a node name.
The following filter matches the node with a name equal to `swarm-master` string.

$ docker node ls -f name=swarm-manager1
ID NAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
ID HOSTNAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
e216jshn25ckzbvmwlnh5jr3g * swarm-manager1 Accepted Ready Active Reachable Yes

### id

The `id` filter matches all or part of a node's id.

$ docker node ls -f id=1
ID NAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
ID HOSTNAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Accepted Ready Active


Expand All @@ -73,7 +73,7 @@ The following filter matches nodes with the `usage` label regardless of its valu

```bash
$ docker node ls -f "label=foo"
ID NAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
ID HOSTNAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Accepted Ready Active
```

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commandline/swarm_init.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ in the newly created one node Swarm cluster.
$ docker swarm init --listen-addr 192.168.99.121:2377
Swarm initialized: current node (1ujecd0j9n3ro9i6628smdmth) is now a manager.
$ docker node ls
ID NAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
ID HOSTNAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
1ujecd0j9n3ro9i6628smdmth * manager1 Accepted Ready Active Reachable Yes
```

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/commandline/swarm_join.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ targeted by this command becomes a `manager`. If it is not specified, it becomes
$ docker swarm join --manager --listen-addr 192.168.99.122:2377 192.168.99.121:2377
This node joined a Swarm as a manager.
$ docker node ls
ID NAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
ID HOSTNAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
dkp8vy1dq1kxleu9g4u78tlag * manager2 Accepted Ready Active Reachable
dvfxp4zseq4s0rih1selh0d20 manager1 Accepted Ready Active Reachable Yes
```
Expand All @@ -41,7 +41,7 @@ dvfxp4zseq4s0rih1selh0d20 manager1 Accepted Ready Active Reachab
$ docker swarm join --listen-addr 192.168.99.123:2377 192.168.99.121:2377
This node joined a Swarm as a worker.
$ docker node ls
ID NAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
ID HOSTNAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
7ln70fl22uw2dvjn2ft53m3q5 worker2 Accepted Ready Active
dkp8vy1dq1kxleu9g4u78tlag worker1 Accepted Ready Active Reachable
dvfxp4zseq4s0rih1selh0d20 * manager1 Accepted Ready Active Reachable Yes
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/commandline/swarm_leave.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This command causes the node to leave the swarm.
On a manager node:
```bash
$ docker node ls
ID NAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
ID HOSTNAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
7ln70fl22uw2dvjn2ft53m3q5 worker2 Accepted Ready Active
dkp8vy1dq1kxleu9g4u78tlag worker1 Accepted Ready Active Reachable
dvfxp4zseq4s0rih1selh0d20 * manager1 Accepted Ready Active Reachable Yes
Expand All @@ -38,7 +38,7 @@ Node left the default swarm.
On a manager node:
```bash
$ docker node ls
ID NAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
ID HOSTNAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
7ln70fl22uw2dvjn2ft53m3q5 worker2 Accepted Down Active
dkp8vy1dq1kxleu9g4u78tlag worker1 Accepted Ready Active Reachable
dvfxp4zseq4s0rih1selh0d20 * manager1 Accepted Ready Active Reachable Yes
Expand Down
2 changes: 1 addition & 1 deletion docs/swarm/swarm-tutorial/add-nodes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ the existing Swarm.
the `docker node ls` command to see the worker nodes:

```bash
ID NAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
ID HOSTNAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
03g1y59jwfg7cf99w4lt0f662 worker2 Accepted Ready Active
9j68exjopxe7wfl6yuxml7a7j worker1 Accepted Ready Active
dxn1zf6l61qsb1josjja83ngz * manager1 Accepted Ready Active Reachable Yes
Expand Down
2 changes: 1 addition & 1 deletion docs/swarm/swarm-tutorial/create-swarm.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ node. For example, the tutorial uses a machine named `manager1`.
```
$ docker node ls
ID NAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
ID HOSTNAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
dxn1zf6l61qsb1josjja83ngz * manager1 Accepted Ready Active Reachable Yes
```
Expand Down
2 changes: 1 addition & 1 deletion docs/swarm/swarm-tutorial/drain-node.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ run your manager node. For example, the tutorial uses a machine named
```bash
$ docker node ls

ID NAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
ID HOSTNAME MEMBERSHIP STATUS AVAILABILITY MANAGER STATUS LEADER
1bcef6utixb0l0ca7gxuivsj0 worker2 Accepted Ready Active
38ciaotwjuritcdtn9npbnkuz worker1 Accepted Ready Active
e216jshn25ckzbvmwlnh5jr3g * manager1 Accepted Ready Active Reachable Yes
Expand Down

0 comments on commit 668b8a9

Please sign in to comment.