style: apply global formatting fixes (struct, spacing, zhlint)

This commit is contained in:
Baohua Yang
2026-02-21 11:08:52 -08:00
parent ad68b2d973
commit 79ac9c639a
159 changed files with 1708 additions and 882 deletions

View File

@@ -2,7 +2,7 @@
模板文件是使用 `Compose` 的核心涉及到的指令关键字也比较多但大家不用担心这里面大部分指令跟 `docker run` 相关参数的含义都是类似的
默认的模板文件名称为 `compose.yaml`也兼容 `docker-compose.yml` 等历史文件名格式为 YAML
默认的模板文件名称为 `compose.yaml` (也兼容 `docker-compose.yml` 等历史文件名)格式为 YAML
```yaml
services:
@@ -14,15 +14,15 @@ services:
- "/data"
```
注意每个服务都必须通过 `image` 指令指定镜像或 `build` 指令需要 Dockerfile等来自动构建生成镜像
注意每个服务都必须通过 `image` 指令指定镜像或 `build` 指令 (需要 Dockerfile) 等来自动构建生成镜像
如果使用 `build` 指令 `Dockerfile` 中设置的选项例如`CMD``EXPOSE``VOLUME``ENV` 将会自动被获取无需在 Compose 文件中重复设置
如果使用 `build` 指令 `Dockerfile` 中设置的选项 (例如`CMD``EXPOSE``VOLUME``ENV` ) 将会自动被获取无需在 Compose 文件中重复设置
下面分别介绍各个指令的用法
### `build`
指定 `Dockerfile` 所在文件夹的路径可以是绝对路径或者相对 Compose 文件的路径`Compose` 将会利用它自动构建这个镜像然后使用这个镜像
指定 `Dockerfile` 所在文件夹的路径 (可以是绝对路径或者相对 Compose 文件的路径)`Compose` 将会利用它自动构建这个镜像然后使用这个镜像
```yaml
services:
@@ -58,7 +58,7 @@ build:
### `cap_add, cap_drop`
指定容器的内核能力capacity分配
指定容器的内核能力 (capacity) 分配
例如让容器拥有所有能力可以指定为
@@ -104,7 +104,7 @@ cgroup_parent: cgroups_1
container_name: docker-web-container
```
>注意: 指定容器名称后该服务将无法进行扩展scale因为 Docker 不允许多个容器具有相同的名称
>注意指定容器名称后该服务将无法进行扩展 (scale)因为 Docker 不允许多个容器具有相同的名称
### `deploy`
@@ -138,7 +138,7 @@ services:
image: postgres
```
>注意`web` 服务不会等待 `redis` `db` 完全启动之后才启动
>注意`web` 服务不会等待 `redis` `db` 完全启动 之后才启动
### `dns`
@@ -216,7 +216,7 @@ environment:
- SESSION_SECRET
```
如果变量名称或者值中用到 `true|falseyes|no` 等表达 [布尔](https://yaml.org/type/bool.html) 含义的词汇,最好放到引号里,避免 YAML 自动解析某些内容为对应的布尔语义。这些特定词汇,包括
如果变量名称或者值中用到 `true|falseyes|no` 等表达[布尔](https://yaml.org/type/bool.html)含义的词汇,最好放到引号里,避免 YAML 自动解析某些内容为对应的布尔语义。这些特定词汇,包括
```bash
y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFF
@@ -288,7 +288,7 @@ image: a4bc65fd
### `labels`
为容器添加 Docker 元数据metadata信息例如可以为容器添加辅助说明信息
为容器添加 Docker 元数据 (metadata) 信息例如可以为容器添加辅助说明信息
```yaml
labels:
@@ -299,7 +299,7 @@ labels:
### `links`
>注意不推荐使用该指令容器之间应通过 Docker 网络networks进行互联
>注意不推荐使用该指令容器之间应通过 Docker 网络 (networks) 进行互联
### `logging`
@@ -370,7 +370,7 @@ pid: "host"
暴露端口信息
使用宿主端口容器端口 `(HOST:CONTAINER)` 格式或者仅仅指定容器的端口宿主将会随机选择端口都可以
使用宿主端口容器端口 `(HOST:CONTAINER)` 格式或者仅仅指定容器的端口 (宿主将会随机选择端口) 都可以
```yaml
ports:
@@ -407,7 +407,7 @@ secrets:
### `security_opt`
指定容器模板标签label机制的默认属性用户角色类型级别等例如配置标签的用户名和角色名
指定容器模板标签 (label) 机制的默认属性 (用户角色类型级别等)例如配置标签的用户名和角色名
```yaml
security_opt:
@@ -441,7 +441,7 @@ sysctls:
指定容器的 ulimits 限制值
例如指定最大进程数为 65535指定文件句柄数为 20000软限制应用可以随时修改不能超过硬限制 40000系统硬限制只能 root 用户提高
例如指定最大进程数为 65535指定文件句柄数为 20000 (软限制应用可以随时修改不能超过硬限制) 40000 (系统硬限制只能 root 用户提高)
```yaml
ulimits:
@@ -453,7 +453,7 @@ sysctls:
### `volumes`
数据卷所挂载路径设置可以设置为宿主机路径(`HOST:CONTAINER`)或者数据卷名称(`VOLUME:CONTAINER`)并且可以设置访问模式 `HOST:CONTAINER:ro`
数据卷所挂载路径设置可以设置为宿主机路径 (`HOST:CONTAINER`) 或者数据卷名称 (`VOLUME:CONTAINER`)并且可以设置访问模式 (`HOST:CONTAINER:ro`)
该指令中路径支持相对路径