Bootstrap

附录3、Docker-compose 命令使用指南

本文是《》第十一篇,原文发布于个人博客:

上一篇:

命令选项概述和帮助

您可以通过在命令行执行如下命令来获取相关帮助信息:

  docker-compose [-f ...] [options] [COMMAND] [ARGS...]
  docker-compose -h|--help

命令选项

  •  指定模板文件,默认为 ,可以指定多个文件。

  •  指定项目名称,默认使用所在目录名。

  •  输出更多调试信息。

  •  打印版本并退出。

  •  指定连接到哪个守护进程

命令自动补全

Compose 为 bash 和 zsh 提供了命令补全功能,Linux 安装:

 sudo curl -L https://raw.githubusercontent.com/docker/compose/1.25.5/contrib/completion/bash/docker-compose -o /etc/bash_completion.d/docker-compose

其它系统安装,请参考官方文档: 

命令使用说明

version(查看版本)

查看版本信息。

build(构建服务)

格式为 。

构建(重新构建)并标记服务,默认为,例如,。

如果更改了服务的  或构建目录中的内容,请运行以重建它。

config(验证配置)

验证并查看 Compose 文件。

down (停止服务)

停止容器并移除由  创建的容器、网络、卷和镜像。 定义为  的网络和卷永远不会被移除。

events(监测时间)

监测项目中容器事件,使用--json`标志时,每行将打印一个json对象。

exec(进入容器)

进入指定的容器,例如通过  可进入服务名为 的容器进行交互式操作。

help(查看帮助)

显示命令的帮助和用法说明。

images(列出镜像)

列出 Compose 文件中包含的镜像。

kill(停止服务)

强制停止运行中的服务容器。格式为 。

支持通过  参数来指定要发送的信号,例如发送  信号:

docker-compose kill -s SIGINT

logs(查看日志)

查看服务的日志输出。格式为 。可选项:

--no-color          # 关闭不同服务用不同颜色显示的功能
-f, --follow        # 实时监控日志
-t, --timestamps    # 显示时间戳
--tail="all"        # 显示所有日志

pause(暂停服务)

暂停正在运行的容器,可通过  取消暂停。格式为 。

port(查看端口)

打印某个容器所映射的公共端口,格式为 。

ps(列出服务)

列出项目中的所有容器。

pull(拉取镜像)

拉取服务依赖的镜像。可通过  参数忽略拉取镜像过程中的错误。

push(推送镜像)

推送服务所依赖的镜像到镜像仓库。

restart(重启服务)

重启项目中的服务。

rm(删除容器)

删除停止的服务容器。

默认情况下,不删除附加到容器的匿名卷。您可以使用  覆盖它。要列出所有卷,请使用 。

任何不在卷中的数据都会丢失。运行不带选项的命令还会删除由  或  创建的一次性容器:

run(运行命令)

针对服务执行一次性命令。命令选项:

  •  后台运行容器。

  •  为容器指定一个名字。

  •  覆盖默认的容器启动指令。

  •  设置环境变量值,可多次使用选项来设置多个环境变量。

  •  指定运行容器的用户名或者 uid。

  •  不自动启动关联的服务容器。

  •  运行命令后自动删除容器, 模式下将忽略。

  •  映射容器端口到本地主机。

  •  配置服务端口并映射到本地主机。

  •  不分配伪 tty,意味着依赖 tty 的指令将无法运行。

例如,以下命令启动服务并运行命令。

docker-compose run web bash

该命令类似启动容器后运行指定的命令,相关卷、链接等等都将会按照配置自动创建。有两个重要区别:

  • 给定命令将会覆盖服务配置中定义的命令。

  • 不会创建服务配置中指定的任何端口,这样可避免端口冲突。可通过附加  创建端口。还可以使用或选项手动指定端口映射。

默认情况下,所有关联且未运行的服务将会自动被启动。如果不希望自动启动关联的容器,可以使用  选项,例如:

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

将不会启动 web 容器所关联的其它容器。

start(启动服务)

启动用于服务的现有容器。

stop(停止服务)

停止已经处于运行状态的容器,但不删除它。

top(查看进程)

查看各个服务内正在运行的进程。

unpause(暂停服务)

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

up(构建并启动服务)

自动构建,(重新)创建服务,启动服务并在控制台聚合显示每个容器的日志。

链接的服务都将会被自动启动,除非已经处于运行状态。

当通过  停止命令时,所有容器将会停止。

如果使用 ,将会在后台启动并运行所有的容器。

如果用于服务的容器已经存在,并且在创建容器后更改了服务的配置或镜像, 将会停止并重新创建容器来获取更新(保留通过  挂载的卷)。

如果不希望应用更新,可使用 参数。如果要强制停止并重新创建所有容器,可使用该 参数。

如果进程遇到错误,此命令的退出代码为。如果使用 (+ )或 中断该进程,则容器停止,退出代码为 。如果在此关闭阶段再次发送  或  则会停止正在运行的容器,退出代码为 。

命令选项:

  •  在后台运行服务容器。

  •  不使用颜色来区分不同的服务的控制台输出。

  •  不启动服务所链接的容器。

  •  强制重新创建容器,不能与  同时使用。

  •  如果容器已经存在了,则不重新创建,不能与  同时使用。

  •  不自动构建缺失的服务镜像。

  •  仅创建服务但不启动。

  •  在附加或容器已运行时,超时(默认为 10 秒)关闭容器。

  •  重新创建匿名卷,而不是从以前的容器中检索数据。

  •  删除未在 Compose 文件中定义的服务的容器。

  •  设置为服务运行的容器数量。会覆盖 Compose 文件中的  设置。

参考

  • 官方文档:

相关文章

  • 上一篇:

  • 下一篇: