Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix markdown formatting for experimental 

- don't indent code-blocks that use fences
- fixed some formatting
- wrapped long lines to 80-chars
- removed stray empty lines

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2016-06-20 00:12:48 -07:00 committed by Tibor Vass
parent 2f835a732d
commit e80065ae37
1 changed files with 82 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

152
experimental/docker-stacks-and-bundles.md
View File

@ -2,12 +2,17 @@
## Overview ## Overview
Docker Stacks and Distributed Application Bundles are experimental features introduced in Docker 1.12 and Docker Compose 1.8, alongside the concept of swarm mode, and Nodes and Services in the Engine API. Docker Stacks and Distributed Application Bundles are experimental features
introduced in Docker 1.12 and Docker Compose 1.8, alongside the concept of
swarm mode, and Nodes and Services in the Engine API.
A Dockerfile can be built into an image, and containers can be created from that A Dockerfile can be built into an image, and containers can be created from
image. Similarly, a docker-compose.yml can be built into a **distributed application bundle**, and **stacks** can be created from that bundle. In that sense, the bundle is a multi-services distributable image format. that image. Similarly, a docker-compose.yml can be built into a **distributed
application bundle**, and **stacks** can be created from that bundle. In that
sense, the bundle is a multi-services distributable image format.
As of Docker 1.12 and Compose 1.8, the features are experimental. Neither Docker Engine nor the Docker Registry support distribution of bundles. As of Docker 1.12 and Compose 1.8, the features are experimental. Neither
Docker Engine nor the Docker Registry support distribution of bundles.
## Producing a bundle ## Producing a bundle
@ -18,88 +23,92 @@ Docker image.
From `docker-compose`: From `docker-compose`:
```bash ```bash
$ docker-compose bundle $ docker-compose bundle
WARNING: Unsupported key 'network_mode' in services.nsqd - ignoring WARNING: Unsupported key 'network_mode' in services.nsqd - ignoring
WARNING: Unsupported key 'links' in services.nsqd - ignoring WARNING: Unsupported key 'links' in services.nsqd - ignoring
WARNING: Unsupported key 'volumes' in services.nsqd - ignoring WARNING: Unsupported key 'volumes' in services.nsqd - ignoring
[...] [...]
Wrote bundle to vossibility-stack.dsb Wrote bundle to vossibility-stack.dsb
``` ```
## Creating a stack from a bundle ## Creating a stack from a bundle
A stack is created using the `docker deploy` command: A stack is created using the `docker deploy` command:
```bash ```bash
# docker deploy --help # docker deploy --help
Usage: docker deploy [OPTIONS] STACK Usage: docker deploy [OPTIONS] STACK
Create and update a stack Create and update a stack
Options: Options:
-f, --bundle string Path to a bundle (Default: STACK.dsb) -f, --bundle string Path to a bundle (Default: STACK.dsb)
--help Print usage --help Print usage
``` ```
Let's deploy the stack created before: Let's deploy the stack created before:
```bash ```bash
# docker deploy vossibility-stack # docker deploy vossibility-stack
Loading bundle from vossibility-stack.dsb Loading bundle from vossibility-stack.dsb
Creating service vossibility-stack_elasticsearch Creating service vossibility-stack_elasticsearch
Creating service vossibility-stack_kibana Creating service vossibility-stack_kibana
Creating service vossibility-stack_logstash Creating service vossibility-stack_logstash
Creating service vossibility-stack_lookupd Creating service vossibility-stack_lookupd
Creating service vossibility-stack_nsqd Creating service vossibility-stack_nsqd
Creating service vossibility-stack_vossibility-collector Creating service vossibility-stack_vossibility-collector
``` ```
We can verify that services were correctly created: We can verify that services were correctly created:
```bash ```bash
# docker service ls # docker service ls
ID NAME REPLICAS IMAGE ID NAME REPLICAS IMAGE
COMMAND COMMAND
29bv0vnlm903 vossibility-stack_lookupd 1 nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662 /nsqlookupd 29bv0vnlm903 vossibility-stack_lookupd 1 nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662 /nsqlookupd
4awt47624qwh vossibility-stack_nsqd 1 nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662 /nsqd --data-path=/data --lookupd-tcp-address=lookupd:4160 4awt47624qwh vossibility-stack_nsqd 1 nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662 /nsqd --data-path=/data --lookupd-tcp-address=lookupd:4160
4tjx9biia6fs vossibility-stack_elasticsearch 1 elasticsearch@sha256:12ac7c6af55d001f71800b83ba91a04f716e58d82e748fa6e5a7359eed2301aa 4tjx9biia6fs vossibility-stack_elasticsearch 1 elasticsearch@sha256:12ac7c6af55d001f71800b83ba91a04f716e58d82e748fa6e5a7359eed2301aa
7563uuzr9eys vossibility-stack_kibana 1 kibana@sha256:6995a2d25709a62694a937b8a529ff36da92ebee74bafd7bf00e6caf6db2eb03 7563uuzr9eys vossibility-stack_kibana 1 kibana@sha256:6995a2d25709a62694a937b8a529ff36da92ebee74bafd7bf00e6caf6db2eb03
9gc5m4met4he vossibility-stack_logstash 1 logstash@sha256:2dc8bddd1bb4a5a34e8ebaf73749f6413c101b2edef6617f2f7713926d2141fe logstash -f /etc/logstash/conf.d/logstash.conf 9gc5m4met4he vossibility-stack_logstash 1 logstash@sha256:2dc8bddd1bb4a5a34e8ebaf73749f6413c101b2edef6617f2f7713926d2141fe logstash -f /etc/logstash/conf.d/logstash.conf
axqh55ipl40h vossibility-stack_vossibility-collector 1 icecrime/vossibility-collector@sha256:f03f2977203ba6253988c18d04061c5ec7aab46bca9dfd89a9a1fa4500989fba --config /config/config.toml --debug axqh55ipl40h vossibility-stack_vossibility-collector 1 icecrime/vossibility-collector@sha256:f03f2977203ba6253988c18d04061c5ec7aab46bca9dfd89a9a1fa4500989fba --config /config/config.toml --debug
``` ```
## Managing stacks ## Managing stacks
Tasks are managed using the `docker stack` command: Tasks are managed using the `docker stack` command:
```bash ```bash
# docker stack --help # docker stack --help
Usage: docker stack COMMAND Usage: docker stack COMMAND
Manage Docker stacks Manage Docker stacks
Options: Options:
--help Print usage --help Print usage
Commands: Commands:
config Print the stack configuration config Print the stack configuration
deploy Create and update a stack deploy Create and update a stack
rm Remove the stack rm Remove the stack
tasks List the tasks in the stack tasks List the tasks in the stack
Run 'docker stack COMMAND --help' for more information on a command. Run 'docker stack COMMAND --help' for more information on a command.
``` ```
## Bundle file format ## Bundle file format
Distributed application bundles are described in a JSON format. When bundles are persisted as files, the file extension is `.dab` (Docker 1.12RC2 tools use `.dsb` for the file extension—this will be updated in the next release client). Distributed application bundles are described in a JSON format. When bundles
are persisted as files, the file extension is `.dab` (Docker 1.12RC2 tools use
`.dsb` for the file extension—this will be updated in the next release client).
A bundle has two top-level fields: `version` and `services`. The version used by Docker 1.12 tools is `0.1`. A bundle has two top-level fields: `version` and `services`. The version used
by Docker 1.12 tools is `0.1`.
`services` in the bundle are the services that comprise the app. They correspond to the new `Service` object introduced in the 1.12 Docker Engine API. `services` in the bundle are the services that comprise the app. They
correspond to the new `Service` object introduced in the 1.12 Docker Engine API.
A service has the following fields: A service has the following fields:
@ -108,42 +117,44 @@ A service has the following fields:
Image (required) <code>string</code> Image (required) <code>string</code>
</dt> </dt>
<dd> <dd>
The image that the service will run. Docker images should be referenced with full content hash to fully specify the deployment artifact for the service. Example: <code>postgres@sha256:f76245b04ddbcebab5bb6c28e76947f49222c99fec4aadb0bb1c24821a9e83ef</code> The image that the service will run. Docker images should be referenced
with full content hash to fully specify the deployment artifact for the
service. Example:
<code>postgres@sha256:f76245b04ddbcebab5bb6c28e76947f49222c99fec4aadb0bb
1c24821a 9e83ef</code>
</dd> </dd>
<dt> <dt>
Command <code>[]string</code> Command <code>[]string</code>
</dt> </dt>
<dd> <dd>
Command to run in service containers. Command to run in service containers.
</dd> </dd>
<dt> <dt>
Args <code>[]string</code> Args <code>[]string</code>
</dt> </dt>
<dd> <dd>
Arguments passed to the service containers. Arguments passed to the service containers.
</dd> </dd>
<dt> <dt>
Env <code>[]string</code> Env <code>[]string</code>
</dt> </dt>
<dd> <dd>
Environment variables. Environment variables.
</dd> </dd>
<dt> <dt>
Labels <code>map[string]string</code> Labels <code>map[string]string</code>
</dt> </dt>
<dd> <dd>
Labels used for setting meta data on services. Labels used for setting meta data on services.
</dd> </dd>
<dt> <dt>
Ports <code>[]Port</code> Ports <code>[]Port</code>
</dt> </dt>
<dd> <dd>
Service ports (composed of `Port` (`int`) and `Protocol` (`string`). A service description can only specify the container port to be exposed. These ports can be mapped on runtime hosts at the operator's discretion. Service ports (composed of <code>Port</code> (<code>int</code>) and
<code>Protocol</code> (<code>string</code>). A service description can
only specify the container port to be exposed. These ports can be
mapped on runtime hosts at the operator's discretion.
</dd> </dd>
<dt> <dt>
@ -157,14 +168,15 @@ The image that the service will run. Docker images should be referenced with ful
User <code>string</code> User <code>string</code>
</dt> </dt>
<dd> <dd>
Username or UID (format: <name|uid>[:<group|gid>]). Username or UID (format: <code>&lt;name|uid&gt;[:&lt;group|gid&gt;]</code>).
</dd> </dd>
<dt> <dt>
Networks <code>[]string</code> Networks <code>[]string</code>
</dt> </dt>
<dd> <dd>
Networks that the service containers should be connected to. An entity deploying a bundle should create networks as needed. Networks that the service containers should be connected to. An entity
deploying a bundle should create networks as needed.
</dd> </dd>
</dl> </dl>