Update title style

Signed-off-by: Kang HuaiShuai <khs1994@khs1994.com>
This commit is contained in:
Kang HuaiShuai
2019-11-05 23:35:43 +08:00
parent 3ba7560b4d
commit 709c77adcb
39 changed files with 297 additions and 316 deletions

View File

@@ -1,6 +1,6 @@
## Compose 命令说明
# Compose 命令说明
### 命令对象与格式
## 命令对象与格式
对于 Compose 来说大部分命令的对象既可以是项目本身也可以指定为项目中的服务或者容器如果没有特别的说明命令对象将是项目这意味着项目中所有的服务都会受到命令影响
@@ -12,7 +12,7 @@
docker-compose [-f=<arg>...] [options] [COMMAND] [ARGS...]
```
### 命令选项
## 命令选项
* `-f, --file FILE` 指定使用的 Compose 模板文件默认为 `docker-compose.yml`可以多次指定
@@ -26,9 +26,9 @@ docker-compose [-f=<arg>...] [options] [COMMAND] [ARGS...]
* `-v, --version` 打印版本并退出
### 命令使用说明
## 命令使用说明
#### `build`
### `build`
格式为 `docker-compose build [options] [SERVICE...]`
@@ -46,27 +46,27 @@ docker-compose [-f=<arg>...] [options] [COMMAND] [ARGS...]
* `--pull` 始终尝试通过 pull 来获取更新版本的镜像
#### `config`
### `config`
验证 Compose 文件格式是否正确若正确则显示配置若格式错误显示错误原因
#### `down`
### `down`
此命令将会停止 `up` 命令所启动的容器并移除网络
#### `exec`
### `exec`
进入指定的容器
#### `help`
### `help`
获得一个命令的帮助
#### `images`
### `images`
列出 Compose 文件中包含的镜像
#### `kill`
### `kill`
格式为 `docker-compose kill [options] [SERVICE...]`
@@ -78,7 +78,7 @@ docker-compose [-f=<arg>...] [options] [COMMAND] [ARGS...]
$ docker-compose kill -s SIGINT
```
#### `logs`
### `logs`
格式为 `docker-compose logs [options] [SERVICE...]`
@@ -86,13 +86,13 @@ $ docker-compose kill -s SIGINT
该命令在调试问题的时候十分有用
#### `pause`
### `pause`
格式为 `docker-compose pause [SERVICE...]`
暂停一个服务容器
#### `port`
### `port`
格式为 `docker-compose port [options] SERVICE PRIVATE_PORT`
@@ -104,7 +104,7 @@ $ docker-compose kill -s SIGINT
* `--index=index` 如果同一服务存在多个容器指定命令对象容器的序号默认为 1
#### `ps`
### `ps`
格式为 `docker-compose ps [options] [SERVICE...]`
@@ -114,7 +114,7 @@ $ docker-compose kill -s SIGINT
* `-q` 只打印容器的 ID 信息
#### `pull`
### `pull`
格式为 `docker-compose pull [options] [SERVICE...]`
@@ -124,11 +124,11 @@ $ docker-compose kill -s SIGINT
* `--ignore-pull-failures` 忽略拉取镜像过程中的错误
#### `push`
### `push`
推送服务依赖的镜像到 Docker 镜像仓库
#### `restart`
### `restart`
格式为 `docker-compose restart [options] [SERVICE...]`
@@ -138,7 +138,7 @@ $ docker-compose kill -s SIGINT
* `-t, --timeout TIMEOUT` 指定重启前停止容器的超时默认为 10
#### `rm`
### `rm`
格式为 `docker-compose rm [options] [SERVICE...]`
@@ -150,7 +150,7 @@ $ docker-compose kill -s SIGINT
* `-v` 删除容器所挂载的数据卷
#### `run`
### `run`
格式为 `docker-compose run [options] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]`
在指定服务上执行一个命令
@@ -203,7 +203,7 @@ $ docker-compose run --no-deps web python manage.py shell
* `-T` 不分配伪 tty意味着依赖 tty 的指令将无法运行
#### `scale`
### `scale`
格式为 `docker-compose scale [options] [SERVICE=NUM...]`
@@ -223,13 +223,13 @@ $ docker-compose scale web=3 db=2
* `-t, --timeout TIMEOUT` 停止容器时候的超时默认为 10
#### `start`
### `start`
格式为 `docker-compose start [SERVICE...]`
启动已经存在的服务容器
#### `stop`
### `stop`
格式为 `docker-compose stop [options] [SERVICE...]`
@@ -239,17 +239,17 @@ $ docker-compose scale web=3 db=2
* `-t, --timeout TIMEOUT` 停止容器时候的超时默认为 10
#### `top`
### `top`
查看各个服务容器内运行的进程
#### `unpause`
### `unpause`
格式为 `docker-compose unpause [SERVICE...]`
恢复处于暂停状态中的服务
#### `up`
### `up`
格式为 `docker-compose up [options] [SERVICE...]`
@@ -283,12 +283,12 @@ $ docker-compose scale web=3 db=2
* `-t, --timeout TIMEOUT` 停止容器时候的超时默认为 10
#### `version`
### `version`
格式为 `docker-compose version`
打印版本信息
### 参考资料
## 参考资料
* [官方文档](https://docs.docker.com/compose/reference/overview/)