docker_practice/compose/commands.md
khs1994 7ec38273bb [Compose] Update to v1.24.1
Signed-off-by: khs1994 <khs1994@khs1994.com>
2019-09-01 14:46:33 +08:00

295 lines
8.4 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## Compose 命令说明
### 命令对象与格式
对于 Compose 来说大部分命令的对象既可以是项目本身也可以指定为项目中的服务或者容器如果没有特别的说明命令对象将是项目这意味着项目中所有的服务都会受到命令影响
执行 `docker-compose [COMMAND] --help` 或者 `docker-compose help [COMMAND]` 可以查看具体某个命令的使用格式
`docker-compose` 命令的基本的使用格式是
```bash
docker-compose [-f=<arg>...] [options] [COMMAND] [ARGS...]
```
### 命令选项
* `-f, --file FILE` 指定使用的 Compose 模板文件默认为 `docker-compose.yml`可以多次指定
* `-p, --project-name NAME` 指定项目名称默认将使用所在目录名称作为项目名
* `--x-networking` 使用 Docker 的可拔插网络后端特性
* `--x-network-driver DRIVER` 指定网络后端的驱动默认为 `bridge`
* `--verbose` 输出更多调试信息
* `-v, --version` 打印版本并退出
### 命令使用说明
#### `build`
格式为 `docker-compose build [options] [SERVICE...]`
构建重新构建项目中的服务容器
服务容器一旦构建后将会带上一个标记名例如对于 web 项目中的一个 db 容器可能是 web_db
可以随时在项目目录下运行 `docker-compose build` 来重新构建服务
选项包括
* `--force-rm` 删除构建过程中的临时容器
* `--no-cache` 构建镜像过程中不使用 cache这将加长构建过程
* `--pull` 始终尝试通过 pull 来获取更新版本的镜像
#### `config`
验证 Compose 文件格式是否正确若正确则显示配置若格式错误显示错误原因
#### `down`
此命令将会停止 `up` 命令所启动的容器并移除网络
#### `exec`
进入指定的容器
#### `help`
获得一个命令的帮助
#### `images`
列出 Compose 文件中包含的镜像
#### `kill`
格式为 `docker-compose kill [options] [SERVICE...]`
通过发送 `SIGKILL` 信号来强制停止服务容器
支持通过 `-s` 参数来指定发送的信号例如通过如下指令发送 `SIGINT` 信号
```bash
$ docker-compose kill -s SIGINT
```
#### `logs`
格式为 `docker-compose logs [options] [SERVICE...]`
查看服务容器的输出默认情况下docker-compose 将对不同的服务输出使用不同的颜色来区分可以通过 `--no-color` 来关闭颜色
该命令在调试问题的时候十分有用
#### `pause`
格式为 `docker-compose pause [SERVICE...]`
暂停一个服务容器
#### `port`
格式为 `docker-compose port [options] SERVICE PRIVATE_PORT`
打印某个容器端口所映射的公共端口
选项
* `--protocol=proto` 指定端口协议tcp默认值或者 udp
* `--index=index` 如果同一服务存在多个容器指定命令对象容器的序号默认为 1
#### `ps`
格式为 `docker-compose ps [options] [SERVICE...]`
列出项目中目前的所有容器
选项
* `-q` 只打印容器的 ID 信息
#### `pull`
格式为 `docker-compose pull [options] [SERVICE...]`
拉取服务依赖的镜像
选项
* `--ignore-pull-failures` 忽略拉取镜像过程中的错误
#### `push`
推送服务依赖的镜像到 Docker 镜像仓库
#### `restart`
格式为 `docker-compose restart [options] [SERVICE...]`
重启项目中的服务
选项
* `-t, --timeout TIMEOUT` 指定重启前停止容器的超时默认为 10
#### `rm`
格式为 `docker-compose rm [options] [SERVICE...]`
删除所有停止状态的服务容器推荐先执行 `docker-compose stop` 命令来停止容器
选项
* `-f, --force` 强制直接删除包括非停止状态的容器一般尽量不要使用该选项
* `-v` 删除容器所挂载的数据卷
#### `run`
格式为 `docker-compose run [options] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]`
在指定服务上执行一个命令
例如
```bash
$ docker-compose run ubuntu ping docker.com
```
将会启动一个 ubuntu 服务容器并执行 `ping docker.com` 命令
默认情况下如果存在关联则所有关联的服务将会自动被启动除非这些服务已经在运行中
该命令类似启动容器后运行指定的命令相关卷链接等等都将会按照配置自动创建
两个不同点
* 给定命令将会覆盖原有的自动运行命令
* 不会自动创建端口以避免冲突
如果不希望自动启动关联的容器可以使用 `--no-deps` 选项例如
```bash
$ 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 的指令将无法运行
#### `scale`
格式为 `docker-compose scale [options] [SERVICE=NUM...]`
设置指定服务运行的容器个数
通过 `service=num` 的参数来设置数量例如
```bash
$ docker-compose scale web=3 db=2
```
将启动 3 个容器运行 web 服务2 个容器运行 db 服务
一般的当指定数目多于该服务当前实际运行容器将新创建并启动容器反之将停止容器
选项
* `-t, --timeout TIMEOUT` 停止容器时候的超时默认为 10
#### `start`
格式为 `docker-compose start [SERVICE...]`
启动已经存在的服务容器
#### `stop`
格式为 `docker-compose stop [options] [SERVICE...]`
停止已经处于运行状态的容器但不删除它通过 `docker-compose start` 可以再次启动这些容器
选项
* `-t, --timeout TIMEOUT` 停止容器时候的超时默认为 10
#### `top`
查看各个服务容器内运行的进程
#### `unpause`
格式为 `docker-compose unpause [SERVICE...]`
恢复处于暂停状态中的服务
#### `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
#### `version`
格式为 `docker-compose version`
打印版本信息
### 参考资料
* [官方文档](https://docs.docker.com/compose/reference/overview/)