From 8e3748cd8d8c7afd0c4d6a866495aaa8cc01431a Mon Sep 17 00:00:00 2001 From: yeasy Date: Tue, 20 Dec 2016 15:35:52 +0800 Subject: [PATCH] Updates Compose usage --- README.md | 13 +- SUMMARY.md | 3 +- compose/commands.md | 214 +++++++++++++----- compose/install.md | 161 ++++++++++--- compose/intro.md | 24 +- compose/yaml_file.md | 523 +++++++++++++++++++++++++++++++------------ 6 files changed, 696 insertions(+), 242 deletions(-) diff --git a/README.md b/README.md index 53ea0b7..11d203a 100644 --- a/README.md +++ b/README.md @@ -38,19 +38,23 @@ ## 主要版本历史 * 0.8.0: 2016-MM-DD + * 修正文字内容 * 根据最新版本修订安装使用 * 补充附录章节 * 0.7.0: 2016-06-12 + * 根据最新版本进行命令调整 * 修正若干文字描述 * 0.6.0: 2015-12-24 + * 补充 Machine 项目 * 修正若干 bug * 0.5.0: 2015-06-29 + * 添加 Compose 项目 * 添加 Machine 项目 * 添加 Swarm 项目 @@ -58,12 +62,14 @@ * 添加 Mesos 项目内容 * 0.4.0: 2015-05-08 + * 添加 Etcd 项目 * 添加 Fig 项目 * 添加 CoreOS 项目 * 添加 Kubernetes 项目 * 0.3.0: 2014-11-25 + * 完成仓库章节； * 重写安全章节； * 修正底层实现章节的架构、命名空间、控制组、文件系统、容器格式等内容； @@ -74,21 +80,23 @@ * 发布繁体版本分支：zh-Hant。 * 0.2.0: 2014-09-18 + * 对照官方文档重写介绍、基本概念、安装、镜像、容器、仓库、数据管理、网络等章节； * 添加底层实现章节； * 添加命令查询和资源链接章节； * 其它修正。 * 0.1.0: 2014-09-05 + * 添加基本内容; * 修正错别字和表达不通顺的地方。 - Docker 自身仍在快速发展中，生态环境也在蓬勃成长。源码开源托管在 Github 上，欢迎参与维护：[https:\/\/github.com\/yeasy\/docker\_practice](https://github.com/yeasy/docker_practice)。贡献者 [名单](https://github.com/yeasy/docker_practice/graphs/contributors)。 ## 参加步骤 * 在 GitHub 上 `fork` 到自己的仓库，如 `docker_user/docker_practice`，然后 `clone` 到本地，并设置用户信息。 + ``` $ git clone git@github.com:docker_user/docker_practice.git $ cd docker_practice @@ -97,6 +105,7 @@ Docker 自身仍在快速发展中，生态环境也在蓬勃成长。源码开 ``` * 修改代码后提交，并推送到自己的仓库。 + ``` $ #do some change on the content $ git commit -am "Fix issue #1: change helo to hello" @@ -104,6 +113,7 @@ Docker 自身仍在快速发展中，生态环境也在蓬勃成长。源码开 ``` * 在 GitHub 网站上提交 pull request。 + * 定期使用项目仓库内容更新自己仓库内容。 ``` $ git remote add upstream https://github.com/yeasy/docker_practice @@ -114,3 +124,4 @@ Docker 自身仍在快速发展中，生态环境也在蓬勃成长。源码开 ``` + diff --git a/SUMMARY.md b/SUMMARY.md index 4694c1f..3c69693 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -84,7 +84,7 @@ * [网络](underly/network.md) * [Docker Compose 项目](compose/README.md) * [简介](compose/intro.md) - * [安装](compose/install.md) + * [安装与卸载](compose/install.md) * [使用](compose/usage.md) * [命令说明](compose/commands.md) * [YAML 模板文件](compose/yaml_file.md) @@ -134,3 +134,4 @@ * [Node.js](appendix/repo/nodejs.md) * [附录三：Docker 命令查询](appendix/command/README.md) * [附录四：资源链接](appendix/resources/README.md) + diff --git a/compose/commands.md b/compose/commands.md index 2c9e5c8..e42de91 100644 --- a/compose/commands.md +++ b/compose/commands.md @@ -1,142 +1,234 @@ ## Compose 命令说明 -大部分命令都可以运行在一个或多个服务上。如果没有特别的说明，命令则应用在项目所有的服务上。 +### 命令对象与格式 +对于 Compose 来说，大部分命令的对象既可以是项目本身，也可以指定为项目中的服务或者容器。如果没有特别的说明，命令对象将是项目，这意味着项目中所有的服务都会受到命令影响。 -执行 `docker-compose [COMMAND] --help` 查看具体某个命令的使用说明。 +执行 `docker-compose [COMMAND] --help` 或者 `docker-compose help [COMMAND]` 可以查看具体某个命令的使用格式。 -基本的使用格式是 -```bash -docker-compose [options] [COMMAND] [ARGS...] +Compose 命令的基本的使用格式是 + +```sh +docker-compose [-f=...] [options] [COMMAND] [ARGS...] ``` -## 选项 +### 命令选项 +* `-f, --file FILE` 指定使用的 Compose 模板文件，默认为 `docker-compose.yml`，可以多次指定。 +* `-p, --project-name NAME` 指定项目名称，默认将使用所在目录名称作为项目名。 +* `--x-networking` 使用 Docker 的可拔插网络后端特性（需要 Docker 1.9 及以后版本）。 +* `--x-network-driver DRIVER` 指定网络后端的驱动，默认为 `bridge`（需要 Docker 1.9 及以后版本）。 * `--verbose` 输出更多调试信息。 -* `--version` 打印版本并退出。 -* `-f, --file FILE` 使用特定的 compose 模板文件，默认为 `docker-compose.yml`。 -* `-p, --project-name NAME` 指定项目名称，默认使用目录名称。 +* `-v, --version` 打印版本并退出。 -## 命令 +### 命令使用说明 -### `build` +#### `build` +格式为 `docker-compose build [options] [SERVICE...]`。 -构建或重新构建服务。 +构建（重新构建）项目中的服务容器。 -服务一旦构建后，将会带上一个标记名，例如 web_db。 +服务容器一旦构建后，将会带上一个标记名，例如对于 web 项目中的一个 db 容器，可能是 web_db。 可以随时在项目目录下运行 `docker-compose build` 来重新构建服务。 -### `help` +选项包括： + +* `--force-rm` 删除构建过程中的临时容器。 +* `--no-cache` 构建镜像过程中不使用 cache（这将加长构建过程）。 +* `--pull` 始终尝试通过 pull 来获取更新版本的镜像。 + +#### `help` 获得一个命令的帮助。 -### `kill` +#### `kill` +格式为 `docker-compose kill [options] [SERVICE...]`。 -通过发送 `SIGKILL` 信号来强制停止服务容器。支持通过参数来指定发送的信号，例如 -```bash +通过发送 `SIGKILL` 信号来强制停止服务容器。 + +支持通过 `-s` 参数来指定发送的信号，例如通过如下指令发送 `SIGINT` 信号。 + +```sh $ docker-compose kill -s SIGINT ``` -### `logs` +#### `logs` +格式为 `docker-compose logs [options] [SERVICE...]`。 -查看服务的输出。 +查看服务容器的输出。默认情况下，docker-compose 将对不同的服务输出使用不同的颜色来区分。可以通过 `--no-color` 来关闭颜色。 -### `port` +该命令在调试问题的时候十分有用。 -打印绑定的公共端口。 +#### `pause` +格式为 `docker-compose pause [SERVICE...]`。 -### `ps` +暂停一个服务容器。 -列出所有容器。 +#### `port` +格式为 `docker-compose port [options] SERVICE PRIVATE_PORT`。 -### `pull` +打印某个容器端口所映射的公共端口。 -拉取服务镜像。 +选项： -### `rm` +* `--protocol=proto` 指定端口协议，tcp（默认值）或者 udp。 +* `--index=index` 如果同一服务存在多个容器，指定命令对象容器的序号（默认为 1）。 -删除停止的服务容器。 +#### `ps` +格式为 `docker-compose ps [options] [SERVICE...]`。 -### `run` +列出项目中目前的所有容器。 -在一个服务上执行一个命令。 +选项： + +* `-q` 只打印容器的 ID 信息。 + +#### `pull` +格式为 `docker-compose pull [options] [SERVICE...]`。 + +拉取服务依赖的镜像。 + +选项： + +* `--ignore-pull-failures` 忽略拉取镜像过程中的错误。 + +#### `restart` +格式为 `docker-compose restart [options] [SERVICE...]`。 + +重启项目中的服务。 + +选项： + +* `-t, --timeout TIMEOUT` 指定重启前停止容器的超时（默认为 10 秒）。 + +#### `rm` +格式为 `docker-compose rm [options] [SERVICE...]`。 + +删除所有（停止状态的）服务容器。推荐先执行 `docker-compose stop` 命令来停止容器。 + +选项： + +* `-f, --force` 强制直接删除，包括非停止状态的容器。一般尽量不要使用该选项。 +* `-v` 删除容器所挂载的数据卷。 + +#### `run` +格式为 `docker-compose run [options] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]`。 + +在指定服务上执行一个命令。 例如： -``` +```sh $ docker-compose run ubuntu ping docker.com ``` -将会启动一个 ubuntu 服务，执行 `ping docker.com` 命令。 +将会启动一个 ubuntu 服务容器，并执行 `ping docker.com` 命令。 -默认情况下，所有关联的服务将会自动被启动，除非这些服务已经在运行中。 +默认情况下，如果存在关联，则所有关联的服务将会自动被启动，除非这些服务已经在运行中。 -该命令类似启动容器后运行指定的命令，相关卷、链接等等都将会按照期望创建。 +该命令类似启动容器后运行指定的命令，相关卷、链接等等都将会按照配置自动创建。 两个不同点： + * 给定命令将会覆盖原有的自动运行命令； * 不会自动创建端口，以避免冲突。 如果不希望自动启动关联的容器，可以使用 `--no-deps` 选项，例如 -``` +```sh $ docker-compose run --no-deps web python manage.py shell ``` 将不会启动 web 容器所关联的其它容器。 -### `scale` +选项： -设置同一个服务运行的容器个数。 +* `-d` 后台运行容器。 +* `--name NAME` 为容器指定一个名字。 +* `--entrypoint CMD` 覆盖默认的容器启动指令。 +* `-e KEY=VAL` 设置环境变量值，可多次使用选项来设置多个环境变量。 +* `-u, --user=""` 指定运行容器的用户名或者 uid。 +* `--no-deps` 不自动启动关联的服务容器。 +* `--rm` 运行命令后自动删除容器，`d` 模式下将忽略。 +* `-p, --publish=[]` 映射容器端口到本地主机。 +* `--service-ports` 配置服务端口并映射到本地主机。 +* `-T` 不分配伪 tty，意味着依赖 tty 的指令将无法运行。 + +#### `scale` +格式为 `docker-compose scale [options] [SERVICE=NUM...]`。 + +设置指定服务运行的容器个数。 通过 `service=num` 的参数来设置数量。例如： -``` -$ docker-compose scale web=2 worker=3 +```sh +$ docker-compose scale web=3 db=2 ``` -### `start` +将启动 3 个容器运行 web 服务，2 个容器运行 db 服务。 -启动一个已经存在的服务容器。 +一般的，当指定数目多于该服务当前实际运行容器，将新创建并启动容器；反之，将停止容器。 -### `stop` +选项： -停止一个已经运行的容器，但不删除它。通过 `docker-compose start` 可以再次启动这些容器。 +* `-t, --timeout TIMEOUT` 停止容器时候的超时（默认为 10 秒）。 -### `up` +#### `start` +格式为 `docker-compose start [SERVICE...]`。 -构建，（重新）创建，启动，链接一个服务相关的容器。 +启动已经存在的服务容器。 -链接的服务都将会启动，除非他们已经运行。 +#### `stop` +格式为 `docker-compose stop [options] [SERVICE...]`。 -默认情况， `docker-compose up` 将会整合所有容器的输出，并且退出时，所有容器将会停止。 +停止已经处于运行状态的容器，但不删除它。通过 `docker-compose start` 可以再次启动这些容器。 -如果使用 `docker-compose up -d` ，将会在后台启动并运行所有的容器。 +选项： -默认情况，如果该服务的容器已经存在， `docker-compose up` 将会停止并尝试重新创建他们（保持使用 `volumes-from` 挂载的卷），以保证 `docker-compose.yml` 的修改生效。如果你不想容器被停止并重新创建，可以使用 `docker-compose up --no-recreate`。如果需要的话，这样将会启动已经停止的容器。 +* `-t, --timeout TIMEOUT` 停止容器时候的超时（默认为 10 秒）。 -## 环境变量 +#### `unpause` +格式为 `docker-compose unpause [SERVICE...]`。 -环境变量可以用来配置 Compose 的行为。 +恢复处于暂停状态中的服务。 -以`DOCKER_`开头的变量和用来配置 Docker 命令行客户端的使用一样。如果使用 boot2docker , `$(boot2docker shellinit)` 将会设置它们为正确的值。 +#### `up` +格式为 `docker-compose up [options] [SERVICE...]`。 -### `COMPOSE_PROJECT_NAME` +该命令十分强大，它将尝试自动完成包括构建镜像，（重新）创建服务，启动服务，并关联服务相关容器的一系列操作。 -设置通过 Compose 启动的每一个容器前添加的项目名称，默认是当前工作目录的名字。 +链接的服务都将会被自动启动，除非已经处于运行状态。 -### `COMPOSE_FILE` +可以说，大部分时候都可以直接通过该命令来启动一个项目。 -设置要使用的 `docker-compose.yml` 的路径。默认路径是当前工作目录。 +默认情况，`docker-compose up` 启动的容器都在前台，控制台将会同时打印所有容器的输出信息，可以很方便进行调试。 -### `DOCKER_HOST` +当通过 `Ctrl-C` 停止命令时，所有容器将会停止。 -设置 Docker daemon 的地址。默认使用 `unix:///var/run/docker.sock`，与 Docker 客户端采用的默认值一致。 +如果使用 `docker-compose up -d`，将会在后台启动并运行所有的容器。一般推荐生产环境下使用该选项。 -### `DOCKER_TLS_VERIFY` +默认情况，如果服务容器已经存在，`docker-compose up` 将会尝试停止容器，然后重新创建（保持使用 `volumes-from` 挂载的卷），以保证新启动的服务匹配 `docker-compose.yml` 文件的最新内容。如果用户不希望容器被停止并重新创建，可以使用 `docker-compose up --no-recreate`。这样将只会启动处于停止状态的容器，而忽略已经运行的服务。如果用户只想重新部署某个服务，可以使用 `docker-compose up --no-deps -d ` 来重新创建服务并后台停止旧服务，启动新服务，并不会影响到其所依赖的服务。 -如果设置不为空，则与 Docker daemon 交互通过 TLS 进行。 +选项： -### `DOCKER_CERT_PATH` +* `-d` 在后台运行服务容器。 +* `--no-color` 不使用颜色来区分不同的服务的控制台输出。 +* `--no-deps` 不启动服务所链接的容器。 +* `--force-recreate` 强制重新创建容器，不能与 `--no-recreate` 同时使用。 +* `--no-recreate` 如果容器已经存在了，则不重新创建，不能与 `--force-recreate` 同时使用。 +* `--no-build` 不自动构建缺失的服务镜像。 +* `-t, --timeout TIMEOUT` 停止容器时候的超时（默认为 10 秒）。 -配置 TLS 通信所需要的验证（`ca.pem`、`cert.pem` 和 `key.pem`）文件的路径，默认是 `~/.docker` 。 +#### `migrate-to-labels` +格式为 `docker-compose migrate-to-labels`。 + +重新创建容器，并添加 label。 + +主要用于升级 1.2 及更早版本中创建的容器，添加缺失的容器标签。 + +实际上，最彻底的办法当然是删除项目，然后重新创建。 + +#### `version` +格式为 `docker-compose version`。 + +打印版本信息。 \ No newline at end of file diff --git a/compose/install.md b/compose/install.md index 846b513..da2c9ff 100644 --- a/compose/install.md +++ b/compose/install.md @@ -1,63 +1,164 @@ -## 安装 +## 安装与卸载 -安装 Compose 之前，要先安装 Docker，在此不再赘述。 +Compose 目前支持 Linux 和 Mac OS 平台，两者的安装过程大同小异。 + +安装 Compose 之前，要先安装 Docker（需要 Docker Engine 1.7.1+），请参考第一部分中章节，在此不再赘述。 + +Compose 可以通过 Python 的 pip 工具进行安装，可以直接下载编译好的二进制文件使用，甚至直接运行在 Docker 容器中。 + +前两种方式是传统方式，适合本地环境下安装使用；最后一种方式则不破坏系统环境，更适合云计算场景。 ### PIP 安装 -这种方式最为推荐。 +这种方式是将 Compose 当作一个 Python 应用来从 pip 源中安装。 -执行命令。 -```bash +执行安装命令： + +```sh $ sudo pip install -U docker-compose ``` +可以看到类似如下输出，说明安装成功。 +```sh +Collecting docker-compose + Downloading docker-compose-1.8.0.tar.gz (149kB): 149kB downloaded +... +Successfully installed docker-compose cached-property requests texttable websocket-client docker-py dockerpty six enum34 backports.ssl-match-hostname ipaddress +``` + 安装成功后，可以查看 `docker-compose` 命令的用法。 -```bash +```sh $ docker-compose -h -Fast, isolated development environments using Docker. +Define and run multi-container applications with Docker. Usage: - docker-compose [options] [COMMAND] [ARGS...] + docker-compose [-f=...] [options] [COMMAND] [ARGS...] docker-compose -h|--help Options: - --verbose Show more output - --version Print version and exit -f, --file FILE Specify an alternate compose file (default: docker-compose.yml) -p, --project-name NAME Specify an alternate project name (default: directory name) + --x-networking (EXPERIMENTAL) Use new Docker networking functionality. + Requires Docker 1.9 or later. + --x-network-driver DRIVER (EXPERIMENTAL) Specify a network driver (default: "bridge"). + Requires Docker 1.9 or later. + --verbose Show more output + -v, --version Print version and exit Commands: - build Build or rebuild services - help Get help on a command - kill Kill containers - logs View output from containers - port Print the public port for a port binding - ps List containers - pull Pulls service images - rm Remove stopped containers - run Run a one-off command - scale Set number of containers for a service - start Start services - stop Stop services - restart Restart services - up Create and start containers + build Build or rebuild services + help Get help on a command + kill Kill containers + logs View output from containers + pause Pause services + port Print the public port for a port binding + ps List containers + pull Pulls service images + restart Restart services + rm Remove stopped containers + run Run a one-off command + scale Set number of containers for a service + start Start services + stop Stop services + unpause Unpause services + up Create and start containers + migrate-to-labels Recreate containers to add labels + version Show the Docker-Compose version information ``` 之后，可以添加 bash 补全命令。 -```bash -$ curl -L https://raw.githubusercontent.com/docker/compose/1.2.0/contrib/completion/bash/docker-compose > /etc/bash_completion.d/docker-compose +```sh +$ curl -L https://raw.githubusercontent.com/docker/compose/1.8.0/contrib/completion/bash/docker-compose > /etc/bash_completion.d/docker-compose ``` ### 二进制包 -发布的二进制包可以在 [https://github.com/docker/compose/releases](https://github.com/docker/compose/releases) 找到。 +官方定义编译好二进制包，供大家使用。这些发布的二进制包可以在 [https://github.com/docker/compose/releases](https://github.com/docker/compose/releases) 页面找到。 -下载后直接放到执行路径即可。 +这些二进制文件，下载后直接放到执行路径下，并添加执行权限即可。 -例如，在常见的 Linux 平台上。 +例如，在 Linux 平台上。 ``` -$ sudo curl -L https://github.com/docker/compose/releases/download/1.2.0/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose +$ sudo curl -L https://github.com/docker/compose/releases/download/1.8.0/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose $ sudo chmod a+x /usr/local/bin/docker-compose ``` +可以使用 `docker-compose version` 命令来查看版本信息，以测试是否安装成功。 +```sh +$ docker-compose version +docker-compose version 1.8.0, build 94f7016 +docker-py version: 1.9.0 +CPython version: 2.7.6 +OpenSSL version: OpenSSL 1.0.1f 6 Jan 2014 +``` + +### 容器中执行 + +Compose 既然是一个 Python 应用，自然也可以直接用容器来执行它。 + +```sh +$ curl -L https://github.com/docker/compose/releases/download/1.8.0/run.sh > /usr/local/bin/docker-compose +$ chmod +x /usr/local/bin/docker-compose +``` + +实际上，查看下载的 `run.sh` 脚本内容，如下 + +```sh +set -e + +VERSION="1.8.0" +IMAGE="docker/compose:$VERSION" + + +# Setup options for connecting to docker host +if [ -z "$DOCKER_HOST" ]; then + DOCKER_HOST="/var/run/docker.sock" +fi +if [ -S "$DOCKER_HOST" ]; then + DOCKER_ADDR="-v $DOCKER_HOST:$DOCKER_HOST -e DOCKER_HOST" +else + DOCKER_ADDR="-e DOCKER_HOST -e DOCKER_TLS_VERIFY -e DOCKER_CERT_PATH" +fi + + +# Setup volume mounts for compose config and context +if [ "$(pwd)" != '/' ]; then + VOLUMES="-v $(pwd):$(pwd)" +fi +if [ -n "$COMPOSE_FILE" ]; then + compose_dir=$(dirname $COMPOSE_FILE) +fi +# TODO: also check --file argument +if [ -n "$compose_dir" ]; then + VOLUMES="$VOLUMES -v $compose_dir:$compose_dir" +fi +if [ -n "$HOME" ]; then + VOLUMES="$VOLUMES -v $HOME:$HOME -v $HOME:/root" # mount $HOME in /root to share docker.config +fi + +# Only allocate tty if we detect one +if [ -t 1 ]; then + DOCKER_RUN_OPTIONS="-t" +fi +if [ -t 0 ]; then + DOCKER_RUN_OPTIONS="$DOCKER_RUN_OPTIONS -i" +fi + +exec docker run --rm $DOCKER_RUN_OPTIONS $DOCKER_ADDR $COMPOSE_OPTIONS $VOLUMES -w "$(pwd)" $IMAGE "$@" +``` + +可以看到，它其实是下载了 `docker/compose` 镜像并运行。 + +### 卸载 +如果是二进制包方式安装的，删除二进制文件即可。 + +```sh +$ sudo rm /usr/local/bin/docker-compose +``` + +如果是通过 python pip 工具安装的，则可以执行如下命令删除。 + +```sh +$ sudo pip uninstall docker-compose +``` \ No newline at end of file diff --git a/compose/intro.md b/compose/intro.md index 0f9ce26..6321bad 100644 --- a/compose/intro.md +++ b/compose/intro.md @@ -1,10 +1,22 @@ -## 简介 -Compose 项目目前在 [Github](https://github.com/docker/compose) 上进行维护，目前最新版本是 1.2.0。 +## Compose 简介 -Compose 定位是“defining and running complex applications with Docker”，前身是 Fig，兼容 Fig 的模板文件。 +![Docker Compose 项目](../_images/docker_compose.jpg) -Dockerfile 可以让用户管理一个单独的应用容器；而 Compose 则允许用户在一个模板（YAML 格式）中定义一组相关联的应用容器（被称为一个 `project`，即项目），例如一个 Web 服务容器再加上后端的数据库服务容器等。 +Compose 项目是 Docker 官方的开源项目，负责实现对 Docker 容器集群的快速编排。从功能上看，跟 OpenStack 中的 Heat 十分类似。 -![](../_images/docker_compose.jpg) +其代码目前在 [https://github.com/docker/compose](https://github.com/docker/compose) 上开源。 -该项目由 Python 编写，实际上调用了 Docker 提供的 API 来实现。 +Compose 定位是 “定义和运行多个 Docker 容器的应用（Defining and running multi-container Docker applications）”，其前身是开源项目 Fig，目前仍然兼容 Fig 格式的模板文件。 + +通过第一部分中的介绍，我们知道使用一个 Dockerfile 模板文件，可以让用户很方便的定义一个单独的应用容器。然而，在日常工作中，经常会碰到需要多个容器相互配合来完成某项任务的情况。例如要实现一个 Web 项目，除了 Web 服务容器本身，往往还需要再加上后端的数据库服务容器，甚至还包括负载均衡容器等。 + +Compose 恰好满足了这样的需求。它允许用户通过一个单独的 `docker-compose.yml` 模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）。 + +Compose 中有两个重要的概念： + +* 服务（service）：一个应用的容器，实际上可以包括若干运行相同镜像的容器实例。 +* 项目(project)：由一组关联的应用容器组成的一个完整业务单元，在 `docker-compose.yml` 文件中定义。 + +Compose 的默认管理对象是项目，通过子命令对项目中的一组容器进行便捷地生命周期管理。 + +Compose 项目由 Python 编写，实现上调用了 Docker 服务提供的 API 来对容器进行管理。因此，只要所操作的平台支持 Docker API，就可以在其上利用 Compose 来进行编排管理。 diff --git a/compose/yaml_file.md b/compose/yaml_file.md index b58f5e7..0e5bee2 100644 --- a/compose/yaml_file.md +++ b/compose/yaml_file.md @@ -1,144 +1,143 @@ -## YAML 模板文件 +## Compose 模板文件 -默认的模板文件是 `docker-compose.yml`，其中定义的每个服务都必须通过 `image` 指令指定镜像或 `build` 指令（需要 Dockerfile）来自动构建。 +模板文件是使用 Compose 的核心，涉及到的指令关键字也比较多。但大家不用担心，这里面大部分指令跟 `docker run` 相关参数的含义都是类似的。 -其它大部分指令都跟 `docker run` 中的类似。 +默认的模板文件名称为 `docker-compose.yml`，格式为 YAML 格式。 + +在旧版本（版本 1）中，其中每个顶级元素为服务名称，次级元素为服务容器的配置信息，例如 + +```yaml +webapp: + image: examples/web + ports: + - "80:80" + volumes: + - "/data" +``` + +版本 2 扩展了 Compose 的语法，同时尽量保持跟版本 1 的兼容，除了可以声明网络和存储信息外，最大的不同一是添加了版本信息，另一个是需要将所有的服务放到 `services` 根下面。 + +例如，上面例子改写为版本 2，内容为 + +```yaml +version: "2" +services: + webapp: + image: examples/web + ports: + - "80:80" + volumes: + - "/data" +``` + + +注意每个服务都必须通过 `image` 指令指定镜像或 `build` 指令（需要 Dockerfile）等来自动构建生成镜像。 如果使用 `build` 指令，在 `Dockerfile` 中设置的选项(例如：`CMD`, `EXPOSE`, `VOLUME`, `ENV` 等) 将会自动被获取，无需在 `docker-compose.yml` 中再次设置。 -### `image` - -指定为镜像名称或镜像 ID。如果镜像在本地不存在，`Compose` 将会尝试拉去这个镜像。 - -例如： -```bash -image: ubuntu -image: orchardup/postgresql -image: a4bc65fd -``` +下面分别介绍各个指令的用法。 ### `build` -指定 `Dockerfile` 所在文件夹的路径。 `Compose` 将会利用它自动构建这个镜像，然后使用这个镜像。 +指定 `Dockerfile` 所在文件夹的路径（可以是绝对路径，或者相对 docker-compose.yml 文件的路径）。 `Compose` 将会利用它自动构建这个镜像，然后使用这个镜像。 ``` build: /path/to/build/dir ``` +### `cap_add, cap_drop` +指定容器的内核能力（capacity）分配。 + +例如，让容器拥有所有能力可以指定为： + +```yml +cap_add: + - ALL +``` + +去掉 NET_ADMIN 能力可以指定为： + +```yml +cap_drop: + - NET_ADMIN +``` + ### `command` 覆盖容器启动后默认执行的命令。 -```bash -command: bundle exec thin -p 3000 +```sh +command: echo "hello world" ``` -### `links` +### `cgroup_parent` +指定父 cgroup 组，意味着将继承该组的资源限制。 -链接到其它服务中的容器。使用服务名称（同时作为别名）或服务名称：服务别名 `（SERVICE:ALIAS）` 格式都可以。 +例如，创建了一个 cgroup 组名称为 `cgroups_1`。 -```bash -links: - - db - - db:database - - redis +```yml +cgroup_parent: cgroups_1 ``` -使用的别名将会自动在服务容器中的 `/etc/hosts` 里创建。例如： +### `container_name` +指定容器名称。默认将会使用 `项目名称_服务名称_序号` 这样的格式。 -```bash -172.17.2.186 db -172.17.2.186 database -172.17.2.187 redis +例如： +```yml +container_name: docker-web-container ``` -相应的环境变量也将被创建。 +需要注意，指定容器名称后，该服务将无法进行扩展（scale），因为 Docker 不允许多个容器具有相同的名称。 -### `external_links` -链接到 docker-compose.yml 外部的容器，甚至 并非 `Compose` 管理的容器。参数格式跟 `links` 类似。 +### `devices` +指定设备映射关系。 -``` -external_links: - - redis_1 - - project_db_1:mysql - - project_db_1:postgresql +例如： +```yml +devices: + - "/dev/ttyUSB1:/dev/ttyUSB0" ``` +### `dns` -### `ports` +自定义 DNS 服务器。可以是一个值，也可以是一个列表。 -暴露端口信息。 - -使用宿主：容器 `（HOST:CONTAINER）`格式或者仅仅指定容器的端口（宿主将会随机选择端口）都可以。 - -``` -ports: - - "3000" - - "8000:8000" - - "49100:22" - - "127.0.0.1:8001:8001" +```sh +dns: 8.8.8.8 +dns: + - 8.8.8.8 + - 9.9.9.9 ``` -*注：当使用 `HOST:CONTAINER` 格式来映射端口时，如果你使用的容器端口小于 60 你可能会得到错误得结果，因为 `YAML` 将会解析 `xx:yy` 这种数字格式为 60 进制。所以建议采用字符串格式。* +### `dns_search` +配置 DNS 搜索域。可以是一个值，也可以是一个列表。 -### `expose` - -暴露端口，但不映射到宿主机，只被连接的服务访问。 - -仅可以指定内部端口为参数 - -```bash -expose: - - "3000" - - "8000" +```sh +dns_search: example.com +dns_search: + - domain1.example.com + - domain2.example.com ``` -### `volumes` +### `dockerfile` +如果需要指定额外的编译镜像的 Dockefile 文件，可以通过该指令来指定。 -卷挂载路径设置。可以设置宿主机路径 （`HOST:CONTAINER`） 或加上访问模式 （`HOST:CONTAINER:ro`）。 - -```bash -volumes: - - /var/lib/mysql - - cache/:/tmp/cache - - ~/configs:/etc/configs/:ro +例如 +```yml +dockerfile: Dockerfile-alternate ``` -### `volumes_from` - -从另一个服务或容器挂载它的所有卷。 - -```bash -volumes_from: - - service_name - - container_name -``` - -### `environment` - -设置环境变量。你可以使用数组或字典两种格式。 - -只给定名称的变量会自动获取它在 Compose 主机上的值，可以用来防止泄露不必要的数据。 - -``` -environment: - RACK_ENV: development - SESSION_SECRET: - -environment: - - RACK_ENV=development - - SESSION_SECRET -``` +注意，该指令不能跟 `image` 同时使用，否则 Compose 将不知道根据哪个指令来生成最终的服务镜像。 ### `env_file` 从文件中获取环境变量，可以为单独的文件路径或列表。 -如果通过 `docker-compose -f FILE` 指定了模板文件，则 `env_file` 中路径会基于模板文件路径。 +如果通过 `docker-compose -f FILE` 方式来指定 Compose 模板文件，则 `env_file` 中变量的路径会基于模板文件路径。 -如果有变量名称与 `environment` 指令冲突，则以后者为准。 +如果有变量名称与 `environment` 指令冲突，则按照惯例，以后者为准。 -```bash +```sh env_file: .env env_file: @@ -149,14 +148,59 @@ env_file: 环境变量文件中每一行必须符合格式，支持 `#` 开头的注释行。 -```bash -# common.env: Set Rails/Rack environment -RACK_ENV=development +```sh +# common.env: Set development environment +PROG_ENV=development +``` + +### `environment` + +设置环境变量。你可以使用数组或字典两种格式。 + +只给定名称的变量会自动获取运行 Compose 主机上对应变量的值，可以用来防止泄露不必要的数据。 + +例如 +```yml +environment: + RACK_ENV: development + SESSION_SECRET: +``` + +或者 + +```yml +environment: + - RACK_ENV=development + - SESSION_SECRET +``` + +注意，如果变量名称或者值中用到 `true|false，yes|no` 等表达布尔含义的词汇，最好放到引号里，避免 YAML 自动解析某些内容为对应的布尔语义。 + +`http://yaml.org/type/bool.html` 中给出了这些特定词汇，包括 + +```sh + y|Y|yes|Yes|YES|n|N|no|No|NO +|true|True|TRUE|false|False|FALSE +|on|On|ON|off|Off|OFF +``` + +### `expose` + +暴露端口，但不映射到宿主机，只被连接的服务访问。 + +仅可以指定内部端口为参数 + +```sh +expose: + - "3000" + - "8000" ``` ### `extends` -基于已有的服务进行扩展。例如我们已经有了一个 webapp 服务，模板文件为 `common.yml`。 -```bash +基于其它模板文件进行扩展。 + +例如我们已经有了一个 webapp 服务，定义一个基础模板文件为 `common.yml`。 +```sh # common.yml webapp: build: ./webapp @@ -165,8 +209,8 @@ webapp: - SEND_EMAILS=false ``` -编写一个新的 `development.yml` 文件，使用 `common.yml` 中的 webapp 服务进行扩展。 -```bash +再编写一个新的 `development.yml` 文件，使用 `common.yml` 中的 webapp 服务进行扩展。 +```sh # development.yml web: extends: @@ -181,14 +225,108 @@ web: db: image: postgres ``` -后者会自动继承 common.yml 中的 webapp 服务及相关环节变量。 +后者会自动继承 common.yml 中的 webapp 服务及环境变量定义。 +使用 extends 需要注意： + +* 要避免出现循环依赖，例如 `A 依赖 B，B 依赖 C，C 反过来依赖 A` 的情况。 +* extends 不会继承 links 和 volumes_from 中定义的容器和数据卷资源。 + +一般的，推荐在基础模板中只定义一些可以共享的镜像和环境变量，在扩展模板中具体指定应用变量、链接、数据卷等信息。 + +### `external_links` +链接到 docker-compose.yml 外部的容器，甚至 并非 `Compose` 管理的外部容器。参数格式跟 `links` 类似。 + +``` +external_links: + - redis_1 + - project_db_1:mysql + - project_db_1:postgresql +``` + +### `extra_hosts` +类似 Docker 中的 `--add-host` 参数，指定额外的 host 名称映射信息。 + +例如： +```yml +extra_hosts: + - "googledns:8.8.8.8" + - "dockerhub:52.1.157.61" +``` + +会在启动后的服务容器中 `/etc/hosts` 文件中添加如下两条条目。 +```sh +8.8.8.8 googledns +52.1.157.61 dockerhub +``` + +### `image` + +指定为镜像名称或镜像 ID。如果镜像在本地不存在，`Compose` 将会尝试拉去这个镜像。 + +例如： +```sh +image: ubuntu +image: orchardup/postgresql +image: a4bc65fd +``` + +### `labels` +为容器添加 Docker 元数据（metadata）信息。例如可以为容器添加辅助说明信息。 +```yml +labels: + com.startupteam.description: "webapp for a startup team" + com.startupteam.department: "devops department" + com.startupteam.release: "rc3 for v1.0" +``` + +### `links` + +链接到其它服务中的容器。使用服务名称（同时作为别名）或服务名称：服务别名 `（SERVICE:ALIAS）` 格式都可以。 + +```sh +links: + - db + - db:database + - redis +``` + +使用的别名将会自动在服务容器中的 `/etc/hosts` 里创建。例如： + +```sh +172.17.2.186 db +172.17.2.186 database +172.17.2.187 redis +``` + +被链接容器中相应的环境变量也将被创建。 + +### `log_driver` +类似 Docker 中的 `--log-driver` 参数，指定日志驱动类型。 + +目前支持三种日志驱动类型。 + +```yml +log_driver: "json-file" +log_driver: "syslog" +log_driver: "none" +``` + +### `log_opt` +日志驱动的相关参数。 + +例如 +```yml +log_driver: "syslog" +log_opt: + syslog-address: "tcp://192.168.0.42:123" +``` ### `net` 设置网络模式。使用和 `docker client` 的 `--net` 参数一样的值。 -```bash +```sh net: "bridge" net: "none" net: "container:[name or id]" @@ -196,64 +334,163 @@ net: "host" ``` ### `pid` -跟主机系统共享进程命名空间。打开该选项的容器可以相互通过进程 ID 来访问和操作。 +跟主机系统共享进程命名空间。打开该选项的容器之间，以及容器和宿主机系统之间可以通过进程 ID 来相互访问和操作。 -```bash +```sh pid: "host" ``` -### `dns` -配置 DNS 服务器。可以是一个值，也可以是一个列表。 +### `ports` -```bash -dns: 8.8.8.8 -dns: - - 8.8.8.8 - - 9.9.9.9 -``` +暴露端口信息。 -### `cap_add, cap_drop` -添加或放弃容器的 Linux 能力（Capabiliity）。 -```bash -cap_add: - - ALL - -cap_drop: - - NET_ADMIN - - SYS_ADMIN -``` - -### `dns_search` - -配置 DNS 搜索域。可以是一个值，也可以是一个列表。 - -```bash -dns_search: example.com -dns_search: - - domain1.example.com - - domain2.example.com -``` - -### `working_dir, entrypoint, user, hostname, domainname, mem_limit, privileged, restart, stdin_open, tty, cpu_shares` - -这些都是和 `docker run` 支持的选项类似。 +使用宿主：容器 `（HOST:CONTAINER）`格式，或者仅仅指定容器的端口（宿主将会随机选择端口）都可以。 ``` +ports: + - "3000" + - "8000:8000" + - "49100:22" + - "127.0.0.1:8001:8001" +``` + +*注意：当使用 `HOST:CONTAINER` 格式来映射端口时，如果你使用的容器端口小于 60 并且没放到引号里，可能会得到错误结果，因为 `YAML` 会自动解析 `xx:yy` 这种数字格式为 60 进制。为避免出现这种问题，建议数字串都采用引号包括起来的字符串格式。* + +### `security_opt` + +指定容器模板标签（label）机制的默认属性（用户、角色、类型、级别等）。 + +例如配置标签的用户名和角色名。 +```yml +security_opt: + - label:user:USER + - label:role:ROLE +``` + +### `ulimits` +指定容器的 ulimits 限制值。 + +例如，指定最大进程数为 65535，指定文件句柄数为 20000（软限制，应用可以随时修改，不能超过硬限制） 和 40000（系统硬限制，只能 root 用户提高）。 + +```yml + ulimits: + nproc: 65535 + nofile: + soft: 20000 + hard: 40000 +``` + +### `volumes` + +数据卷所挂载路径设置。可以设置宿主机路径 （`HOST:CONTAINER`） 或加上访问模式 （`HOST:CONTAINER:ro`）。 + +该指令中路径支持相对路径。例如 + +```yml +volumes: + - /var/lib/mysql + - cache/:/tmp/cache + - ~/configs:/etc/configs/:ro +``` + +### `volumes_driver` +较新版本的 Docker 支持数据卷的插件驱动。 + +用户可以先使用第三方驱动创建一个数据卷，然后使用名称来访问它。 + +此时，可以通过 `volumes_driver` 来指定驱动。 + +```yml +volume_driver: mydriver +``` + +### `volumes_from` + +从另一个服务或容器挂载它的数据卷。 + +```sh +volumes_from: + - service_name + - container_name +``` + +### 其它指令 + +此外，还有包括 `cpu_shares, cpuset, domainname, entrypoint, hostname, ipc, mac_address, mem_limit, memswap_limit, privileged, read_only, restart, stdin_open, tty, user, working_dir` 等指令，基本跟 docker-run 中对应参数的功能一致。 + +例如，指定使用 cpu 核 0 和 核 1，只用 50% 的 CPU 资源： +```yml cpu_shares: 73 +cpuset: 0,1 +``` -working_dir: /code +指定服务容器启动后执行的命令。 +```yml entrypoint: /code/entrypoint.sh -user: postgresql +``` -hostname: foo -domainname: foo.com +指定容器中运行应用的用户名。 +```yml +user: nginx +``` -mem_limit: 1000000000 +指定容器中工作目录。 +```yml +working_dir: /code +``` + +指定容器中搜索域名、主机名、mac 地址等。 +```yml +domainname: your_website.com +hostname: test +mac_address: 08-00-27-00-0C-0A +``` + +指定容器中 +```yml +ipc: host +``` + +指定容器中内存和内存交换区限制都为 1G。 +```yml +mem_limit: 1g +memswap_limit: 1g +``` + +允许容器中运行一些特权命令。 +```yml privileged: true +``` +指定容器退出后的重启策略为始终重启。该命令对保持服务始终运行十分有效，在生产环境中推荐配置为 `always` 或者 `unless-stopped`。 +```yml restart: always +``` +以只读模式挂载容器的 root 文件系统，意味着不能对容器内容进行修改。 +```yml +read_only: true +``` + +打开标准输入，可以接受外部输入。 +```yml stdin_open: true +``` + +模拟一个假的远程控制台。 +```yml tty: true ``` + +### 读取环境变量 +从 1.5.0 版本开始，Compose 模板文件支持动态读取主机的系统环境变量。 + +例如，下面的 Compose 文件将从运行它的环境中读取变量 ${MONGO_VERSION} 的值，并写入执行的指令中。 + +```yml +db: + image: "mongo:${MONGO_VERSION}" +``` + +如果执行 `MONGO_VERSION=3.0 docker-compose up` 则会启动一个 `mongo:3.2` 镜像的容器；如果执行 `MONGO_VERSION=2.8 docker-compose up` 则会启动一个 `mongo:2.8` 镜像的容器。 \ No newline at end of file