24.3　Compose命令说明

对于Compose来说，大部分命令的对象既可以是项目本身，也可以指定为项目中的服务或者容器。如果没有特别说明，命令对象将是项目，这意味着项目中所有的服务都会受到命令影响。

执行docker-compose[COMMAND]—help或者docker-compose help[COMMAND]可以查看具体某个命令的使用格式。Compose命令的基本的使用格式是：

docker-compose [-f=<arg>...] [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输出更多调试信息。

·-v，—version打印版本并退出。

命令列表见表24-1。

表24-1　Compose命令

命令使用说明如下。

1.build

格式为docker-compose build[options][SERVICE…]。

构建（重新构建）项目中的服务容器。

服务容器一旦构建后，将会带上一个标记名，例如对于web项目中的一个db容器，可能是web_db。可以随时在项目目录下运行docker-compose build来重新构建服务。

选项包括：

·—force-rm删除构建过程中的临时容器。

·—no-cache构建镜像过程中不使用缓存（这将加长构建过程）。

·—pull始终尝试通过拉取操作来获取更新版本的镜像。

2.help

获得一个命令的帮助。

3.kill

格式为docker-compose kill[options][SERVICE…]。

通过发送SIGKILL信号来强制停止服务容器。

支持通过-s参数来指定发送的信号，例如通过如下指令发送SIGINT信号：

$ docker-compose kill -s SIGINT

4.logs

格式为docker-compose logs[options][SERVICE…]。

查看服务容器的输出。默认情况下，docker-compose将对不同的服务输出使用不同的颜色来区分。可以通过—no-color来关闭颜色。该命令在调试问题的时候十分有用。

5.pause

格式为docker-compose pause[SERVICE…]。

暂停一个服务容器。

6.port

格式为docker-compose port[options]SERVICE PRIVATE_PORT。

显示某个容器端口所映射的公共端口。

选项：

·—protocol=proto指定端口协议，TCP（默认值）或者UDP。

·—index=index如果同一服务存在多个容器，指定命令对象容器的序号（默认为1）。

7.ps

格式为docker-compose ps[options][SERVICE…]。

列出项目中目前的所有容器。

选项：-q只打印容器的ID信息。

8.pull

格式为docker-compose pull[options][SERVICE…]。

拉取服务依赖的镜像。

选项：—ignore-pull-failures忽略拉取镜像过程中的错误。

9.restart

格式为docker-compose restart[options][SERVICE…]。

重启项目中的服务。

选项为-t，—timeout TIMEOUT，指定重启前停止容器的超时（默认为10秒）。

10.rm

格式为docker-compose rm[options][SERVICE…]。

删除所有（停止状态的）服务容器。推荐先执行docker-compose stop命令来停止容器。

选项如下：

·-f，—force强制直接删除，包括非停止状态的容器。一般尽量不要使用该选项。

·-v删除容器所挂载的数据卷。

11.run

格式为docker-compose run[options][-p PORT…][-e KEY=VAL…]SERVICE[COMMAND][ARGS…]。

在指定服务上执行一个命令。

例如：

$ docker-compose run ubuntu ping docker.com

将会启动一个ubuntu服务容器，并执行ping docker.com命令。

默认情况下，如果存在关联，则所有关联的服务将会自动被启动，除非这些服务已经在运行中。该命令类似于启动容器后运行指定的命令，相关卷、链接等都将会按照配置自动创建。有两个不同点：

·给定命令将会覆盖原有的自动运行命令；

·不会自动创建端口，以避免冲突。

如果不希望自动启动关联的容器，可以使用—no-deps选项，例如：

$ docker-compose run --no-deps web python manage.py shell

将不会启动Web容器所关联的其他容器。

选项：

·-d在后台运行服务容器。

·—name NAME为容器指定一个名字。

·—entrypoint CMD覆盖默认的容器启动指令。

·-e KEY=VAL设置环境变量值，可多次使用选项来设置多个环境变量。

·-u，—user=""指定运行容器的用户名或者uid。

·—no-deps不自动启动关联的服务容器。

·—rm运行命令后自动删除容器，d模式下将忽略。

·-p，—publish=[]映射容器端口到本地主机。

·—service-ports配置服务端口并映射到本地主机。

·-T不分配伪tty，意味着依赖tty的指令将无法运行。

12.scale

格式为docker-compose scale[options][SERVICE=NUM…]。

设置指定服务运行的容器个数。

通过service=num的参数来设置数量。例如：

$ docker-compose scale web=3 db=2

将启动3个容器运行web服务，2个容器运行db服务。一般情况下，当指定数目多于该服务当前实际运行容器，将新创建并启动容器；反之，将停止容器。

选项为-t，—timeout TIMEOUT，停止容器时候的超时（默认为10秒）。

13.start

格式为docker-compose start[SERVICE…]。

启动已经存在的服务容器。

14.stop

格式为docker-compose stop[options][SERVICE…]。

停止已经处于运行状态的容器，但不删除它。通过docker-compose start可以再次启动这些容器。

选项为-t，—timeout TIMEOUT，停止容器时候的超时（默认为10秒）。

15.unpause

格式为docker-compose unpause[SERVICE…]。

恢复处于暂停状态中的服务。

16.up

格式为docker-compose up[options][SERVICE…]。

该命令十分强大，它将尝试自动完成包括构建镜像，（重新）创建服务，启动服务，并关联服务相关容器的一系列操作。链接的服务都将会被自动启动，除非已经处于运行状态。

可以说，大部分时候都可以直接通过该命令来启动一个项目。默认情况，docker-compose up启动的容器都在前台，控制台将会同时打印所有容器的输出信息，可以很方便进行调试。当通过Ctrl-C停止命令时，所有容器将会停止。如果使用docker-compose up-d，将会在后台启动并运行所有的容器。一般推荐生产环境下使用该选项。默认情况，如果服务容器已经存在，docker-compose up将会尝试停止容器，然后重新创建（保持使用volumes-from挂载的卷），以保证新启动的服务匹配docker-compose.yml文件的最新内容。如果用户不希望容器被停止并重新创建，可以使用docker-compose up—no-recreate。这样将只会启动处于停止状态的容器，而忽略已经运行的服务。如果用户只想重新部署某个服务，可以使用docker-compose up—no-deps-d<SERVICE_NAME>来重新创建服务并后台停止旧服务，启动新服务，并不会影响到其所依赖的服务。

选项：

·-d在后台运行服务容器。

·—no-color不使用颜色来区分不同的服务的控制台输出。

·—no-deps不启动服务所链接的容器。

·—force-recreate强制重新创建容器，不能与—no-recreate同时使用。

·—no-recreate如果容器已经存在了，则不重新创建，不能与—force-recreate同时使用。

·—no-build不自动构建缺失的服务镜像。

·-t，—timeout TIMEOUT停止容器时候的超时（默认为10秒）。

17.migrate-to-labels

格式为docker-compose migrate-to-labels。

重新创建容器，并添加label。主要用于升级1.2及更早版本中创建的容器，添加缺失的容器标签。

实际上，最彻底的办法当然是删除项目，然后重新创建。

18.version

格式为docker-compose version。

打印版本信息。