1. docker
  2. Commit 040d4ebd589e55cfa6b27d55a2dc8487e4a83670
Browse code

Update cli reference for docker {,stack} deploy

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
(cherry picked from commit 88cdfc512b0737f6dd9eb5ad207fb68f9acdf51e)
Signed-off-by: Victor Vieux <victorvieux@gmail.com>

Vincent Demeester authored on 2016/11/21 20:36:31
Showing 2 changed files
docs/reference/commandline/deploy.md
History View file @ 040d4eb
... ... 
@@ -19,39 +19,76 @@ advisory: "experimental"
19 19 
 ```markdown
20 20 
 Usage:  docker deploy [OPTIONS] STACK
21 21
22 
-Create and update a stack from a Distributed Application Bundle (DAB)
22 
+Deploy a new stack or update an existing stack
23 
+
24 
+Aliases:
25 
+  deploy, up
23 26
24 27 
 Options:
25 
-      --file   string        Path to a Distributed Application Bundle file (Default: STACK.dab)
26 
-      --help                 Print usage
27 
-      --with-registry-auth   Send registry authentication details to swarm agents
28 
+      --bundle-file string    Path to a Distributed Application Bundle file
29 
+      --compose-file string   Path to a Compose file
30 
+      --help                  Print usage
31 
+      --with-registry-auth    Send registry authentication details to Swarm agents
32 
+```
33 
+
34 
+Create and update a stack from a `compose` or a `dab` file on the swarm. This command
35 
+has to be run targeting a manager node.
36 
+
37 
+## Copmose file
38 
+
39 
+The `deploy` command supports compose file version `3.0` and above.
40 
+
41 
+```bash
42 
+$ docker stack deploy --compose-file docker-compose.yml vossibility
43 
+Ignoring unsupported options: links
44 
+
45 
+Creating network vossibility_vossibility
46 
+Creating network vossibility_default
47 
+Creating service vossibility_nsqd
48 
+Creating service vossibility_logstash
49 
+Creating service vossibility_elasticsearch
50 
+Creating service vossibility_kibana
51 
+Creating service vossibility_ghollector
52 
+Creating service vossibility_lookupd
53 
+```
54 
+
55 
+You can verify that the services were correctly created
56 
+
57 
+```
58 
+$ docker service ls
59 
+ID            NAME                               MODE        REPLICAS  IMAGE
60 
+29bv0vnlm903  vossibility_lookupd                replicated  1/1       nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662
61 
+4awt47624qwh  vossibility_nsqd                   replicated  1/1       nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662
62 
+4tjx9biia6fs  vossibility_elasticsearch          replicated  1/1       elasticsearch@sha256:12ac7c6af55d001f71800b83ba91a04f716e58d82e748fa6e5a7359eed2301aa
63 
+7563uuzr9eys  vossibility_kibana                 replicated  1/1       kibana@sha256:6995a2d25709a62694a937b8a529ff36da92ebee74bafd7bf00e6caf6db2eb03
64 
+9gc5m4met4he  vossibility_logstash               replicated  1/1       logstash@sha256:2dc8bddd1bb4a5a34e8ebaf73749f6413c101b2edef6617f2f7713926d2141fe
65 
+axqh55ipl40h  vossibility_vossibility-collector  replicated  1/1       icecrime/vossibility-collector@sha256:f03f2977203ba6253988c18d04061c5ec7aab46bca9dfd89a9a1fa4500989fba
28 66 
 ```
29 67
30 
-Create and update a stack from a `dab` file. This command has to be
31 
-run targeting a manager node.
68 
+## DAB file
32 69
33 70 
 ```bash
34 
-$ docker deploy vossibility-stack
71 
+$ docker stack deploy --bundle-file vossibility-stack.dab vossibility
35 72 
 Loading bundle from vossibility-stack.dab
36 
-Creating service vossibility-stack_elasticsearch
37 
-Creating service vossibility-stack_kibana
38 
-Creating service vossibility-stack_logstash
39 
-Creating service vossibility-stack_lookupd
40 
-Creating service vossibility-stack_nsqd
41 
-Creating service vossibility-stack_vossibility-collector
73 
+Creating service vossibility_elasticsearch
74 
+Creating service vossibility_kibana
75 
+Creating service vossibility_logstash
76 
+Creating service vossibility_lookupd
77 
+Creating service vossibility_nsqd
78 
+Creating service vossibility_vossibility-collector
42 79 
 ```
43 80
44 81 
 You can verify that the services were correctly created:
45 82
46 83 
 ```bash
47 84 
 $ docker service ls
48 
-ID            NAME                                     MODE         REPLICAS    IMAGE
49 
-29bv0vnlm903  vossibility-stack_lookupd                replicated   1/1         nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662
50 
-4awt47624qwh  vossibility-stack_nsqd                   replicated   1/1         nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662
51 
-4tjx9biia6fs  vossibility-stack_elasticsearch          replicated   1/1         elasticsearch@sha256:12ac7c6af55d001f71800b83ba91a04f716e58d82e748fa6e5a7359eed2301aa
52 
-7563uuzr9eys  vossibility-stack_kibana                 replicated   1/1         kibana@sha256:6995a2d25709a62694a937b8a529ff36da92ebee74bafd7bf00e6caf6db2eb03
53 
-9gc5m4met4he  vossibility-stack_logstash               replicated   1/1         logstash@sha256:2dc8bddd1bb4a5a34e8ebaf73749f6413c101b2edef6617f2f7713926d2141fe
54 
-axqh55ipl40h  vossibility-stack_vossibility-collector  replicated   1/1         icecrime/vossibility-collector@sha256:f03f2977203ba6253988c18d04061c5ec7aab46bca9dfd89a9a1fa4500989fba
85 
+ID            NAME                               MODE        REPLICAS  IMAGE
86 
+29bv0vnlm903  vossibility_lookupd                replicated  1/1       nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662
87 
+4awt47624qwh  vossibility_nsqd                   replicated  1/1       nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662
88 
+4tjx9biia6fs  vossibility_elasticsearch          replicated  1/1       elasticsearch@sha256:12ac7c6af55d001f71800b83ba91a04f716e58d82e748fa6e5a7359eed2301aa
89 
+7563uuzr9eys  vossibility_kibana                 replicated  1/1       kibana@sha256:6995a2d25709a62694a937b8a529ff36da92ebee74bafd7bf00e6caf6db2eb03
90 
+9gc5m4met4he  vossibility_logstash               replicated  1/1       logstash@sha256:2dc8bddd1bb4a5a34e8ebaf73749f6413c101b2edef6617f2f7713926d2141fe
91 
+axqh55ipl40h  vossibility_vossibility-collector  replicated  1/1       icecrime/vossibility-collector@sha256:f03f2977203ba6253988c18d04061c5ec7aab46bca9dfd89a9a1fa4500989fba
55 92 
 ```
56 93
57 94 
 ## Related information
docs/reference/commandline/stack_deploy.md
History View file @ 040d4eb
... ... 
@@ -19,42 +19,76 @@ advisory: "experimental"
19 19 
 ```markdown
20 20 
 Usage:  docker stack deploy [OPTIONS] STACK
21 21
22 
-Create and update a stack from a Distributed Application Bundle (DAB)
22 
+Deploy a new stack or update an existing stack
23 23
24 24 
 Aliases:
25 25 
   deploy, up
26 26
27 27 
 Options:
28 
-      --file   string        Path to a Distributed Application Bundle file (Default: STACK.dab)
29 
-      --help                 Print usage
30 
-      --with-registry-auth   Send registry authentication details to swarm agents
28 
+      --bundle-file string    Path to a Distributed Application Bundle file
29 
+      --compose-file string   Path to a Compose file
30 
+      --help                  Print usage
31 
+      --with-registry-auth    Send registry authentication details to Swarm agents
31 32 
 ```
32 33
33 
-Create and update a stack from a `dab` file on the swarm. This command
34 
+Create and update a stack from a `compose` or a `dab` file on the swarm. This command
34 35 
 has to be run targeting a manager node.
35 36
37 
+## Copmose file
38 
+
39 
+The `deploy` command supports compose file version `3.0` and above."
40 
+
41 
+```bash
42 
+$ docker stack deploy --compose-file docker-compose.yml vossibility
43 
+Ignoring unsupported options: links
44 
+
45 
+Creating network vossibility_vossibility
46 
+Creating network vossibility_default
47 
+Creating service vossibility_nsqd
48 
+Creating service vossibility_logstash
49 
+Creating service vossibility_elasticsearch
50 
+Creating service vossibility_kibana
51 
+Creating service vossibility_ghollector
52 
+Creating service vossibility_lookupd
53 
+```
54 
+
55 
+You can verify that the services were correctly created
56 
+
57 
+```
58 
+$ docker service ls
59 
+ID            NAME                               MODE        REPLICAS  IMAGE
60 
+29bv0vnlm903  vossibility_lookupd                replicated  1/1       nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662
61 
+4awt47624qwh  vossibility_nsqd                   replicated  1/1       nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662
62 
+4tjx9biia6fs  vossibility_elasticsearch          replicated  1/1       elasticsearch@sha256:12ac7c6af55d001f71800b83ba91a04f716e58d82e748fa6e5a7359eed2301aa
63 
+7563uuzr9eys  vossibility_kibana                 replicated  1/1       kibana@sha256:6995a2d25709a62694a937b8a529ff36da92ebee74bafd7bf00e6caf6db2eb03
64 
+9gc5m4met4he  vossibility_logstash               replicated  1/1       logstash@sha256:2dc8bddd1bb4a5a34e8ebaf73749f6413c101b2edef6617f2f7713926d2141fe
65 
+axqh55ipl40h  vossibility_vossibility-collector  replicated  1/1       icecrime/vossibility-collector@sha256:f03f2977203ba6253988c18d04061c5ec7aab46bca9dfd89a9a1fa4500989fba
66 
+```
67 
+
68 
+## DAB file
69 
+
36 70 
 ```bash
37 
-$ docker stack deploy vossibility-stack
71 
+$ docker stack deploy --bundle-file vossibility-stack.dab vossibility
38 72 
 Loading bundle from vossibility-stack.dab
39 
-Creating service vossibility-stack_elasticsearch
40 
-Creating service vossibility-stack_kibana
41 
-Creating service vossibility-stack_logstash
42 
-Creating service vossibility-stack_lookupd
43 
-Creating service vossibility-stack_nsqd
44 
-Creating service vossibility-stack_vossibility-collector
73 
+Creating service vossibility_elasticsearch
74 
+Creating service vossibility_kibana
75 
+Creating service vossibility_logstash
76 
+Creating service vossibility_lookupd
77 
+Creating service vossibility_nsqd
78 
+Creating service vossibility_vossibility-collector
45 79 
 ```
46 80
47 81 
 You can verify that the services were correctly created:
48 82
49 83 
 ```bash
50 84 
 $ docker service ls
51 
-ID            NAME                                     MODE        REPLICAS  IMAGE
52 
-29bv0vnlm903  vossibility-stack_lookupd                replicated  1/1       nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662
53 
-4awt47624qwh  vossibility-stack_nsqd                   replicated  1/1       nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662
54 
-4tjx9biia6fs  vossibility-stack_elasticsearch          replicated  1/1       elasticsearch@sha256:12ac7c6af55d001f71800b83ba91a04f716e58d82e748fa6e5a7359eed2301aa
55 
-7563uuzr9eys  vossibility-stack_kibana                 replicated  1/1       kibana@sha256:6995a2d25709a62694a937b8a529ff36da92ebee74bafd7bf00e6caf6db2eb03
56 
-9gc5m4met4he  vossibility-stack_logstash               replicated  1/1       logstash@sha256:2dc8bddd1bb4a5a34e8ebaf73749f6413c101b2edef6617f2f7713926d2141fe
57 
-axqh55ipl40h  vossibility-stack_vossibility-collector  replicated  1/1       icecrime/vossibility-collector@sha256:f03f2977203ba6253988c18d04061c5ec7aab46bca9dfd89a9a1fa4500989fba
85 
+ID            NAME                               MODE        REPLICAS  IMAGE
86 
+29bv0vnlm903  vossibility_lookupd                replicated  1/1       nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662
87 
+4awt47624qwh  vossibility_nsqd                   replicated  1/1       nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662
88 
+4tjx9biia6fs  vossibility_elasticsearch          replicated  1/1       elasticsearch@sha256:12ac7c6af55d001f71800b83ba91a04f716e58d82e748fa6e5a7359eed2301aa
89 
+7563uuzr9eys  vossibility_kibana                 replicated  1/1       kibana@sha256:6995a2d25709a62694a937b8a529ff36da92ebee74bafd7bf00e6caf6db2eb03
90 
+9gc5m4met4he  vossibility_logstash               replicated  1/1       logstash@sha256:2dc8bddd1bb4a5a34e8ebaf73749f6413c101b2edef6617f2f7713926d2141fe
91 
+axqh55ipl40h  vossibility_vossibility-collector  replicated  1/1       icecrime/vossibility-collector@sha256:f03f2977203ba6253988c18d04061c5ec7aab46bca9dfd89a9a1fa4500989fba
58 92 
 ```
59 93
60 94 
 ## Related information