mirror of
https://github.com/yeasy/docker_practice.git
synced 2026-03-11 04:14:38 +00:00
Fix format issue
This commit is contained in:
Baohua Yang
33
16_appendix/16.4_terminology.md
Normal file
33
16_appendix/16.4_terminology.md
Normal file
@@ -0,0 +1,33 @@
|
||||
## 16.4 术语词表（出版统一版）
|
||||
|
||||
本词表用于统一全书术语、缩写和命令表达，适用于最终出版前清稿。
|
||||
|
||||
### 核心术语统一表
|
||||
|
||||
| 统一写法（推荐） | 可接受写法 | 避免写法 | 说明 |
|
||||
|---|---|---|---|
|
||||
| Docker Engine | Docker 引擎 | docker engine | 产品名首字母大写。 |
|
||||
| Docker Desktop | - | docker desktop | 产品名首字母大写。 |
|
||||
| Dockerfile | - | Docker File、dockerfile | 固定拼写。 |
|
||||
| Docker 镜像（Image） | 镜像 | image（纯英文散落） | 首次出现建议中英文并列。 |
|
||||
| Docker 容器（Container） | 容器 | container（纯英文散落） | 与镜像区分清楚。 |
|
||||
| 仓库（Repository） | Repo（非正式） | 镜像仓库/Repository 混用不解释 | 首次出现需给出英文。 |
|
||||
| 注册服务器（Registry） | 镜像注册服务 | 私有仓库/Registry 混指 | Registry 与 Repository 需区分。 |
|
||||
| 标签（Tag） | 版本标签 | tag（正文中小写裸写） | 命令中保留原样。 |
|
||||
| Docker Compose | Compose | docker compose（当作产品名） | 产品名用 `Docker Compose`。 |
|
||||
| `docker compose` | - | `docker-compose`（新示例中） | 命令统一使用 V2 子命令写法。 |
|
||||
| `compose.yaml` | `compose.yml` | 新示例继续使用 `docker-compose.yml` | 教学默认文件名统一为 `compose.yaml`。 |
|
||||
| Kubernetes | K8s（缩写） | kubernetes（正文） | 正文统一首字母大写。 |
|
||||
| `kubectl` | - | kubeclt（拼写错误） | 命令与二进制名用反引号包裹。 |
|
||||
| etcd | - | Etcd（混用） | 项目官方写法为小写 `etcd`。 |
|
||||
| Docker Buildx | Buildx | buildx（正文裸写） | 产品名用 `Docker Buildx`。 |
|
||||
| BuildKit | - | buildkit | 固定大小写。 |
|
||||
| 控制平面（Control Plane） | - | 主控平面（未定义） | 章节内保持单一译名。 |
|
||||
| 工作节点（Worker Node） | 节点（在上下文明确时） | 工作机器（未定义） | 与控制平面对照使用。 |
|
||||
|
||||
### 清稿执行规则
|
||||
|
||||
1. 术语首次出现采用“中文（英文）”格式，例如“注册服务器（Registry）”。
|
||||
2. 命令、文件名、配置键统一使用反引号包裹。
|
||||
3. 同一章节中，术语只保留一种主写法，不混用同义词。
|
||||
4. 若引用历史名词（如 `docker-compose.yml`），需显式标注“历史文件名”。
|
||||
27
16_appendix/16.5_editorial_style.md
Normal file
27
16_appendix/16.5_editorial_style.md
Normal file
@@ -0,0 +1,27 @@
|
||||
## 16.5 出版清稿规范（图号与章节风格）
|
||||
|
||||
本规范用于最终出版前清稿，确保全书图号、图题、章节结构与行文风格一致。
|
||||
|
||||
### 图号与图题规范
|
||||
|
||||
1. 图号格式统一为：`图 <章号>-<序号> <图题>`，例如 `图 10-2 Rails + PostgreSQL 的 Compose 架构`。
|
||||
2. 图号在同一章内按出现顺序连续编号，不重复、不跳号。
|
||||
3. 正文引用图片统一写法：`如图 <章号>-<序号> 所示`，不使用“下图/上图/示意图如下”。
|
||||
4. 所有图片必须提供有意义的 alt 文本，不使用空 alt（``）。
|
||||
5. 图题单独成行，放在图片下方。
|
||||
|
||||
### 章节风格规范
|
||||
|
||||
1. 小节标题统一使用编号体例：`## 10.6 ...`、`### 步骤 1：...`。
|
||||
2. 步骤型内容统一使用“步骤 N：”中文格式，不使用 `Step N:`。
|
||||
3. 命令行示例统一以 `bash` 代码块展示，提示符统一为 `$`。
|
||||
4. 关键提醒统一使用引用块（`> 注意/提示/警告`），避免正文中混杂多种强调样式。
|
||||
5. 章节内术语使用需遵循《[术语词表（出版统一版）](16.4_terminology.md)》。
|
||||
|
||||
### 出版前自检清单
|
||||
|
||||
1. 是否仍存在“下图/上图/示意图如下”等相对指代。
|
||||
2. 是否存在未编号或编号冲突的图题。
|
||||
3. 是否存在 `kubernetes`、`compose` 等正文大小写不统一写法。
|
||||
4. 是否存在 `Step N:` 与“步骤 N：”混用。
|
||||
5. 是否存在未加反引号的命令、文件名和配置键名。
|
||||
@@ -10,3 +10,5 @@
|
||||
* [**Dockerfile 最佳实践**](16.1_best_practices.md)：提供编写高效、安全 Dockerfile 的指导原则。
|
||||
* [**如何调试 Docker**](16.2_debug.md)：介绍 Docker 调试技巧和工具。
|
||||
* [**资源链接**](16.3_resources.md)：推荐更多 Docker 相关的学习资源。
|
||||
* [**术语词表（出版统一版）**](16.4_terminology.md)：统一全书中英文术语、缩写与命令写法。
|
||||
* [**出版清稿规范（图号与章节风格）**](16.5_editorial_style.md)：统一图号命名、图题写法与章节风格。
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
* `--tls=true|false`：是否对 Docker 守护进程启用 TLS 安全机制，默认为否；
|
||||
* `--tlscacert=/.docker/ca.pem`：TLS CA 签名的可信证书文件路径；
|
||||
* `--tlscert=/.docker/cert.pem`：TLS 可信证书文件路径；
|
||||
* `--tlscert=/.docker/key.pem`：TLS 密钥文件路径；
|
||||
* `--tlskey=/.docker/key.pem`：TLS 密钥文件路径；
|
||||
* `--tlsverify=true|false`：启用 TLS 校验，默认为否。
|
||||
|
||||
### 客户端命令
|
||||
@@ -64,10 +64,12 @@
|
||||
|
||||
### 一张图总结 Docker 的命令
|
||||
|
||||
一张图总结 Docker 的命令 示意图如下：
|
||||
如图 16-1 所示，Docker 常用客户端命令可按功能分组理解。
|
||||
|
||||
|
||||
|
||||
图 16-1 Docker 客户端命令分类示意图
|
||||
|
||||
### 参考
|
||||
|
||||
* [官方文档](https://docs.docker.com/engine/reference/commandline/cli/)
|
||||
* [官方文档](https://docs.docker.com/reference/cli/docker/)
|
||||
|
||||
@@ -1,58 +1,40 @@
|
||||
## 服务端命令（dockerd）
|
||||
|
||||
### dockerd 命令选项
|
||||
### 使用说明
|
||||
|
||||
* `--api-cors-header=""`：CORS 头部域，默认不允许 CORS，要允许任意的跨域访问，可以指定为 "*"；
|
||||
* `--authorization-plugin=""`：载入认证的插件；
|
||||
* `-b=""`：将容器挂载到一个已存在的网桥上。指定为 `none` 时则禁用容器的网络，与 `--bip` 选项互斥；
|
||||
* `--bip=""`：让动态创建的 `docker0` 网桥采用给定的 CIDR 地址; 与 `-b` 选项互斥；
|
||||
* `--cgroup-parent=""`：指定 cgroup 的父组，默认 fs cgroup 驱动为 `/docker`，systemd cgroup 驱动为 `system.slice`；
|
||||
* `--cluster-store=""`：构成集群（如 `Swarm`）时，集群键值数据库服务地址；
|
||||
* `--cluster-advertise=""`：构成集群时，自身的被访问地址，可以为 `host:port` 或 `interface:port`；
|
||||
* `--cluster-store-opt=""`：构成集群时，键值数据库的配置选项；
|
||||
* `--config-file="/etc/docker/daemon.json"`：daemon 配置文件路径；
|
||||
* `--containerd=""`：containerd 文件的路径；
|
||||
* `-D, --debug=true|false`：是否使用 Debug 模式。缺省为 false；
|
||||
* `--default-gateway=""`：容器的 IPv4 网关地址，必须在网桥的子网段内；
|
||||
* `--default-gateway-v6=""`：容器的 IPv6 网关地址；
|
||||
* `--default-ulimit=[]`：默认的 ulimit 值；
|
||||
* `--disable-legacy-registry=true|false`：是否允许访问旧版本的镜像仓库服务器；
|
||||
* `--dns=""`：指定容器使用的 DNS 服务器地址；
|
||||
* `--dns-opt=""`：DNS 选项；
|
||||
* `--dns-search=[]`：DNS 搜索域；
|
||||
* `--exec-opt=[]`：运行时的执行选项；
|
||||
* `--exec-root=""`：容器执行状态文件的根路径，默认为 `/var/run/docker`；
|
||||
* `--fixed-cidr=""`：限定分配 IPv4 地址范围；
|
||||
* `--fixed-cidr-v6=""`：限定分配 IPv6 地址范围；
|
||||
* `-G, --group=""`：分配给 unix 套接字的组，默认为 `docker`；
|
||||
* `-g, --graph=""`：Docker 运行时的根路径，默认为 `/var/lib/docker`；
|
||||
* `-H, --host=[]`：指定命令对应 Docker daemon 的监听接口，可以为 unix 套接字 `unix:///path/to/socket`，文件句柄 `fd://socketfd` 或 tcp 套接字 `tcp://[host[:port]]`，默认为 `unix:///var/run/docker.sock`；
|
||||
* `--icc=true|false`：是否启用容器间以及跟 daemon 所在主机的通信。默认为 true。
|
||||
* `--insecure-registry=[]`：允许访问给定的非安全仓库服务；
|
||||
* `--ip=""`：绑定容器端口时候的默认 IP 地址。缺省为 `0.0.0.0`；
|
||||
* `--ip-forward=true|false`：是否检查启动在 Docker 主机上的启用 IP 转发服务，默认开启。注意关闭该选项将不对系统转发能力进行任何检查修改；
|
||||
* `--ip-masq=true|false`：是否进行地址伪装，用于容器访问外部网络，默认开启；
|
||||
* `--iptables=true|false`：是否允许 Docker 添加 iptables 规则。缺省为 true；
|
||||
* `--ipv6=true|false`：是否启用 IPv6 支持，默认关闭；
|
||||
* `-l, --log-level="debug|info|warn|error|fatal"`：指定日志输出级别；
|
||||
* `--label="[]"`：添加指定的键值对标注；
|
||||
* `--log-driver="json-file|syslog|journald|gelf|fluentd|awslogs|splunk|etwlogs|gcplogs|none"`：指定日志后端驱动，默认为 `json-file`；
|
||||
* `--log-opt=[]`：日志后端的选项；
|
||||
* `--mtu=VALUE`：指定容器网络的 `mtu`；
|
||||
* `-p=""`：指定 daemon 的 PID 文件路径。缺省为 `/var/run/docker.pid`；
|
||||
* `--raw-logs`：输出原始，未加色彩的日志信息；
|
||||
* `--registry-mirror=<scheme>://<host>`：指定 `docker pull` 时使用的注册服务器镜像地址；
|
||||
* `-s, --storage-driver=""`：指定使用给定的存储后端；
|
||||
* `--selinux-enabled=true|false`：是否启用 SELinux 支持。缺省值为 false。SELinux 目前尚不支持 overlay 存储驱动；
|
||||
* `--storage-opt=[]`：驱动后端选项；
|
||||
* `--tls=true|false`：是否对 Docker daemon 启用 TLS 安全机制，默认为否；
|
||||
* `--tlscacert=/.docker/ca.pem`：TLS CA 签名的可信证书文件路径；
|
||||
* `--tlscert=/.docker/cert.pem`：TLS 可信证书文件路径；
|
||||
* `--tlscert=/.docker/key.pem`：TLS 密钥文件路径；
|
||||
* `--tlsverify=true|false`：启用 TLS 校验，默认为否；
|
||||
* `--userland-proxy=true|false`：是否使用用户态代理来实现容器间和出容器的回环通信，默认为 true；
|
||||
* `--userns-remap=default|uid:gid|user:group|user|uid`：指定容器的用户命名空间，默认是创建新的 UID 和 GID 映射到容器内进程。
|
||||
`dockerd` 参数会随版本变化。建议优先在目标机器上执行 `dockerd --help`，并以 `daemon.json` 为主进行持久化配置。
|
||||
|
||||
### 常用选项（Docker Engine 29.x）
|
||||
|
||||
* `--config-file="/etc/docker/daemon.json"`：指定 daemon 配置文件路径；
|
||||
* `--data-root=""`：Docker 数据目录（默认 `/var/lib/docker`）；
|
||||
* `-H, --host=[]`：指定 daemon 监听地址（Unix socket / TCP）；
|
||||
* `-D, --debug`：开启调试日志；
|
||||
* `-l, --log-level="debug|info|warn|error|fatal"`：日志级别；
|
||||
* `--group=""`：Unix socket 所属用户组（默认 `docker`）；
|
||||
* `--containerd=""`：指定 containerd socket；
|
||||
* `--exec-opt=[]`：运行时执行选项（如 cgroup 驱动）；
|
||||
* `--default-ulimit=[]`：设置容器默认 ulimit；
|
||||
* `--dns=[]` / `--dns-search=[]` / `--dns-opt=[]`：DNS 配置；
|
||||
* `--registry-mirror=[]`：镜像加速地址；
|
||||
* `--insecure-registry=[]`：允许访问不安全仓库；
|
||||
* `--iptables=true|false` / `--ip-forward=true|false` / `--ip-masq=true|false`：网络转发与 NAT 规则控制；
|
||||
* `--ipv6=true|false`：启用 IPv6；
|
||||
* `--storage-driver=""` / `--storage-opt=[]`：存储驱动及参数；
|
||||
* `--log-driver=""` / `--log-opt=[]`：容器日志驱动与参数；
|
||||
* `--authorization-plugin=[]`：鉴权插件；
|
||||
* `--selinux-enabled=true|false`：启用 SELinux 集成（依赖发行版策略）；
|
||||
* `--userns-remap=...`：用户命名空间映射；
|
||||
* `--tls` / `--tlscacert` / `--tlscert` / `--tlskey` / `--tlsverify`：TLS 安全配置。
|
||||
|
||||
### 历史参数提示
|
||||
|
||||
以下参数已移除或不建议继续使用：
|
||||
|
||||
* `--graph`：请改用 `--data-root`；
|
||||
* `--cluster-store` / `--cluster-advertise` / `--cluster-store-opt`：已移除；
|
||||
* `--disable-legacy-registry`：已移除。
|
||||
|
||||
### 参考
|
||||
|
||||
* [官方文档](https://docs.docker.com/engine/reference/commandline/dockerd/)
|
||||
* [官方文档](https://docs.docker.com/reference/cli/dockerd/)
|
||||
|
||||
@@ -102,11 +102,11 @@ $ docker run --network=my-net --ip=172.25.3.3 -itd --name=my-container busybox
|
||||
|
||||
### Docker 的配置文件放在哪里，如何修改配置？
|
||||
|
||||
答：使用 `systemd` 的系统（如 Ubuntu 16.04、Centos 等）的配置文件在 `/etc/docker/daemon.json`。
|
||||
答：使用 `systemd` 的系统（如 Ubuntu 22.04+、Debian 12+、Rocky/Alma/CentOS Stream 9+）的配置文件在 `/etc/docker/daemon.json`。
|
||||
|
||||
### 如何更改 Docker 的默认存储位置？
|
||||
|
||||
答：Docker 的默认存储位置是 `/var/lib/docker`，如果希望将 Docker 的本地文件存储到其他分区，可以使用 Linux 软连接的方式来完成，或者在启动 daemon 时通过 `-g` 参数指定，或者修改配置文件 `/etc/docker/daemon.json` 的 "data-root" 项 。可以使用 `docker system info | grep "Root Dir"` 查看当前使用的存储位置。
|
||||
答：Docker 的默认存储位置是 `/var/lib/docker`，如果希望将 Docker 的本地文件存储到其他分区，可以使用 Linux 软连接的方式来完成，或者修改配置文件 `/etc/docker/daemon.json` 的 `data-root` 项。可以使用 `docker info | grep "Docker Root Dir"` 查看当前使用的存储位置。
|
||||
|
||||
例如，如下操作将默认存储位置迁移到 /storage/docker。
|
||||
|
||||
|
||||
Reference in New Issue
Block a user