1. docker
  2. Commit 5902fa33840507706e6e9b189fec0adeb20affa5
Browse code

Update reference docs for service ps

commit bbd2018ee19eff5594ae3986bf56fbcd0044699d
changed the output format of `docker service ps`.

this patch updates the reference docs
to match the updated output format.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2016/12/13 21:30:58
Showing 2 changed files
docs/reference/commandline/service_create.md
History View file @ 5902fa3
... ... 
@@ -534,9 +534,11 @@ service's name and the node's ID where it sits.
534 534 
 ```bash
535 535 
 $ docker service create --name hosttempl --hostname={% raw %}"{{.Node.ID}}-{{.Service.Name}}"{% endraw %} busybox top
536 536 
 va8ew30grofhjoychbr6iot8c
537 
+
537 538 
 $ docker service ps va8ew30grofhjoychbr6iot8c
538 
-NAME                      IMAGE                                                                                   NODE          DESIRED STATE  CURRENT STATE               ERROR  PORTS
539 
-hosttempl.1.wo41w8hg8qan  busybox:latest@sha256:29f5d56d12684887bdfa50dcd29fc31eea4aaf4ad3bec43daf19026a7ce69912  2e7a8a9c4da2  Running        Running about a minute ago
539 
+ID            NAME         IMAGE                                                                                   NODE          DESIRED STATE  CURRENT STATE               ERROR  PORTS
540 
+wo41w8hg8qan  hosttempl.1  busybox:latest@sha256:29f5d56d12684887bdfa50dcd29fc31eea4aaf4ad3bec43daf19026a7ce69912  2e7a8a9c4da2  Running        Running about a minute ago
541 
+
540 542 
 $ docker inspect --format={% raw %}"{{.Config.Hostname}}"{% endraw %} hosttempl.1.wo41w8hg8qanxwjwsg4kxpprj
541 543 
 x3ti0erg11rjpg64m75kej2mz-hosttempl
542 544 
 ```
docs/reference/commandline/service_ps.md
History View file @ 5902fa3
... ... 
@@ -40,36 +40,57 @@ The following command shows all the tasks that are part of the `redis` service:
40 40
41 41 
 ```bash
42 42 
 $ docker service ps redis
43 
-NAME                                IMAGE        NODE      DESIRED STATE  CURRENT STATE
44 
-redis.1.0qihejybwf1x5vqi8lgzlgnpq   redis:3.0.6  manager1  Running        Running 8 seconds
45 
-redis.2.bk658fpbex0d57cqcwoe3jthu   redis:3.0.6  worker2   Running        Running 9 seconds
46 
-redis.3.5ls5s5fldaqg37s9pwayjecrf   redis:3.0.6  worker1   Running        Running 9 seconds
47 
-redis.4.8ryt076polmclyihzx67zsssj   redis:3.0.6  worker1   Running        Running 9 seconds
48 
-redis.5.1x0v8yomsncd6sbvfn0ph6ogc   redis:3.0.6  manager1  Running        Running 8 seconds
49 
-redis.6.71v7je3el7rrw0osfywzs0lko   redis:3.0.6  worker2   Running        Running 9 seconds
50 
-redis.7.4l3zm9b7tfr7cedaik8roxq6r   redis:3.0.6  worker2   Running        Running 9 seconds
51 
-redis.8.9tfpyixiy2i74ad9uqmzp1q6o   redis:3.0.6  worker1   Running        Running 9 seconds
52 
-redis.9.3w1wu13yuplna8ri3fx47iwad   redis:3.0.6  manager1  Running        Running 8 seconds
53 
-redis.10.8eaxrb2fqpbnv9x30vr06i6vt  redis:3.0.6  manager1  Running        Running 8 seconds
43 
+
44 
+ID             NAME      IMAGE        NODE      DESIRED STATE  CURRENT STATE          ERROR  PORTS
45 
+0qihejybwf1x   redis.1   redis:3.0.5  manager1  Running        Running 8 seconds
46 
+bk658fpbex0d   redis.2   redis:3.0.5  worker2   Running        Running 9 seconds
47 
+5ls5s5fldaqg   redis.3   redis:3.0.5  worker1   Running        Running 9 seconds
48 
+8ryt076polmc   redis.4   redis:3.0.5  worker1   Running        Running 9 seconds
49 
+1x0v8yomsncd   redis.5   redis:3.0.5  manager1  Running        Running 8 seconds
50 
+71v7je3el7rr   redis.6   redis:3.0.5  worker2   Running        Running 9 seconds
51 
+4l3zm9b7tfr7   redis.7   redis:3.0.5  worker2   Running        Running 9 seconds
52 
+9tfpyixiy2i7   redis.8   redis:3.0.5  worker1   Running        Running 9 seconds
53 
+3w1wu13yupln   redis.9   redis:3.0.5  manager1  Running        Running 8 seconds
54 
+8eaxrb2fqpbn   redis.10  redis:3.0.5  manager1  Running        Running 8 seconds
55 
+```
56 
+
57 
+In addition to _running_ tasks, the output also shows the task history. For
58 
+example, after updating the service to use the `redis:3.0.6` image, the output
59 
+may look like this:
60 
+
61 
+```bash
62 
+$ docker service ps redis
63 
+
64 
+ID            NAME         IMAGE        NODE      DESIRED STATE  CURRENT STATE                   ERROR  PORTS
65 
+50qe8lfnxaxk  redis.1      redis:3.0.6  manager1  Running        Running 6 seconds ago
66 
+ky2re9oz86r9   \_ redis.1  redis:3.0.5  manager1  Shutdown       Shutdown 8 seconds ago
67 
+3s46te2nzl4i  redis.2      redis:3.0.6  worker2   Running        Running less than a second ago
68 
+nvjljf7rmor4   \_ redis.2  redis:3.0.6  worker2   Shutdown       Rejected 23 seconds ago        "No such image: redis@sha256:6…"
69 
+vtiuz2fpc0yb   \_ redis.2  redis:3.0.5  worker2   Shutdown       Shutdown 1 second ago
70 
+jnarweeha8x4  redis.3      redis:3.0.6  worker1   Running        Running 3 seconds ago
71 
+vs448yca2nz4   \_ redis.3  redis:3.0.5  worker1   Shutdown       Shutdown 4 seconds ago
72 
+jf1i992619ir  redis.4      redis:3.0.6  worker1   Running        Running 10 seconds ago
73 
+blkttv7zs8ee   \_ redis.4  redis:3.0.5  worker1   Shutdown       Shutdown 11 seconds ago
54 74 
 ```
55 75
76 
+The number of items in the task history is determined by the
77 
+`--task-history-limit` option that was set when initializing the swarm. You can
78 
+change the task history retention limit using the
79 
+[`docker swarm update`](swarm_update.md) command.
80 
+
56 81 
 When deploying a service, docker resolves the digest for the service's
57 82 
 image, and pins the service to that digest. The digest is not shown by
58 
-default, but is printed if `--no-trunc` is used;
83 
+default, but is printed if `--no-trunc` is used. The `--no-trunc` option
84 
+also shows the non-truncated task ID, and error-messages, as can be seen below;
59 85
60 86 
 ```bash
61 87 
 $ docker service ps --no-trunc redis
62 
-NAME                                IMAGE                                                                                NODE      DESIRED STATE  CURRENT STATE
63 
-redis.1.0qihejybwf1x5vqi8lgzlgnpq   redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842  manager1  Running        Running 28 seconds
64 
-redis.2.bk658fpbex0d57cqcwoe3jthu   redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842  worker2   Running        Running 29 seconds
65 
-redis.3.5ls5s5fldaqg37s9pwayjecrf   redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842  worker1   Running        Running 29 seconds
66 
-redis.4.8ryt076polmclyihzx67zsssj   redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842  worker1   Running        Running 29 seconds
67 
-redis.5.1x0v8yomsncd6sbvfn0ph6ogc   redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842  manager1  Running        Running 28 seconds
68 
-redis.6.71v7je3el7rrw0osfywzs0lko   redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842  worker2   Running        Running 29 seconds
69 
-redis.7.4l3zm9b7tfr7cedaik8roxq6r   redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842  worker2   Running        Running 29 seconds
70 
-redis.8.9tfpyixiy2i74ad9uqmzp1q6o   redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842  worker1   Running        Running 29 seconds
71 
-redis.9.3w1wu13yuplna8ri3fx47iwad   redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842  manager1  Running        Running 28 seconds
72 
-redis.10.8eaxrb2fqpbnv9x30vr06i6vt  redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842  manager1  Running        Running 28 seconds
88 
+
89 
+ID                          NAME         IMAGE                                                                                NODE      DESIRED STATE  CURRENT STATE            ERROR                                                                                           PORTS
90 
+50qe8lfnxaxksi9w2a704wkp7   redis.1      redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842  manager1  Running        Running 5 minutes ago
91 
+ky2re9oz86r9556i2szb8a8af   \_ redis.1   redis:3.0.5@sha256:f8829e00d95672c48c60f468329d6693c4bdd28d1f057e755f8ba8b40008682e  worker2   Shutdown       Shutdown 5 minutes ago
92 
+bk658fpbex0d57cqcwoe3jthu   redis.2      redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842  worker2   Running        Running 5 seconds
93 
+nvjljf7rmor4htv7l8rwcx7i7   \_ redis.2   redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842  worker2   Shutdown       Rejected 5 minutes ago   "No such image: redis@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842"
73 94 
 ```
74 95
75 96 
 ## Filtering
... ... 
@@ -93,9 +114,10 @@ The `id` filter matches on all or a prefix of a task's ID.
93 93
94 94 
 ```bash
95 95 
 $ docker service ps -f "id=8" redis
96 
-NAME                                IMAGE        NODE      DESIRED STATE  CURRENT STATE
97 
-redis.4.8ryt076polmclyihzx67zsssj   redis:3.0.6  worker1   Running        Running 9 seconds
98 
-redis.10.8eaxrb2fqpbnv9x30vr06i6vt  redis:3.0.6  manager1  Running        Running 8 seconds
96 
+
97 
+ID             NAME      IMAGE        NODE      DESIRED STATE  CURRENT STATE      ERROR  PORTS
98 
+8ryt076polmc   redis.4   redis:3.0.6  worker1   Running        Running 9 seconds
99 
+8eaxrb2fqpbn   redis.10  redis:3.0.6  manager1  Running        Running 8 seconds
99 100 
 ```
100 101
101 102 
 #### Name
... ... 
@@ -104,8 +126,8 @@ The `name` filter matches on task names.
104 104
105 105 
 ```bash
106 106 
 $ docker service ps -f "name=redis.1" redis
107 
-NAME                                IMAGE        NODE      DESIRED STATE  CURRENT STATE
108 
-redis.1.0qihejybwf1x5vqi8lgzlgnpq   redis:3.0.6  manager1  Running        Running 8 seconds
107 
+ID            NAME     IMAGE        NODE      DESIRED STATE  CURRENT STATE      ERROR  PORTS
108 
+qihejybwf1x5  redis.1  redis:3.0.6  manager1  Running        Running 8 seconds
109 109 
 ```
110 110
111 111
... ... 
@@ -115,11 +137,11 @@ The `node` filter matches on a node name or a node ID.
115 115
116 116 
 ```bash
117 117 
 $ docker service ps -f "node=manager1" redis
118 
-NAME                                IMAGE        NODE      DESIRED STATE  CURRENT STATE
119 
-redis.1.0qihejybwf1x5vqi8lgzlgnpq   redis:3.0.6  manager1  Running        Running 8 seconds
120 
-redis.5.1x0v8yomsncd6sbvfn0ph6ogc   redis:3.0.6  manager1  Running        Running 8 seconds
121 
-redis.9.3w1wu13yuplna8ri3fx47iwad   redis:3.0.6  manager1  Running        Running 8 seconds
122 
-redis.10.8eaxrb2fqpbnv9x30vr06i6vt  redis:3.0.6  manager1  Running        Running 8 seconds
118 
+ID            NAME      IMAGE        NODE      DESIRED STATE  CURRENT STATE      ERROR  PORTS
119 
+0qihejybwf1x  redis.1   redis:3.0.6  manager1  Running        Running 8 seconds
120 
+1x0v8yomsncd  redis.5   redis:3.0.6  manager1  Running        Running 8 seconds
121 
+3w1wu13yupln  redis.9   redis:3.0.6  manager1  Running        Running 8 seconds
122 
+8eaxrb2fqpbn  redis.10  redis:3.0.6  manager1  Running        Running 8 seconds
123 123 
 ```
124 124
125 125