docker compose run

描述在服务上运行一次性命令
用法docker compose run [OPTIONS] SERVICE [COMMAND] [ARGS...]

描述

在服务中运行一次性命令。

以下命令启动 web 服务并运行 bash 作为其命令:

$ docker compose run web bash

与 run 一起使用的命令会在新容器中启动,其配置由服务的配置定义, 包括卷、链接和其他详细信息。但是,有两个重要的区别:

首先,通过 run 传递的命令会覆盖服务配置中定义的命令。例如,如果 web 服务配置以 bash 启动,那么 docker compose run web python app.py 会将其覆盖为 python app.py

第二个区别是 docker compose run 命令不会创建服务配置中指定的任何端口。这可以防止与已打开的端口发生冲突。如果您确实希望创建服务的端口并将其映射到主机,请指定 --service-ports

$ docker compose run --service-ports web python manage.py shell

或者,可以像使用 docker run 一样,使用 --publish-p 选项指定手动端口映射:

$ docker compose run --publish 8080:80 -p 2022:22 -p 127.0.0.1:2021:21 web python manage.py shell

如果您启动一个配置了链接的服务,run 命令会首先检查被链接的服务是否正在运行,如果已停止则会启动该服务。当所有被链接的服务都处于运行状态时,run 会执行您传递给它的命令。例如,您可以运行:

$ docker compose run db psql -h db -U docker

这会为链接的 db 容器打开一个交互式 PostgreSQL shell。

如果不希望 run 命令启动链接的容器,请使用 --no-deps 标志:

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

如果你想在运行后删除容器,同时覆盖容器的重启策略,请使用 --rm 标志:

$ docker compose run --rm web python manage.py db upgrade

这将运行一个数据库升级脚本,并在运行完成后删除容器,即使服务配置中指定了重启策略。

选项

选项默认描述
--build在启动容器前构建镜像
--cap-add添加 Linux 能力
--cap-drop移除 Linux 能力
-d, --detach在后台运行容器并打印容器 ID
--entrypoint覆盖镜像的入口点
-e, --env设置环境变量
-i, --interactivetrue即使未附加也保持 STDIN 打开
-l, --label添加或覆盖标签
--name为容器分配一个名称
-T, --no-TTYtrue禁用伪终端分配(默认值:自动检测)
--no-deps不要启动链接服务
-p, --publish将容器的端口发布到主机
--quiet-pull拉取而不显示进度信息
--remove-orphans移除 Compose 文件中未定义的服务容器
--rm当容器退出时自动移除该容器
-P, --service-ports运行命令并启用所有服务端口,将其映射到主机
--use-aliases使用容器连接到的网络中的服务网络 useAliases
-u, --user以指定的用户名或 UID 运行
-v, --volume绑定挂载卷
-w, --workdir容器内的工作目录