开发手册 欢迎您!
软件开发者资料库

Docker Compose中docker-compose命令使用及说明

Docker Compose是一个用来定义和运行复杂应用的Docker工具。一个使用Docker容器的应用,通常由多个容器组成。使用Docker Compose不再需要使用shell脚本来启动容器。通过一个配置文件来管理多个Docker容器,在配置文件中,所有的容器通过services来定义,然后使用docker-compose脚本来启动,停止和重启应用,和应用中的服务以及所有依赖服务的容器,本文主要介绍 Docker Compose中docker-compose命令使用及说明。

1、docker-compose 命令

格式:

docker-compose [-f=...] [选项] [COMMAND] [ARGS...]

选项:

1)-f, --file FILE 指定使用的 Compose 模板文件,默认为 docker-compose.yml,可以多次指定。

2)-p, --project-name NAME 指定项目名称,默认将使用所在目录名称作为项目名。

3)--verbose 输出更多调试信息。

4)-v, --version 打印版本并退出。

2、docker-compose build 命令

构建(重新构建)项目中的服务容器。重新构建服务是在项目目录下运行 docker-compose build。

格式:

docker-compose build [选项] [SERVICE...]

选项:

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

2)--no-cache 构建镜像过程中不使用 cache(这将加长构建过程)。

3)--pull 始终尝试通过 pull 来获取更新版本的镜像。

3、docker-compose config 命令格式

验证 Compose 文件格式是否正确,若正确则显示配置,若格式错误显示错误原因。

格式:

docker-compose config [选项]

选项:

1)-q, --quiet 只验证配置,不输出。 当配置正确时,不输出任何内容,当文件配置错误,输出错误信息。

2)--services 打印服务名,一行一个验证和查看compose文件配置。

4、docker-compose down 命令

此命令将会停止 up 命令所启动的容器,并移除网络。

格式:

docker-compose down [选项]

选项:

1)--rmi type 删除镜像,类型必须是:

'all': 删除compose文件中定义的所以镜像。

'local': 删除镜像名为空的镜像

2)-v, --volumes 删除卷

3)--remove-orphans 删除Compose文件中未定义的服务。

停止和删除容器、网络、卷、镜像,这些是通过docker-compose up命令创建的. 默认值删除 容器 网络,可以通过指定 rmi volumes参数删除镜像和卷

5、docker-compose exec 命令

进入指定的容器。

格式:

docker-compose exec [选项] [-e KEY=VAL...] SERVICE COMMAND [ARGS...]

选项:

1)-d 分离模式,后台运行命令.

2)--privileged 获取特权.

3)--user USER 指定运行的用户.

4)-T 禁用分配TTY.`docker-compose exec`默认分配 a TTY.

4)--index=index 当一个服务拥有多个容器时,可通过该参数登陆到该服务下的任何服务,例如:docker-compose exec --index=1 web /bin/bash ,web服务中包含多个容服务实例 [default: 1]和docker exec命令功能相同,可以通过service name登陆到容器中。

6、docker-compose images 命令

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

格式:

docker-compose images [选项] [SERVICE...]

选项:

-q, --quiet 只显示id

7、docker-compose kill 命令

通过发送 SIGKILL 信号来强制停止服务容器。支持通过 -s 参数来指定发送的信号。

格式:

docker-compose kill [选项] [SERVICE...]

选项:

-s SIGNAL 信号发送到容器。默认信号为SIGKILL。

8、docker-compose logs 命令

查看服务容器的输出。默认情况下,docker-compose 将对不同的服务输出使用不同的颜色来区分。可以通过 --no-color 来关闭颜色。

格式:

docker-compose logs [选项] [SERVICE...]

选项:

1)--no-color 单色输出,不显示其他颜.

2)-f, --follow 跟踪日志输出,就是可以实时查看日志

3)-t, --timestamps 显示时间戳

4)--tail 从日志的结尾显示,--tail=200,显示日志输出。

9、docker-compose pause 命令

暂停一个服务容器。

格式:

docker-compose pause [SERVICE...]

暂停正在运行的服务容器。可以使用docker-compose unpause进行恢复。

10、docker-compose port 命令

打印某个容器端口所映射的公共端口。

格式:

docker-compose port [选项] SERVICE PRIVATE_PORT

1)--protocol=proto 指定端口协议,tcp(默认值)或者 udp。

2)--index=index 如果同一服务存在多个容器,指定命令对象容器的序号(默认为 1)。

11、docker-compose ps 命令

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

格式:

docker-compose ps [选项] [SERVICE...]

选项:

-q 只打印容器的 ID 信息

11、docker-compose pull 命令

拉取服务依赖的镜像。

格式:

docker-compose pull [选项] [SERVICE...]

选项:

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

12、docker-compose push 命令

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

格式:

docker-compose push [选项] [SERVICE...]

选项:

--ignore-push-failures 忽略错误。

13、docker-compose restart 命令

重启项目中的服务。

格式:

docker-compose restart [选项] [SERVICE...]

选项:

-t, --timeout TIMEOUT 指定重启前停止容器的超时(默认为 10 秒)。

14、docker-compose rm 命令

删除所有(停止状态的)服务容器。最好先执行 docker-compose stop 命令来停止容器。

格式:

docker-compose rm [选项] [SERVICE...]

选项:

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

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

15、docker-compose run 命令

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

格式:

docker-compose run [选项] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]

选项:

1)-d 后台运行,输出容器名。

2)-e KEY=VAL 设置环境变量参数,可以使用多次。

3)-u, --user="" 指定运行的用户。

4)--no-deps 不自动启动关联的服务容器。如果不希望自动启动关联的容器,可以使用 --no-deps 选项。

5)--rm 运行后删除容器,后台运行模式除外(-d)。

6)-p, --publish=[] 开放端口。

7)--service-ports compose文件中配置什么端口,就映射什么端口。

8)-T 禁用TTY。不分配伪 TTY。

9)-w, --workdir="" 设置工作目录。

16、docker-compose scale 命令

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

格式:

docker-compose scale [选项] [SERVICE=NUM...]

选项:

-t, --timeout TIMEOUT 停止容器时候的超时(默认为 10 秒)。

17、docker-compose start 命令

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

格式:

docker-compose start [SERVICE...]

18、docker-compose stop 命令

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

格式:

docker-compose stop [选项] [SERVICE...]

选项:

-t, --timeout TIMEOUT 停止容器时候的超时(默认为 10 秒)。

19、docker-compose top 命令

查看各个服务容器内运行的进程。

格式:

docker-compose top [SERVICE...]

20、docker-compose up 命令

该命令十分强大,它将尝试自动完成包括构建镜像,(重新)创建服务,启动服务,并关联服务相关容器的一系列操作。默认情况,docker-compose up 启动的容器都在前台,控制台将会同时打印所有容器的输出信息,可以很方便进行调试。当通过 Ctrl-C 停止命令时,所有容器将会停止。如果使用 docker-compose up -d,将会在后台启动并运行所有的容器。一般推荐生产环境下使用该选项。如果不想容器被停止并重新创建,可以使用 docker-compose up --no-recreate。如只想重新部署某个服务,可以使用 docker-compose up --no-deps -d 来重新创建服务并后台停止旧服务,启动新服务,并不会影响到其所依赖的服务。

格式:

docker-compose up [选项] [SERVICE...]

选项:

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

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

3)--no-deps 不启动服务所链接的容器。

4)--force-recreate 强制重新创建容器,不能与 --no-recreate 同时使用。

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

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

7)-t, --timeout TIMEOUT 停止容器时候的超时(默认为 10 秒)。