1. docker
  2. Commit ee1fa5b4645c5d811628183c04edee6d1d4f444d
Browse code

Change NAME to HOSTNAME in docs for `docker node ls`

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>
(cherry picked from commit 668b8a998f5ebbe66c7376c432a5fd87208add73)
Signed-off-by: Tibor Vass <tibor@docker.com>

Yong Tang authored on 2016/07/07 12:23:53
Showing 7 changed files
docs/reference/commandline/node_ls.md
History View file @ ee1fa5b
... ... 
@@ -29,7 +29,7 @@ Lists all the nodes that the Docker Swarm manager knows about. You can filter us
29 29 
 Example output:
30 30
31 31 
     $ docker node ls
32 
-    ID                           NAME           MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
32 
+    ID                           HOSTNAME        MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
33 33 
     1bcef6utixb0l0ca7gxuivsj0    swarm-worker2   Accepted    Ready   Active
34 34 
     38ciaotwjuritcdtn9npbnkuz    swarm-worker1   Accepted    Ready   Active
35 35 
     e216jshn25ckzbvmwlnh5jr3g *  swarm-manager1  Accepted    Ready   Active        Reachable       Yes
... ... 
@@ -53,7 +53,7 @@ The `name` filter matches on all or part of a node name.
53 53 
 The following filter matches the node with a name equal to `swarm-master` string.
54 54
55 55 
     $ docker node ls -f name=swarm-manager1
56 
-    ID                           NAME            MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
56 
+    ID                           HOSTNAME        MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
57 57 
     e216jshn25ckzbvmwlnh5jr3g *  swarm-manager1  Accepted    Ready   Active        Reachable       Yes
58 58
59 59 
 ### id
... ... 
@@ -61,7 +61,7 @@ The following filter matches the node with a name equal to `swarm-master` string
61 61 
 The `id` filter matches all or part of a node's id.
62 62
63 63 
     $ docker node ls -f id=1
64 
-    ID                         NAME           MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
64 
+    ID                         HOSTNAME       MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
65 65 
     1bcef6utixb0l0ca7gxuivsj0  swarm-worker2  Accepted    Ready   Active
66 66
67 67
... ... 
@@ -74,7 +74,7 @@ The following filter matches nodes with the `usage` label regardless of its valu
74 74
75 75 
 ```bash
76 76 
 $ docker node ls -f "label=foo"
77 
-ID                         NAME           MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
77 
+ID                         HOSTNAME       MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
78 78 
 1bcef6utixb0l0ca7gxuivsj0  swarm-worker2  Accepted    Ready   Active
79 79 
 ```
80 80
docs/reference/commandline/swarm_init.md
History View file @ ee1fa5b
... ... 
@@ -32,7 +32,7 @@ in the newly created one node Swarm cluster.
32 32 
 $ docker swarm init --listen-addr 192.168.99.121:2377
33 33 
 Swarm initialized: current node (1ujecd0j9n3ro9i6628smdmth) is now a manager.
34 34 
 $ docker node ls
35 
-ID                           NAME      MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS          LEADER
35 
+ID                           HOSTNAME  MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS          LEADER
36 36 
 1ujecd0j9n3ro9i6628smdmth *  manager1  Accepted    Ready   Active        Reachable               Yes
37 37 
 ```
38 38
docs/reference/commandline/swarm_join.md
History View file @ ee1fa5b
... ... 
@@ -31,7 +31,7 @@ targeted by this command becomes a `manager`. If it is not specified, it becomes
31 31 
 $ docker swarm join --manager --listen-addr 192.168.99.122:2377 192.168.99.121:2377
32 32 
 This node joined a Swarm as a manager.
33 33 
 $ docker node ls
34 
-ID                           NAME      MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS         LEADER
34 
+ID                           HOSTNAME  MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS         LEADER
35 35 
 dkp8vy1dq1kxleu9g4u78tlag *  manager2  Accepted    Ready   Active        Reachable
36 36 
 dvfxp4zseq4s0rih1selh0d20    manager1  Accepted    Ready   Active        Reachable              Yes
37 37 
 ```
... ... 
@@ -42,7 +42,7 @@ dvfxp4zseq4s0rih1selh0d20    manager1  Accepted    Ready   Active        Reachab
42 42 
 $ docker swarm join --listen-addr 192.168.99.123:2377 192.168.99.121:2377
43 43 
 This node joined a Swarm as a worker.
44 44 
 $ docker node ls
45 
-ID                           NAME      MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS         LEADER
45 
+ID                           HOSTNAME  MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS         LEADER
46 46 
 7ln70fl22uw2dvjn2ft53m3q5    worker2   Accepted    Ready   Active
47 47 
 dkp8vy1dq1kxleu9g4u78tlag    worker1   Accepted    Ready   Active        Reachable
48 48 
 dvfxp4zseq4s0rih1selh0d20 *  manager1  Accepted    Ready   Active        Reachable              Yes
docs/reference/commandline/swarm_leave.md
History View file @ ee1fa5b
... ... 
@@ -24,7 +24,7 @@ This command causes the node to leave the swarm.
24 24 
 On a manager node:
25 25 
 ```bash
26 26 
 $ docker node ls
27 
-ID                           NAME      MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS         LEADER
27 
+ID                           HOSTNAME  MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS         LEADER
28 28 
 7ln70fl22uw2dvjn2ft53m3q5    worker2   Accepted    Ready   Active
29 29 
 dkp8vy1dq1kxleu9g4u78tlag    worker1   Accepted    Ready   Active        Reachable
30 30 
 dvfxp4zseq4s0rih1selh0d20 *  manager1  Accepted    Ready   Active        Reachable              Yes
... ... 
@@ -39,7 +39,7 @@ Node left the default swarm.
39 39 
 On a manager node:
40 40 
 ```bash
41 41 
 $ docker node ls
42 
-ID                           NAME      MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS         LEADER
42 
+ID                           HOSTNAME  MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS         LEADER
43 43 
 7ln70fl22uw2dvjn2ft53m3q5    worker2   Accepted    Down    Active
44 44 
 dkp8vy1dq1kxleu9g4u78tlag    worker1   Accepted    Ready   Active        Reachable
45 45 
 dvfxp4zseq4s0rih1selh0d20 *  manager1  Accepted    Ready   Active        Reachable              Yes
docs/swarm/swarm-tutorial/add-nodes.md
History View file @ ee1fa5b
... ... 
@@ -50,7 +50,7 @@ the existing Swarm.
50 50 
 the `docker node ls` command to see the worker nodes:
51 51
52 52 
     ```bash
53 
-    ID                           NAME      MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
53 
+    ID                           HOSTNAME  MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
54 54 
     03g1y59jwfg7cf99w4lt0f662    worker2   Accepted    Ready   Active
55 55 
     9j68exjopxe7wfl6yuxml7a7j    worker1   Accepted    Ready   Active
56 56 
     dxn1zf6l61qsb1josjja83ngz *  manager1  Accepted    Ready   Active        Reachable       Yes
docs/swarm/swarm-tutorial/create-swarm.md
History View file @ ee1fa5b
... ... 
@@ -62,7 +62,7 @@ node. For example, the tutorial uses a machine named `manager1`.
62 62 
     ```
63 63 
     $ docker node ls
64 64
65 
-    ID                           NAME      MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
65 
+    ID                           HOSTNAME  MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
66 66 
     dxn1zf6l61qsb1josjja83ngz *  manager1  Accepted    Ready   Active        Reachable       Yes
67 67
68 68 
     ```
docs/swarm/swarm-tutorial/drain-node.md
History View file @ ee1fa5b
... ... 
@@ -31,7 +31,7 @@ run your manager node. For example, the tutorial uses a machine named
31 31 
     ```bash
32 32 
     $ docker node ls
33 33
34 
-    ID                           NAME      MEMBERSHIP  STATUS  AVAILABILITY     MANAGER STATUS  LEADER
34 
+    ID                           HOSTNAME  MEMBERSHIP  STATUS  AVAILABILITY     MANAGER STATUS  LEADER
35 35 
     1bcef6utixb0l0ca7gxuivsj0    worker2   Accepted    Ready   Active
36 36 
     38ciaotwjuritcdtn9npbnkuz    worker1   Accepted    Ready   Active
37 37 
     e216jshn25ckzbvmwlnh5jr3g *  manager1  Accepted    Ready   Active        Reachable       Yes