Update title style

Signed-off-by: Kang HuaiShuai <khs1994@khs1994.com>
2026-03-10 11:54:37 +00:00 · 2019-11-05 23:35:43 +08:00
parent 3ba7560b4d
commit 709c77adcb
39 changed files with 297 additions and 316 deletions
--- a/compose/commands.md
+++ b/compose/commands.md
@@ -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/)
--- a/compose/compose_file.md
+++ b/compose/compose_file.md
@@ -1,4 +1,4 @@
-## Compose 模板文件
+# Compose 模板文件

 模板文件是使用 `Compose` 的核心，涉及到的指令关键字也比较多。但大家不用担心，这里面大部分指令跟 `docker run` 相关参数的含义都是类似的。

@@ -22,7 +22,7 @@ services:

 下面分别介绍各个指令的用法。

-### `build`
+## `build`

 指定 `Dockerfile` 所在文件夹的路径（可以是绝对路径，或者相对 docker-compose.yml 文件的路径）。 `Compose` 将会利用它自动构建这个镜像，然后使用这个镜像。

@@ -62,7 +62,7 @@ build:
    - corp/web_app:3.14
 ```

-### `cap_add, cap_drop`
+## `cap_add, cap_drop`

 指定容器的内核能力（capacity）分配。

@@ -80,7 +80,7 @@ cap_drop:
  - NET_ADMIN
 ```

-### `command`
+## `command`

 覆盖容器启动后默认执行的命令。

@@ -88,11 +88,11 @@ cap_drop:
 command: echo "hello world"
 ```

-### `configs`
+## `configs`

 仅用于 `Swarm mode`，详细内容请查看 [`Swarm mode`](../swarm_mode/) 一节。

-### `cgroup_parent`
+## `cgroup_parent`

 指定父 `cgroup` 组，意味着将继承该组的资源限制。

@@ -102,7 +102,7 @@ command: echo "hello world"
 cgroup_parent: cgroups_1
 ```

-### `container_name`
+## `container_name`

 指定容器名称。默认将会使用 `项目名称_服务名称_序号` 这样的格式。

@@ -112,11 +112,11 @@ container_name: docker-web-container

 >注意: 指定容器名称后，该服务将无法进行扩展（scale），因为 Docker 不允许多个容器具有相同的名称。

-### `deploy`
+## `deploy`

 仅用于 `Swarm mode`，详细内容请查看 [`Swarm mode`](../swarm_mode/) 一节

-### `devices`
+## `devices`

 指定设备映射关系。

@@ -125,7 +125,7 @@ devices:
  - "/dev/ttyUSB1:/dev/ttyUSB0"
 ```

-### `depends_on`
+## `depends_on`

 解决容器的依赖、启动先后的问题。以下例子中会先启动 `redis` `db` 再启动 `web`

@@ -148,7 +148,7 @@ services:

 >注意：`web` 服务不会等待 `redis` `db` 「完全启动」之后才启动。

-### `dns`
+## `dns`

 自定义 `DNS` 服务器。可以是一个值，也可以是一个列表。

@@ -160,7 +160,7 @@ dns:
  - 114.114.114.114
 ```

-### `dns_search`
+## `dns_search`

 配置 `DNS` 搜索域。可以是一个值，也可以是一个列表。

@@ -172,7 +172,7 @@ dns_search:
  - domain2.example.com
 ```

-### `tmpfs`
+## `tmpfs`

 挂载一个 tmpfs 文件系统到容器。

@@ -183,7 +183,7 @@ tmpfs:
  - /tmp
 ```

-### `env_file`
+## `env_file`

 从文件中获取环境变量，可以为单独的文件路径或列表。

@@ -207,7 +207,7 @@ env_file:
 PROG_ENV=development
 ```

-### `environment`
+## `environment`

 设置环境变量。你可以使用数组或字典两种格式。

@@ -229,7 +229,7 @@ environment:
 y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFF
 ```

-### `expose`
+## `expose`

 暴露端口，但不映射到宿主机，只被连接的服务访问。

@@ -241,7 +241,7 @@ expose:
 - "8000"
 ```

-### `external_links`
+## `external_links`

 >注意：不建议使用该指令。

@@ -254,7 +254,7 @@ external_links:
 - project_db_1:postgresql
 ```

-### `extra_hosts`
+## `extra_hosts`

 类似 Docker 中的 `--add-host` 参数，指定额外的 host 名称映射信息。

@@ -271,7 +271,7 @@ extra_hosts:
 52.1.157.61 dockerhub
 ```

-### `healthcheck`
+## `healthcheck`

 通过命令检查容器是否健康运行。

@@ -283,7 +283,7 @@ healthcheck:
  retries: 3
 ```

-### `image`
+## `image`

 指定为镜像名称或镜像 ID。如果镜像在本地不存在，`Compose` 将会尝试拉取这个镜像。

@@ -293,7 +293,7 @@ image: orchardup/postgresql
 image: a4bc65fd
 ```

-### `labels`
+## `labels`

 为容器添加 Docker 元数据（metadata）信息。例如可以为容器添加辅助说明信息。

@@ -304,11 +304,11 @@ labels:
  com.startupteam.release: "rc3 for v1.0"
 ```

-### `links`
+## `links`

 >注意：不推荐使用该指令。

-### `logging`
+## `logging`

 配置日志选项。

@@ -335,7 +335,7 @@ options:
  max-file: "10"
 ```

-### `network_mode`
+## `network_mode`

 设置网络模式。使用和 `docker run` 的 `--network` 参数一样的值。

@@ -347,7 +347,7 @@ network_mode: "service:[service name]"
 network_mode: "container:[container name/id]"
 ```

-### `networks`
+## `networks`

 配置容器连接的网络。

@@ -365,7 +365,7 @@ networks:
  other-network:
 ```

-### `pid`
+## `pid`

 跟主机系统共享进程命名空间。打开该选项的容器之间，以及容器和宿主机系统之间可以通过进程 ID 来相互访问和操作。

@@ -373,7 +373,7 @@ networks:
 pid: "host"
 ```

-### `ports`
+## `ports`

 暴露端口信息。

@@ -389,7 +389,7 @@ ports:

 *注意：当使用 `HOST:CONTAINER` 格式来映射端口时，如果你使用的容器端口小于 60 并且没放到引号里，可能会得到错误结果，因为 `YAML` 会自动解析 `xx:yy` 这种数字格式为 60 进制。为避免出现这种问题，建议数字串都采用引号包括起来的字符串格式。*

-### `secrets`
+## `secrets`

 存储敏感数据，例如 `mysql` 服务密码。

@@ -412,7 +412,7 @@ secrets:
    external: true
 ```

-### `security_opt`
+## `security_opt`

 指定容器模板标签（label）机制的默认属性（用户、角色、类型、级别等）。例如配置标签的用户名和角色名。

@@ -422,7 +422,7 @@ security_opt:
    - label:role:ROLE
 ```

-### `stop_signal`
+## `stop_signal`

 设置另一个信号来停止容器。在默认情况下使用的是 SIGTERM 停止容器。

@@ -430,7 +430,7 @@ security_opt:
 stop_signal: SIGUSR1
 ```

-### `sysctls`
+## `sysctls`

 配置容器内核参数。

@@ -444,7 +444,7 @@ sysctls:
  - net.ipv4.tcp_syncookies=0
 ```

-### `ulimits`
+## `ulimits`

 指定容器的 ulimits 限制值。

@@ -458,7 +458,7 @@ sysctls:
      hard: 40000
 ```

-### `volumes`
+## `volumes`

 数据卷所挂载路径设置。可以设置为宿主机路径(`HOST:CONTAINER`)或者数据卷名称(`VOLUME:CONTAINER`)，并且可以设置访问模式 （`HOST:CONTAINER:ro`）。

@@ -486,7 +486,7 @@ volumes:
  mysql_data:  
 ```

-### 其它指令
+## 其它指令

 此外，还有包括 `domainname, entrypoint, hostname, ipc, mac_address, privileged, read_only, shm_size, restart, stdin_open, tty, user, working_dir` 等指令，基本跟 `docker run` 中对应参数的功能一致。

@@ -546,7 +546,7 @@ stdin_open: true
 tty: true
 ```

-### 读取变量
+## 读取变量

 Compose 模板文件支持动态读取主机的系统环境变量和当前目录下的 `.env` 文件中的变量。

@@ -573,6 +573,6 @@ MONGO_VERSION=3.6

 执行 `docker-compose up` 则会启动一个 `mongo:3.6` 镜像的容器。

-### 参考资料
+## 参考资料

 * [官方文档](https://docs.docker.com/compose/compose-file/)
--- a/compose/django.md
+++ b/compose/django.md
@@ -1,4 +1,4 @@
-## 使用 Django
+# 使用 Django

 > 本小节内容适合 `Python` 开发人员阅读。

--- a/compose/install.md
+++ b/compose/install.md
@@ -1,4 +1,4 @@
-## 安装与卸载
+# 安装与卸载

 `Compose` 支持 Linux、macOS、Windows 10 三大平台。

@@ -14,7 +14,7 @@ docker-compose version 1.24.1, build 4667896b

 Linux 系统请使用以下介绍的方法安装。

-### 二进制包
+## 二进制包

 在 Linux 上的也安装十分简单，从 [官方 GitHub Release](https://github.com/docker/compose/releases) 处直接下载编译好的二进制文件即可。

@@ -26,7 +26,7 @@ $ sudo curl -L https://github.com/docker/compose/releases/download/1.24.1/docker
 $ sudo chmod +x /usr/local/bin/docker-compose
 ```

-### PIP 安装
+## PIP 安装

 *注：* `x86_64` 架构的 Linux 建议按照上边的方法下载二进制包进行安装，如果您计算机的架构是 `ARM` (例如，树莓派)，再使用 `pip` 安装。

@@ -47,13 +47,13 @@ Collecting docker-compose
 Successfully installed docker-compose cached-property requests texttable websocket-client docker-py dockerpty six enum34 backports.ssl-match-hostname ipaddress
 ```

-### bash 补全命令
+## bash 补全命令

 ```bash
 $ curl -L https://raw.githubusercontent.com/docker/compose/1.24.1/contrib/completion/bash/docker-compose > /etc/bash_completion.d/docker-compose
 ```

-### 卸载
+## 卸载

 如果是二进制包方式安装的，删除二进制文件即可。

--- a/compose/introduction.md
+++ b/compose/introduction.md
@@ -1,4 +1,4 @@
-## Compose 简介
+# Compose 简介

 `Compose` 项目是 Docker 官方的开源项目，负责实现对 Docker 容器集群的快速编排。从功能上看，跟 `OpenStack` 中的 `Heat` 十分类似。

--- a/compose/rails.md
+++ b/compose/rails.md
@@ -1,4 +1,4 @@
-## 使用 Rails
+# 使用 Rails

 > 本小节内容适合 `Ruby` 开发人员阅读。

--- a/compose/usage.md
+++ b/compose/usage.md
@@ -1,6 +1,6 @@
-## 使用
+# 使用

-### 术语
+## 术语

 首先介绍几个术语。

@@ -10,13 +10,13 @@

 可见，一个项目可以由多个服务（容器）关联而成，`Compose` 面向项目进行管理。

-### 场景
+## 场景

 最常见的项目是 web 网站，该项目应该包含 web 应用和缓存。

 下面我们用 `Python` 来建立一个能够记录页面访问次数的 web 网站。

-#### web 应用
+### web 应用

 新建文件夹，在该目录中编写 `app.py` 文件

@@ -36,7 +36,7 @@ if __name__ == "__main__":
    app.run(host="0.0.0.0", debug=True)
 ```

-#### Dockerfile
+### Dockerfile

 编写 `Dockerfile` 文件，内容为

@@ -48,7 +48,7 @@ RUN pip install redis flask
 CMD ["python", "app.py"]
 ```

-#### docker-compose.yml
+### docker-compose.yml

 编写 `docker-compose.yml` 文件，这个是 Compose 使用的主模板文件。

@@ -65,7 +65,7 @@ services:
    image: "redis:alpine"
 ```

-#### 运行 compose 项目
+### 运行 compose 项目

 ```bash
 $ docker-compose up
--- a/compose/wordpress.md
+++ b/compose/wordpress.md
@@ -1,14 +1,14 @@
-## 使用 WordPress
+# 使用 WordPress

 > 本小节内容适合 `PHP` 开发人员阅读。

 `Compose` 可以很便捷的让 `Wordpress` 运行在一个独立的环境中。

-### 创建空文件夹
+## 创建空文件夹

 假设新建一个名为 `wordpress` 的文件夹，然后进入这个文件夹。

-### 创建 `docker-compose.yml` 文件
+## 创建 `docker-compose.yml` 文件

 [`docker-compose.yml`](https://github.com/yeasy/docker_practice/blob/master/compose/demo/wordpress/docker-compose.yml) 文件将开启一个 `wordpress` 服务和一个独立的 `MySQL` 实例：

@@ -46,6 +46,6 @@ volumes:
  db_data:
 ```

-### 构建并运行项目
+## 构建并运行项目

 运行 `docker-compose up -d` Compose 就会拉取镜像再创建我们所需要的镜像，然后启动 `wordpress` 和数据库容器。 接着浏览器访问 `127.0.0.1:8000` 端口就能看到 `WordPress` 安装界面了。