docker compose 命令
对于 Compose
来说,大部分命令的对象既可以是项目本身,也可以指定为项目中的服务或者容器。如果没有特别的说明,命令对象将是项目,这意味着项目中所有的服务都会受到命令影响。
执行 docker compose [COMMAND] --help
可以查看具体某个命令的使用格式。
docker compose
命令的基本的使用格式是
docker compose [-f=<arg>...] [options] [COMMAND] [ARGS...] |
常用选项
-f, --file FILE
指定使用的 Compose 模板文件,默认为docker-compose.yml
,可以多次指定。-p, --project-name NAME
指定项目名称,默认将使用所在目录名称作为项目名。
build
格式为
docker compose build [options] [SERVICE...] |
构建(重新构建)项目中的服务容器。
服务容器一旦构建后,将会带上一个标记名,例如对于 web 项目中的一个 db 容器,可能是 web_db。
可以随时在项目目录下运行 docker compose build
来重新构建服务。
常用选项包括:
--no-cache
构建镜像过程中不使用 cache(这将加长构建过程)。--pull
始终尝试通过pull
来获取更新版本的镜像。-q, --quiet
不输出任何内容到 STDOUT
config
docker compose config |
验证 Compose 文件格式是否正确,若正确则显示配置,若格式错误显示错误原因。
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, --detach
在后台运行服务容器--no-color
不使用颜色来区分不同的服务的控制台输出--no-deps
不启动服务所链接的容器。--force-recreate
强制重新创建容器,不能与--no-recreate
同时使用--no-recreate
如果容器已经存在了,则不重新创建,不能与--force-recreate
同时使用。--no-build
不自动构建缺失的服务镜像-t, --timeout TIMEOUT
停止容器时候的超时(默认为 10 秒)时间。--no-start
创建服务但是不启动服务--build
启动容器之前,重新构建容器
down
此命令将会停止 up
命令所启动的容器,并移除网络
start
启动已经存在的服务容器。
pause
暂停一个服务容器。
unpause
恢复处于暂停状态中的服务。
restart
重启项目中的服务。
stop
停止已经处于运行状态的容器,但不删除它。通过 docker compose start
可以再次启动这些容器。
ps
列出项目中目前的所有容器。
port
格式为
docker compose port [options] SERVICE PRIVATE_PORT |
打印某个容器端口所映射的公共端口
常用选项
--protocol=proto
指定端口协议,tcp(默认值)或者 udp。--index=index
如果同一服务存在多个容器,指定命令对象容器的序号(默认为 1)
exec
进入指定的容器。
images
列出 Compose 文件中包含的镜像。
kill
格式为
docker compose kill [options] [SERVICE...] |
通过发送 SIGKILL 信号来强制停止服务容器。
支持通过 -s
参数来指定发送的信号,例如通过如下指令发送 SIGINT 信号。
docker compose kill -s SIGINT |
logs
格式为
docker compose logs [options] [SERVICE...]
查看服务容器的输出。默认情况下,docker compose
将对不同的服务输出使用不同的颜色来区分。可以通过 --no-color
来关闭颜色。
该命令在调试问题的时候十分有用。
top
查看各个服务容器内运行的进程。
rm
删除所有(停止状态的)服务容器。推荐先执行 docker compose stop
命令来停止容器。
选项:
-f, --force
强制直接删除,包括非停止状态的容器。一般尽量不要使用该选项。-v
删除容器所挂载的数据卷。