From 572266b2f42d9b7b37324c9da2ae11bc86d4c0b2 Mon Sep 17 00:00:00 2001 From: Baohua Yang Date: Sun, 22 Feb 2026 16:04:41 -0800 Subject: [PATCH] Fix wrong links --- .gitignore | 8 + 02_basic_concept/2.2_container.md | 4 +- 04_image/summary.md | 2 +- 05_container/summary.md | 2 +- 07_dockerfile/summary.md | 6 +- 08_data/{volume.md => 8.1_volume.md} | 2 +- .../{bind-mounts.md => 8.2_bind-mounts.md} | 0 08_data/{tmpfs.md => 8.3_tmpfs.md} | 0 08_data/README.md | 4 +- 08_data/summary.md | 8 +- 09_network/{dns.md => 9.1_dns.md} | 0 ...{network_types.md => 9.2_network_types.md} | 0 ...ustom_network.md => 9.3_custom_network.md} | 0 ...er_linking.md => 9.4_container_linking.md} | 0 .../{port_mapping.md => 9.5_port_mapping.md} | 0 ..._isolation.md => 9.6_network_isolation.md} | 0 09_network/README.md | 12 +- 09_network/summary.md | 12 +- 11_compose/11.8_wordpress.md | 2 +- .../{intro.md => 13.1_intro.md} | 0 .../{concepts.md => 13.2_concepts.md} | 0 .../{design.md => 13.3_design.md} | 0 .../{advanced.md => 13.4_advanced.md} | 0 .../{practice.md => 13.5_practice.md} | 0 .../{kubeadm.md => 14.1_kubeadm.md} | 0 ...beadm-docker.md => 14.2_kubeadm-docker.md} | 2 +- ...cker-desktop.md => 14.3_docker-desktop.md} | 0 14_kubernetes_setup/{kind.md => 14.4_kind.md} | 0 14_kubernetes_setup/{k3s.md => 14.5_k3s.md} | 0 .../{systemd.md => 14.6_systemd.md} | 0 .../{dashboard.md => 14.7_dashboard.md} | 0 .../{kubectl.md => 14.8_kubectl.md} | 0 14_kubernetes_setup/summary.md | 4 +- 15_etcd/{intro.md => 15.1_intro.md} | 0 15_etcd/{install.md => 15.2_install.md} | 0 15_etcd/{cluster.md => 15.3_cluster.md} | 0 15_etcd/{etcdctl.md => 15.4_etcdctl.md} | 0 16_cloud/{intro.md => 16.1_intro.md} | 0 .../{tencentCloud.md => 16.2_tencentCloud.md} | 0 16_cloud/{alicloud.md => 16.3_alicloud.md} | 0 16_cloud/{aws.md => 16.4_aws.md} | 0 .../{multicloud.md => 16.6_multicloud.md} | 0 .../{coreos_intro.md => 17.1_coreos_intro.md} | 0 ...reos_install.md => 17.2_coreos_install.md} | 0 17_ecosystem/{podman.md => 17.3_podman.md} | 0 .../{kernel_ns.md => 18.1_kernel_ns.md} | 0 ...control_group.md => 18.2_control_group.md} | 0 .../{daemon_sec.md => 18.3_daemon_sec.md} | 0 ...apability.md => 18.4_kernel_capability.md} | 0 ...other_feature.md => 18.5_other_feature.md} | 0 19_observability/19.1_prometheus.md | 268 ++++++++++++++++++ 19_observability/19.2_elk.md | 212 ++++++++++++++ 19_observability/README.md | 11 +- 19_observability/elk.md | 130 --------- 19_observability/prometheus.md | 109 ------- 19_observability/summary.md | 41 ++- 20_cases_os/{busybox.md => 20.1_busybox.md} | 0 20_cases_os/{alpine.md => 20.2_alpine.md} | 0 20_cases_os/{debian.md => 20.3_debian.md} | 0 20_cases_os/{centos.md => 20.4_centos.md} | 0 20_cases_os/README.md | 8 +- ...ps_workflow.md => 21.1_devops_workflow.md} | 0 ...thub_actions.md => 21.2_github_actions.md} | 0 21_case_devops/{drone.md => 21.3_drone.md} | 0 .../{drone_demo.md => 21.4_drone_demo.md} | 0 21_case_devops/{ide.md => 21.5_ide.md} | 0 21_case_devops/{vsCode.md => 21.6_vsCode.md} | 0 21_case_devops/README.md | 12 +- README.md | 2 +- SUMMARY.md | 109 ++++--- appendix/20.1_best_practices.md | 2 +- check_dashes.py | 21 -- checker.py | 109 ------- find_lists_no_space.py | 34 --- fix_missing_spaces.py | 66 ----- fix_project_rules.py | 195 ------------- fixer.py | 115 -------- format_headings.py | 250 ---------------- 78 files changed, 626 insertions(+), 1136 deletions(-) rename 08_data/{volume.md => 8.1_volume.md} (99%) rename 08_data/{bind-mounts.md => 8.2_bind-mounts.md} (100%) rename 08_data/{tmpfs.md => 8.3_tmpfs.md} (100%) rename 09_network/{dns.md => 9.1_dns.md} (100%) rename 09_network/{network_types.md => 9.2_network_types.md} (100%) rename 09_network/{custom_network.md => 9.3_custom_network.md} (100%) rename 09_network/{container_linking.md => 9.4_container_linking.md} (100%) rename 09_network/{port_mapping.md => 9.5_port_mapping.md} (100%) rename 09_network/{network_isolation.md => 9.6_network_isolation.md} (100%) rename 13_kubernetes_concepts/{intro.md => 13.1_intro.md} (100%) rename 13_kubernetes_concepts/{concepts.md => 13.2_concepts.md} (100%) rename 13_kubernetes_concepts/{design.md => 13.3_design.md} (100%) rename 13_kubernetes_concepts/{advanced.md => 13.4_advanced.md} (100%) rename 13_kubernetes_concepts/{practice.md => 13.5_practice.md} (100%) rename 14_kubernetes_setup/{kubeadm.md => 14.1_kubeadm.md} (100%) rename 14_kubernetes_setup/{kubeadm-docker.md => 14.2_kubeadm-docker.md} (99%) rename 14_kubernetes_setup/{docker-desktop.md => 14.3_docker-desktop.md} (100%) rename 14_kubernetes_setup/{kind.md => 14.4_kind.md} (100%) rename 14_kubernetes_setup/{k3s.md => 14.5_k3s.md} (100%) rename 14_kubernetes_setup/{systemd.md => 14.6_systemd.md} (100%) rename 14_kubernetes_setup/{dashboard.md => 14.7_dashboard.md} (100%) rename 14_kubernetes_setup/{kubectl.md => 14.8_kubectl.md} (100%) rename 15_etcd/{intro.md => 15.1_intro.md} (100%) rename 15_etcd/{install.md => 15.2_install.md} (100%) rename 15_etcd/{cluster.md => 15.3_cluster.md} (100%) rename 15_etcd/{etcdctl.md => 15.4_etcdctl.md} (100%) rename 16_cloud/{intro.md => 16.1_intro.md} (100%) rename 16_cloud/{tencentCloud.md => 16.2_tencentCloud.md} (100%) rename 16_cloud/{alicloud.md => 16.3_alicloud.md} (100%) rename 16_cloud/{aws.md => 16.4_aws.md} (100%) rename 16_cloud/{multicloud.md => 16.6_multicloud.md} (100%) rename 17_ecosystem/{coreos_intro.md => 17.1_coreos_intro.md} (100%) rename 17_ecosystem/{coreos_install.md => 17.2_coreos_install.md} (100%) rename 17_ecosystem/{podman.md => 17.3_podman.md} (100%) rename 18_security/{kernel_ns.md => 18.1_kernel_ns.md} (100%) rename 18_security/{control_group.md => 18.2_control_group.md} (100%) rename 18_security/{daemon_sec.md => 18.3_daemon_sec.md} (100%) rename 18_security/{kernel_capability.md => 18.4_kernel_capability.md} (100%) rename 18_security/{other_feature.md => 18.5_other_feature.md} (100%) create mode 100644 19_observability/19.1_prometheus.md create mode 100644 19_observability/19.2_elk.md delete mode 100644 19_observability/elk.md delete mode 100644 19_observability/prometheus.md rename 20_cases_os/{busybox.md => 20.1_busybox.md} (100%) rename 20_cases_os/{alpine.md => 20.2_alpine.md} (100%) rename 20_cases_os/{debian.md => 20.3_debian.md} (100%) rename 20_cases_os/{centos.md => 20.4_centos.md} (100%) rename 21_case_devops/{devops_workflow.md => 21.1_devops_workflow.md} (100%) rename 21_case_devops/{github_actions.md => 21.2_github_actions.md} (100%) rename 21_case_devops/{drone.md => 21.3_drone.md} (100%) rename 21_case_devops/{drone_demo.md => 21.4_drone_demo.md} (100%) rename 21_case_devops/{ide.md => 21.5_ide.md} (100%) rename 21_case_devops/{vsCode.md => 21.6_vsCode.md} (100%) delete mode 100644 check_dashes.py delete mode 100644 checker.py delete mode 100644 find_lists_no_space.py delete mode 100644 fix_missing_spaces.py delete mode 100644 fix_project_rules.py delete mode 100644 fixer.py delete mode 100644 format_headings.py diff --git a/.gitignore b/.gitignore index ae19bcd..46fe6dc 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ *.tmp .idea/ _book/ +format_report.txt *.swp *.edx .DS_Store @@ -21,3 +22,10 @@ __pycache__/ # Check scripts check_project_rules.py +check_dashes.py +checker.py +find_lists_no_space.py +fix_missing_spaces.py +fix_project_rules.py +fixer.py +format_headings.py diff --git a/02_basic_concept/2.2_container.md b/02_basic_concept/2.2_container.md index 157b400..44f3ff8 100644 --- a/02_basic_concept/2.2_container.md +++ b/02_basic_concept/2.2_container.md @@ -129,8 +129,8 @@ $ docker rm abc123 | 方式 | 说明 | 适用场景 | |------|------|---------| -| **[数据卷 (Volume) ](../08_data/volume.md)** | Docker 管理的存储 | 数据库、应用数据 | -| **[绑定挂载 (Bind Mount) ](../08_data/bind-mounts.md)** | 挂载宿主机目录 | 开发时共享代码 | +| **[数据卷 (Volume) ](../08_data/8.1_volume.md)** | Docker 管理的存储 | 数据库、应用数据 | +| **[绑定挂载 (Bind Mount) ](../08_data/8.2_bind-mounts.md)** | 挂载宿主机目录 | 开发时共享代码 | ```bash ## 使用数据卷（推荐） diff --git a/04_image/summary.md b/04_image/summary.md index 5caeeb7..cd2d7cd 100644 --- a/04_image/summary.md +++ b/04_image/summary.md @@ -49,4 +49,4 @@ - [列出镜像](4.2_list.md)：查看和过滤镜像 - [删除容器](../05_container/5.6_rm.md)：清理容器 -- [数据卷](../08_data/volume.md)：清理数据卷 +- [数据卷](../08_data/8.1_volume.md)：清理数据卷 diff --git a/05_container/summary.md b/05_container/summary.md index 5e2db37..d998053 100644 --- a/05_container/summary.md +++ b/05_container/summary.md @@ -54,4 +54,4 @@ - [终止容器](5.3_stop.md)：优雅停止容器 - [删除镜像](../04_image/4.3_rm.md)：清理镜像 -- [数据卷](../08_data/volume.md)：数据卷管理 +- [数据卷](../08_data/8.1_volume.md)：数据卷管理 diff --git a/07_dockerfile/summary.md b/07_dockerfile/summary.md index 24c4ceb..4c32aec 100644 --- a/07_dockerfile/summary.md +++ b/07_dockerfile/summary.md @@ -191,8 +191,8 @@ ### 7.19.14 延伸阅读 -- [数据卷](../08_data/volume.md)：卷的管理和使用 -- [挂载主机目录](../08_data/bind-mounts.md)：Bind Mount +- [数据卷](../08_data/8.1_volume.md)：卷的管理和使用 +- [挂载主机目录](../08_data/8.2_bind-mounts.md)：Bind Mount - [Compose 数据管理](../11_compose/11.5_compose_file.md)：Compose 中的卷配置 | 要点 | 说明 | @@ -206,5 +206,5 @@ ### 7.19.15 延伸阅读 - [网络配置](../09_network/README.md)：Docker 网络详解 -- [端口映射](../09_network/port_mapping.md)：-p 参数详解 +- [端口映射](../09_network/9.5_port_mapping.md)：-p 参数详解 - [Compose 端口](../11_compose/11.5_compose_file.md)：Compose 中的端口配置 diff --git a/08_data/volume.md b/08_data/8.1_volume.md similarity index 99% rename from 08_data/volume.md rename to 08_data/8.1_volume.md index b97c00d..9c6701b 100644 --- a/08_data/volume.md +++ b/08_data/8.1_volume.md @@ -384,7 +384,7 @@ $ docker run -v mydata:/app/data nginx $ docker run -v /host/path:/app/data nginx ``` -详见[绑定挂载](bind-mounts.md)章节。 +详见[绑定挂载](8.2_bind-mounts.md)章节。 --- diff --git a/08_data/bind-mounts.md b/08_data/8.2_bind-mounts.md similarity index 100% rename from 08_data/bind-mounts.md rename to 08_data/8.2_bind-mounts.md diff --git a/08_data/tmpfs.md b/08_data/8.3_tmpfs.md similarity index 100% rename from 08_data/tmpfs.md rename to 08_data/8.3_tmpfs.md diff --git a/08_data/README.md b/08_data/README.md index 1719af4..ad83f43 100644 --- a/08_data/README.md +++ b/08_data/README.md @@ -8,5 +8,5 @@ 这一章介绍如何在 Docker 内部以及容器之间管理数据，在容器中管理数据主要有两种方式： -* [数据卷](volume.md) -* [挂载主机目录](bind-mounts.md) +* [数据卷](8.1_volume.md) +* [挂载主机目录](8.2_bind-mounts.md) diff --git a/08_data/summary.md b/08_data/summary.md index cf0d42c..0bbd6c6 100644 --- a/08_data/summary.md +++ b/08_data/summary.md @@ -12,8 +12,8 @@ ### 8.5.1 延伸阅读 -- [数据卷](volume.md)：Docker 管理的持久化存储 -- [tmpfs 挂载](tmpfs.md)：内存临时存储 +- [数据卷](8.1_volume.md)：Docker 管理的持久化存储 +- [tmpfs 挂载](8.3_tmpfs.md)：内存临时存储 - [Compose 数据管理](../11_compose/11.5_compose_file.md)：Compose 中的挂载配置 | 操作 | 命令 | @@ -27,6 +27,6 @@ ### 8.5.2 延伸阅读 -- [绑定挂载](bind-mounts.md)：挂载宿主机目录 -- [tmpfs 挂载](tmpfs.md)：内存中的临时存储 +- [绑定挂载](8.2_bind-mounts.md)：挂载宿主机目录 +- [tmpfs 挂载](8.3_tmpfs.md)：内存中的临时存储 - [存储驱动](../12_implementation/12.4_ufs.md)：Docker 存储的底层原理 diff --git a/09_network/dns.md b/09_network/9.1_dns.md similarity index 100% rename from 09_network/dns.md rename to 09_network/9.1_dns.md diff --git a/09_network/network_types.md b/09_network/9.2_network_types.md similarity index 100% rename from 09_network/network_types.md rename to 09_network/9.2_network_types.md diff --git a/09_network/custom_network.md b/09_network/9.3_custom_network.md similarity index 100% rename from 09_network/custom_network.md rename to 09_network/9.3_custom_network.md diff --git a/09_network/container_linking.md b/09_network/9.4_container_linking.md similarity index 100% rename from 09_network/container_linking.md rename to 09_network/9.4_container_linking.md diff --git a/09_network/port_mapping.md b/09_network/9.5_port_mapping.md similarity index 100% rename from 09_network/port_mapping.md rename to 09_network/9.5_port_mapping.md diff --git a/09_network/network_isolation.md b/09_network/9.6_network_isolation.md similarity index 100% rename from 09_network/network_isolation.md rename to 09_network/9.6_network_isolation.md diff --git a/09_network/README.md b/09_network/README.md index 9eaf425..1df0064 100644 --- a/09_network/README.md +++ b/09_network/README.md @@ -33,9 +33,9 @@ graph TD ## 本章内容 -* [配置 DNS](dns.md) -* [外部访问容器](port_mapping.md) -* [网络类型](network_types.md) -* [自定义网络](custom_network.md) -* [容器互联](container_linking.md) -* [网络隔离](network_isolation.md) +* [配置 DNS](9.1_dns.md) +* [外部访问容器](9.5_port_mapping.md) +* [网络类型](9.2_network_types.md) +* [自定义网络](9.3_custom_network.md) +* [容器互联](9.4_container_linking.md) +* [网络隔离](9.6_network_isolation.md) diff --git a/09_network/summary.md b/09_network/summary.md index a22dead..d0b621a 100644 --- a/09_network/summary.md +++ b/09_network/summary.md @@ -14,11 +14,11 @@ ### 9.8.1 延伸阅读 -- [配置 DNS](dns.md)：自定义 DNS 设置 -- [网络类型](network_types.md)：Bridge、Host、None 等网络模式 -- [自定义网络](custom_network.md)：创建和管理自定义网络 -- [容器互联](container_linking.md)：容器间通信方式 -- [端口映射](port_mapping.md)：高级端口配置 -- [网络隔离](network_isolation.md)：网络安全与隔离策略 +- [配置 DNS](9.1_dns.md)：自定义 DNS 设置 +- [网络类型](9.2_network_types.md)：Bridge、Host、None 等网络模式 +- [自定义网络](9.3_custom_network.md)：创建和管理自定义网络 +- [容器互联](9.4_container_linking.md)：容器间通信方式 +- [端口映射](9.5_port_mapping.md)：高级端口配置 +- [网络隔离](9.6_network_isolation.md)：网络安全与隔离策略 - [EXPOSE 指令](../07_dockerfile/7.9_expose.md)：在 Dockerfile 中声明端口 - [Compose 网络](../11_compose/11.5_compose_file.md)：Compose 中的网络配置 diff --git a/11_compose/11.8_wordpress.md b/11_compose/11.8_wordpress.md index 3719985..909804a 100644 --- a/11_compose/11.8_wordpress.md +++ b/11_compose/11.8_wordpress.md @@ -217,5 +217,5 @@ $ docker compose restart wordpress ### 11.8.7 延伸阅读 - [Compose 模板文件](11.5_compose_file.md)：深入了解配置项 -- [数据卷](../08_data/volume.md)：理解数据持久化 +- [数据卷](../08_data/8.1_volume.md)：理解数据持久化 - [Docker Hub WordPress](https://hub.docker.com/_/wordpress)：官方镜像文档 diff --git a/13_kubernetes_concepts/intro.md b/13_kubernetes_concepts/13.1_intro.md similarity index 100% rename from 13_kubernetes_concepts/intro.md rename to 13_kubernetes_concepts/13.1_intro.md diff --git a/13_kubernetes_concepts/concepts.md b/13_kubernetes_concepts/13.2_concepts.md similarity index 100% rename from 13_kubernetes_concepts/concepts.md rename to 13_kubernetes_concepts/13.2_concepts.md diff --git a/13_kubernetes_concepts/design.md b/13_kubernetes_concepts/13.3_design.md similarity index 100% rename from 13_kubernetes_concepts/design.md rename to 13_kubernetes_concepts/13.3_design.md diff --git a/13_kubernetes_concepts/advanced.md b/13_kubernetes_concepts/13.4_advanced.md similarity index 100% rename from 13_kubernetes_concepts/advanced.md rename to 13_kubernetes_concepts/13.4_advanced.md diff --git a/13_kubernetes_concepts/practice.md b/13_kubernetes_concepts/13.5_practice.md similarity index 100% rename from 13_kubernetes_concepts/practice.md rename to 13_kubernetes_concepts/13.5_practice.md diff --git a/14_kubernetes_setup/kubeadm.md b/14_kubernetes_setup/14.1_kubeadm.md similarity index 100% rename from 14_kubernetes_setup/kubeadm.md rename to 14_kubernetes_setup/14.1_kubeadm.md diff --git a/14_kubernetes_setup/kubeadm-docker.md b/14_kubernetes_setup/14.2_kubeadm-docker.md similarity index 99% rename from 14_kubernetes_setup/kubeadm-docker.md rename to 14_kubernetes_setup/14.2_kubeadm-docker.md index eac64b9..2a6ec65 100644 --- a/14_kubernetes_setup/kubeadm-docker.md +++ b/14_kubernetes_setup/14.2_kubeadm-docker.md @@ -2,7 +2,7 @@ `kubeadm` 提供了 `kubeadm init` 以及 `kubeadm join` 这两个命令，作为快速创建 `Kubernetes` 集群的最佳实践。 -> ⚠️ **重要说明**：自 Kubernetes 1.24 起，内置 `dockershim` 已被移除，Kubernetes 默认不再直接使用 Docker Engine 作为容器运行时 (CRI)。因此，**更推荐参考** 同目录下的《[使用 kubeadm 部署 Kubernetes (CRI 使用 containerd)](kubeadm.md)》。 +> ⚠️ **重要说明**：自 Kubernetes 1.24 起，内置 `dockershim` 已被移除，Kubernetes 默认不再直接使用 Docker Engine 作为容器运行时 (CRI)。因此，**更推荐参考** 同目录下的《[使用 kubeadm 部署 Kubernetes (CRI 使用 containerd)](14.1_kubeadm.md)》。 > > 本文档主要用于历史环境/学习目的：如果你确实需要在较新版本中继续使用 Docker Engine，通常需要额外部署 `cri-dockerd` 并在 `kubeadm init/join` 中指定 `--cri-socket`。 diff --git a/14_kubernetes_setup/docker-desktop.md b/14_kubernetes_setup/14.3_docker-desktop.md similarity index 100% rename from 14_kubernetes_setup/docker-desktop.md rename to 14_kubernetes_setup/14.3_docker-desktop.md diff --git a/14_kubernetes_setup/kind.md b/14_kubernetes_setup/14.4_kind.md similarity index 100% rename from 14_kubernetes_setup/kind.md rename to 14_kubernetes_setup/14.4_kind.md diff --git a/14_kubernetes_setup/k3s.md b/14_kubernetes_setup/14.5_k3s.md similarity index 100% rename from 14_kubernetes_setup/k3s.md rename to 14_kubernetes_setup/14.5_k3s.md diff --git a/14_kubernetes_setup/systemd.md b/14_kubernetes_setup/14.6_systemd.md similarity index 100% rename from 14_kubernetes_setup/systemd.md rename to 14_kubernetes_setup/14.6_systemd.md diff --git a/14_kubernetes_setup/dashboard.md b/14_kubernetes_setup/14.7_dashboard.md similarity index 100% rename from 14_kubernetes_setup/dashboard.md rename to 14_kubernetes_setup/14.7_dashboard.md diff --git a/14_kubernetes_setup/kubectl.md b/14_kubernetes_setup/14.8_kubectl.md similarity index 100% rename from 14_kubernetes_setup/kubectl.md rename to 14_kubernetes_setup/14.8_kubectl.md diff --git a/14_kubernetes_setup/summary.md b/14_kubernetes_setup/summary.md index 2535198..0c9d8d1 100644 --- a/14_kubernetes_setup/summary.md +++ b/14_kubernetes_setup/summary.md @@ -13,5 +13,5 @@ ### 14.9.1 延伸阅读 - [容器编排基础](../13_kubernetes_concepts/README.md)：Kubernetes 核心概念 -- [Dashboard](dashboard.md)：部署可视化管理界面 -- [kubectl](kubectl.md)：命令行工具使用指南 +- [Dashboard](14.7_dashboard.md)：部署可视化管理界面 +- [kubectl](14.8_kubectl.md)：命令行工具使用指南 diff --git a/15_etcd/intro.md b/15_etcd/15.1_intro.md similarity index 100% rename from 15_etcd/intro.md rename to 15_etcd/15.1_intro.md diff --git a/15_etcd/install.md b/15_etcd/15.2_install.md similarity index 100% rename from 15_etcd/install.md rename to 15_etcd/15.2_install.md diff --git a/15_etcd/cluster.md b/15_etcd/15.3_cluster.md similarity index 100% rename from 15_etcd/cluster.md rename to 15_etcd/15.3_cluster.md diff --git a/15_etcd/etcdctl.md b/15_etcd/15.4_etcdctl.md similarity index 100% rename from 15_etcd/etcdctl.md rename to 15_etcd/15.4_etcdctl.md diff --git a/16_cloud/intro.md b/16_cloud/16.1_intro.md similarity index 100% rename from 16_cloud/intro.md rename to 16_cloud/16.1_intro.md diff --git a/16_cloud/tencentCloud.md b/16_cloud/16.2_tencentCloud.md similarity index 100% rename from 16_cloud/tencentCloud.md rename to 16_cloud/16.2_tencentCloud.md diff --git a/16_cloud/alicloud.md b/16_cloud/16.3_alicloud.md similarity index 100% rename from 16_cloud/alicloud.md rename to 16_cloud/16.3_alicloud.md diff --git a/16_cloud/aws.md b/16_cloud/16.4_aws.md similarity index 100% rename from 16_cloud/aws.md rename to 16_cloud/16.4_aws.md diff --git a/16_cloud/multicloud.md b/16_cloud/16.6_multicloud.md similarity index 100% rename from 16_cloud/multicloud.md rename to 16_cloud/16.6_multicloud.md diff --git a/17_ecosystem/coreos_intro.md b/17_ecosystem/17.1_coreos_intro.md similarity index 100% rename from 17_ecosystem/coreos_intro.md rename to 17_ecosystem/17.1_coreos_intro.md diff --git a/17_ecosystem/coreos_install.md b/17_ecosystem/17.2_coreos_install.md similarity index 100% rename from 17_ecosystem/coreos_install.md rename to 17_ecosystem/17.2_coreos_install.md diff --git a/17_ecosystem/podman.md b/17_ecosystem/17.3_podman.md similarity index 100% rename from 17_ecosystem/podman.md rename to 17_ecosystem/17.3_podman.md diff --git a/18_security/kernel_ns.md b/18_security/18.1_kernel_ns.md similarity index 100% rename from 18_security/kernel_ns.md rename to 18_security/18.1_kernel_ns.md diff --git a/18_security/control_group.md b/18_security/18.2_control_group.md similarity index 100% rename from 18_security/control_group.md rename to 18_security/18.2_control_group.md diff --git a/18_security/daemon_sec.md b/18_security/18.3_daemon_sec.md similarity index 100% rename from 18_security/daemon_sec.md rename to 18_security/18.3_daemon_sec.md diff --git a/18_security/kernel_capability.md b/18_security/18.4_kernel_capability.md similarity index 100% rename from 18_security/kernel_capability.md rename to 18_security/18.4_kernel_capability.md diff --git a/18_security/other_feature.md b/18_security/18.5_other_feature.md similarity index 100% rename from 18_security/other_feature.md rename to 18_security/18.5_other_feature.md diff --git a/19_observability/19.1_prometheus.md b/19_observability/19.1_prometheus.md new file mode 100644 index 0000000..115032f --- /dev/null +++ b/19_observability/19.1_prometheus.md @@ -0,0 +1,268 @@ +## 19.1 Prometheus + Grafana + +Prometheus 和 Grafana 是目前最流行的开源监控组合，前者负责数据采集与存储，后者负责数据可视化。 + +[Prometheus](https://prometheus.io/) 是一个开源的系统监控和报警工具包。它受 Google Borgmon 的启发，由 SoundCloud 在 2012 年创建。 + +### 19.1.1 架构简介 + +Prometheus 的主要组件包括： + +* **Prometheus Server**：核心组件，负责收集和存储时间序列数据。 +* **Exporters**：负责向 Prometheus 暴露监控数据 (如 Node Exporter，cAdvisor)。 +* **Alertmanager**：处理报警发送。 +* **Pushgateway**：用于支持短生命周期的 Job 推送数据。 + +### 19.1.2 快速部署 + +我们可以使用 Docker Compose 快速部署一套 Prometheus + Grafana 监控环境。 + +本节示例使用了： + +* `node-exporter`：采集宿主机指标 (CPU、内存、磁盘、网络等)。 +* `cAdvisor`：采集容器指标 (容器 CPU/内存/网络 IO、文件系统等)。 + +在生产环境中，建议将 Prometheus 的数据目录做持久化，并显式配置数据保留周期。 + +#### 1. 准备配置文件 + +创建 `prometheus.yml`： + +```yaml +global: + scrape_interval: 15s + +scrape_configs: + - job_name: 'prometheus' + static_configs: + - targets: ['localhost:9090'] + + - job_name: 'node-exporter' + static_configs: + - targets: ['node-exporter:9100'] + + - job_name: 'cadvisor' + static_configs: + - targets: ['cadvisor:8080'] + +rule_files: + - /etc/prometheus/rules.yml +``` + +#### 2. 编写 Docker Compose 文件 + +创建 `compose.yaml` (或 `docker-compose.yml`)： + +```yaml +services: + prometheus: + image: prom/prometheus:latest + volumes: + - ./prometheus.yml:/etc/prometheus/prometheus.yml + - ./rules.yml:/etc/prometheus/rules.yml + - prometheus_data:/prometheus + ports: + - "9090:9090" + command: + - --config.file=/etc/prometheus/prometheus.yml + - --storage.tsdb.path=/prometheus + - --storage.tsdb.retention.time=15d + networks: + - monitoring + + grafana: + image: grafana/grafana:latest + ports: + - "3000:3000" + environment: + - GF_SECURITY_ADMIN_PASSWORD=admin + networks: + - monitoring + depends_on: + - prometheus + + node-exporter: + image: prom/node-exporter:latest + ports: + - "9100:9100" + networks: + - monitoring + + cadvisor: + image: gcr.io/cadvisor/cadvisor:latest + ports: + - "8080:8080" + volumes: + - /:/rootfs:ro + - /var/run:/var/run:ro + - /sys:/sys:ro + - /var/lib/docker/:/var/lib/docker:ro + networks: + - monitoring + +networks: + monitoring: + +volumes: + prometheus_data: +``` + +#### 3. 启动服务 + +运行以下命令： + +```bash +$ docker compose up -d +``` + +启动后，访问以下地址： + +* Prometheus: `http://localhost:9090` +* Grafana：`http://localhost:3000` (默认账号密码：admin/admin) + +### 19.1.3 配置 Grafana 面板 + +1. 在 Grafana 中添加 Prometheus 数据源，URL 填写 `http://prometheus:9090`。 +2. 导入现成的 Dashboard 模板，例如 [Node Exporter Full](https://grafana.com/grafana/dashboards/1860) (ID：1860) 和 [Docker Container](https://grafana.com/grafana/dashboards/193) (ID：193)。 + +这样，你就拥有了一个直观的容器监控大屏。 + +### 19.1.4 生产要点与告警闭环 + +完成部署后，建议补齐以下生产要点。 + +#### 指标采集的“最小闭环” + +1. 在 Prometheus 页面打开 **Status -> Targets**，确认 `prometheus`、`node-exporter`、`cadvisor` 的 `State` 均为 `UP`。 +2. 在 **Graph** 中尝试查询： + + * `up` + * `rate(container_cpu_usage_seconds_total[5m])` + +3. 在 Grafana Dashboard 中重点关注： + + * 宿主机 CPU/Load/内存/磁盘 + * 容器 CPU/内存使用率、容器重启次数 + +如果你发现“面板为空”，通常不是 Grafana 的问题，而是 Prometheus 没抓到数据或查询标签与 Dashboard 不匹配。 + +#### 常见问题排查 + +* **Target down**：检查容器网络是否互通，端口是否暴露到同一网络，以及 exporter 是否在容器内正常监听。 +* **cAdvisor 无数据或报错**：确认挂载了 Docker 目录与宿主机的 `/sys`、`/var/run` 等路径，并确保宿主机上 Docker 运行正常。 +* **指标缺失**：确认你的 Docker/内核版本与 cAdvisor 兼容；对于 containerd 等运行时，采集方式会不同。 + +#### 关键指标速查 (节点/容器) + +在生产环境排障时，建议优先关注下面几类指标，并在 Grafana 面板中建立对应的常用视图。 + +* **节点 CPU 使用率**：`100 - (avg by (instance) (rate(node_cpu_seconds_total{mode="idle"}[5m])) * 100)` +* **节点内存使用率**：`(1 - (node_memory_MemAvailable_bytes / node_memory_MemTotal_bytes)) * 100` +* **节点磁盘空间使用率**：`(1 - (node_filesystem_avail_bytes{fstype!~"tmpfs|overlay"} / node_filesystem_size_bytes{fstype!~"tmpfs|overlay"})) * 100` +* **容器 CPU**：`sum by (name) (rate(container_cpu_usage_seconds_total[5m]))` +* **容器内存**：`sum by (name) (container_memory_working_set_bytes)` + +说明：不同版本的 cAdvisor/Docker 对 label 命名可能存在差异 (如 `name`、`container`、`container_name`)，如果查询为空，建议先用 `label_values(container_cpu_usage_seconds_total, __name__)` 或在 Prometheus 的图形界面查看可用 label。 + +#### Targets down 排错清单 + +当 **Status -> Targets** 出现 `DOWN` 时，建议按以下顺序排查： + +1. **网络连通性**：Prometheus 容器是否能解析并访问目标 (同一 Docker network、DNS、端口)。 +2. **端口/路径**：确认 exporter 监听端口与 Prometheus 配置一致；必要时在 Prometheus 容器内 `curl http://node-exporter:9100/metrics`。 +3. **权限/挂载**：cAdvisor 需要访问宿主机 `/sys`、`/var/lib/docker` 等挂载路径，缺失会导致指标不全或报错。 +4. **时间问题**：宿主机与容器时间偏差过大可能导致“数据看起来断档”，需要检查 NTP/时区配置。 +5. **目标本身异常**：确认 exporter 容器是否在重启，查看 `docker logs`。 + +#### 告警 (Alertmanager) 建议 + +生产环境建议引入 Alertmanager 做告警聚合与路由，并在 Prometheus 中配置 `alerting` 与 `rule_files`。 + +为了保持“最小告警闭环”，建议至少覆盖两类告警： + +* **采集链路告警**：例如 `up == 0`，用于发现 exporter 或网络故障。 +* **资源风险告警**：例如节点磁盘空间不足，用于提前发现容量风险。 + +##### 1. 准备告警规则文件 + +创建 `rules.yml`： + +```yaml +groups: + - name: docker_practice + rules: + - alert: PrometheusTargetDown + expr: up == 0 + for: 2m + labels: + severity: warning + annotations: + summary: "Prometheus 抓取目标不可达" + description: "Job={{ $labels.job }}, Instance={{ $labels.instance }}" + + - alert: HostDiskSpaceLow + expr: | + (node_filesystem_avail_bytes{fstype!~"tmpfs|overlay"} / node_filesystem_size_bytes{fstype!~"tmpfs|overlay"}) < 0.10 + for: 10m + labels: + severity: critical + annotations: + summary: "磁盘可用空间不足" + description: "Instance={{ $labels.instance }}, Mountpoint={{ $labels.mountpoint }}" +``` + +说明：这里的规则是“可用空间低于 10%”的阈值告警，并非“未来 24 小时写满”的预测。生产环境建议针对特定文件系统与挂载点做更精确的过滤。 + +##### 2. 配置 Prometheus 加载规则并接入 Alertmanager + +修改 `prometheus.yml`，增加： + +```yaml +rule_files: + - /etc/prometheus/rules.yml + +alerting: + alertmanagers: + - static_configs: + - targets: ["alertmanager:9093"] +``` + +并在 Compose 中挂载规则文件。 + +##### 3. 部署 Alertmanager + +创建 `alertmanager.yml`： + +```yaml +route: + receiver: default + +receivers: + - name: default + webhook_configs: + - url: http://example.com/webhook +``` + +再在 `compose.yaml` 增加服务： + +```yaml + alertmanager: + image: prom/alertmanager:latest + volumes: + - ./alertmanager.yml:/etc/alertmanager/alertmanager.yml + ports: + - "9093:9093" + networks: + - monitoring +``` + +生产环境中，建议将告警发送到可追踪的渠道 (如 IM 机器人、事件平台、工单系统)，并在告警中附带 Dashboard 链接与排障入口，避免告警成为噪声。 + +#### 建议的文件清单 + +为了避免示例难以复现，建议在同一目录下准备以下文件： + +* `compose.yaml`：Prometheus、Grafana、exporters、Alertmanager 的部署文件 +* `prometheus.yml`：Prometheus 抓取配置与告警配置 +* `rules.yml`：告警规则 +* `alertmanager.yml`：告警路由与接收器配置 diff --git a/19_observability/19.2_elk.md b/19_observability/19.2_elk.md new file mode 100644 index 0000000..7cba300 --- /dev/null +++ b/19_observability/19.2_elk.md @@ -0,0 +1,212 @@ +## 19.2 ELK/EFK 堆栈 + +ELK (Elasticsearch，Logstash，Kibana) 是目前业界最流行的开源日志解决方案。而在容器领域，由于 Fluentd 更加轻量级且对容器支持更好，EFK (Elasticsearch，Fluentd，Kibana) 组合也变得非常流行。 + +### 19.2.1 方案架构 + +我们将采用以下架构： + +1. **Docker Container**：容器将日志输出到标准输出 (stdout/stderr)。 +2. **Fluentd**：作为 Docker 的 Logging Driver 或运行为守护容器，收集容器日志。 +3. **Elasticsearch**：存储从 Fluentd 接收到的日志数据。 +4. **Kibana**：从 Elasticsearch 读取数据并进行可视化展示。 + +### 19.2.2 部署流程 + +我们将使用 Docker Compose 来一键部署整个日志堆栈。 + +#### 1. 编写 Compose 文件 + +1. 编写 `compose.yaml` (或 `docker-compose.yml`) 配置如下： + +```yaml +services: + elasticsearch: + image: docker.elastic.co/elasticsearch/elasticsearch:7.17.0 + container_name: elasticsearch + environment: + - "discovery.type=single-node" + - "ES_JAVA_OPTS=-Xms512m -Xmx512m" + ports: + - "9200:9200" + volumes: + - es_data:/usr/share/elasticsearch/data + networks: + - logging + + kibana: + image: docker.elastic.co/kibana/kibana:7.17.0 + container_name: kibana + environment: + - ELASTICSEARCH_HOSTS=http://elasticsearch:9200 + ports: + - "5601:5601" + links: + - elasticsearch + networks: + - logging + + fluentd: + image: fluent/fluentd-kubernetes-daemonset:v1.14.3-debian-elasticsearch7-1.0 + container_name: fluentd + environment: + - "FLUENT_ELASTICSEARCH_HOST=elasticsearch" + - "FLUENT_ELASTICSEARCH_PORT=9200" + - "FLUENT_ELASTICSEARCH_SCHEME=http" + - "FLUENT_UID=0" + ports: + - "24224:24224" + - "24224:24224/udp" + links: + - elasticsearch + volumes: + - ./fluentd/conf:/fluentd/etc + networks: + - logging + +volumes: + es_data: + +networks: + logging: +``` + +#### 2. 配置 Fluentd + +创建 `fluentd/conf/fluent.conf`： + +```ini + + @type forward + port 24224 + bind 0.0.0.0 + + + + @type copy + + @type elasticsearch + host elasticsearch + port 9200 + logstash_format true + logstash_prefix docker + logstash_dateformat %Y%m%d + include_tag_key true + type_name access_log + tag_key @log_name + flush_interval 1s + + + @type stdout + + +``` + +#### 3. 配置应用容器使用 fluentd 驱动 + +启动一个测试容器，指定日志驱动为 `fluentd`： + +```bash +docker run -d \ + --log-driver=fluentd \ + --log-opt fluentd-address=localhost:24224 \ + --log-opt tag=nginx-test \ + --name nginx-test \ + nginx +``` + +**注意**：确保 `fluentd` 容器已经启动并监听在 `localhost:24224`。在生产环境中，如果你是在不同机器上，需要将 `localhost` 替换为运行 fluentd 的主机 IP。 + +#### 4. 在 Kibana 中查看日志 + +1. 访问 `http://localhost:5601`。 +2. 进入 **Management**->**Kibana**->**Index Patterns**。 +3. 创建新的 Index Pattern，输入 `docker-*` (我们在 fluent.conf 中配置的前缀)。 +4. 选择 `@timestamp` 作为时间字段。 +5. 去 **Discover** 页面，你就能看到 Nginx 容器的日志了。 + +#### Kibana 建索引模式常见坑 + +首次接入 EFK/ELK 时，“Elasticsearch 有数据但 Kibana 看不到”很常见，通常是 Kibana 配置或时间窗口问题： + +* **Index Pattern 不匹配**：确认 Kibana 的 Index Pattern 与实际索引前缀一致。可以先用 `_cat/indices` 查看真实索引名。 +* **时间字段选择错误**：若索引里包含 `@timestamp`，一般选择它；如果选择了错误的字段，会导致 Discover 无法按时间筛选。 +* **时间窗口/时区**：Discover 右上角的时间范围默认可能是最近 15 分钟，且时区可能影响显示。建议先把范围扩大到最近 24 小时再验证。 +* **数据解析失败**：若日志是非结构化文本，仍可入库但字段不可用；生产环境建议输出 JSON 并在采集端解析。 + +#### 5. 验证日志是否写入 Elasticsearch (生产排错必备) + +当你在 Kibana 看不到日志时，建议先跳过 UI，从存储端直接验证“日志是否入库”。 + +1. 查看索引是否创建： + + ```bash + curl -s http://localhost:9200/_cat/indices?v + ``` + + 如果 Fluentd 使用了 `logstash_format true` 且 `logstash_prefix docker`，通常会看到形如 `docker-YYYY.MM.DD` 的索引。 + +2. 查看最近一段时间的日志文档： + + ```bash + curl -s -H 'Content-Type: application/json' \ + http://localhost:9200/docker-*/_search \ + -d '{"size":1,"sort":[{"@timestamp":"desc"}]}' + ``` + +如果 Elasticsearch 中已经有文档，但 Kibana 仍然为空，常见原因是： + +* Index Pattern 没匹配到索引 (例如写成了 `docker-*` 但实际索引前缀不同)。 +* 时间字段没选对或时区不一致，导致 Discover 时间窗口内看不到数据。 + +### 19.2.3 总结 + +通过 Docker 的日志驱动机制，结合 ELK/EFK 强大的收集和分析能力，我们可以轻松构建一个能够处理海量日志的监控平台，这对于排查生产问题至关重要。 + +### 19.2.4 生产要点 + +在生产环境中，日志系统往往比监控系统更容易因为“容量与写入压力”出问题，建议特别关注： + +* **容量规划**：日志增长速度与磁盘占用直接相关。建议设置日志保留周期与索引生命周期策略 (ILM)，避免 Elasticsearch 因磁盘水位触发只读或不可用。 +* **资源配置**：Elasticsearch 对 JVM Heap 较敏感。除示例中的 `ES_JAVA_OPTS` 外，生产环境需要结合节点内存、分片规模、查询压力做评估。 +* **链路可靠性**：采集端到存储端要考虑网络抖动、背压与重试策略；当 Elasticsearch 写入变慢时，采集端的缓冲与落盘策略决定了是否会丢日志。 +* **日志格式**：推荐应用输出结构化日志 (JSON) 并包含关键字段 (如 `trace_id`、`request_id`、`service`、`env`)，以便快速过滤与关联分析。 + +#### 索引与保留策略的落地建议 + +无论是 EFK 还是 ELK，生产上都需要回答两个问题： + +* 日志保留多久？ +* 保留期内的日志如何保证可查询、不过度占用存储？ + +建议按环境与业务重要性对日志分层，并制定不同的保留周期，例如： + +* **生产环境**：7～30 天 +* **测试环境**：1～7 天 + +实现方式通常有两类： + +* **按天滚动索引**：如 `docker-YYYY.MM.DD`，再定期删除过期索引。 +* **使用 ILM**：定义 Hot/Warm/Cold/删除阶段，按时间与容量自动滚动与回收。 + +对于中小规模集群，先把“按天滚动 + 过期删除”做扎实，往往就能解决 80% 的容量问题；当日志量上来、查询压力变大后，再逐步引入 ILM、分层存储与更精细的分片规划。 + +#### 最小可用的“过期索引清理”示例 + +如果你采用按天滚动索引 (例如 `docker-YYYY.MM.DD`)，可以通过 Elasticsearch API 定期清理过期索引。 + +下面示例仅用于演示思路：获取所有 `docker-` 前缀索引并删除指定索引。生产环境建议基于日期计算、灰度验证与权限控制后再执行自动化清理。 + +1. 列出索引： + + ```bash + curl -s http://localhost:9200/_cat/indices/docker-*?v + ``` + +2. 删除某个过期索引 (示例)： + + ```bash + curl -X DELETE http://localhost:9200/docker-2026.02.01 + ``` + +如果你希望更自动化的治理能力，可以进一步使用 ILM 为索引配置滚动与删除策略。 diff --git a/19_observability/README.md b/19_observability/README.md index 2a4eb91..208d2b5 100644 --- a/19_observability/README.md +++ b/19_observability/README.md @@ -1,8 +1,17 @@ # 第十九章 容器监控与日志 -在生产环境中，容器化应用部署完成后，实时掌握容器集群的状态以及应用日志非常重要。本章将介绍针对 Docker 容器和 Kubernetes 集群的监控与日志管理方案。 +在生产环境中，容器化应用部署完成后，实时掌握容器的运行状态以及应用日志非常重要。本章将以 Docker/Compose 的场景为主，介绍容器监控与日志管理的落地思路与最小实践闭环。 + +对于 Kubernetes 场景，可观测性链路与组件选择通常会有所不同 (例如使用 Prometheus Operator、日志采集 DaemonSet 等)。本章会在关键点给出迁移提示，但不会展开为完整的 Kubernetes 教程。 我们将重点探讨以下内容： - **容器监控**：以 Prometheus 为主，讲解如何采集和展示容器性能指标。 - **日志管理**：以 ELK (Elasticsearch, Logstash, Kibana) 套件为例，介绍集中式日志收集平台。 + +为了让读者能够在生产环境中真正用起来，本章会补齐以下“最小闭环”： + +* 关键指标与日志的验证方法 +* 常见故障排查路径 +* 最小告警闭环 (Prometheus -> Alertmanager -> 接收端) +* 日志容量治理的最小实践 diff --git a/19_observability/elk.md b/19_observability/elk.md deleted file mode 100644 index e738ee8..0000000 --- a/19_observability/elk.md +++ /dev/null @@ -1,130 +0,0 @@ -## 19.2 ELK/EFK 堆栈 - -ELK (Elasticsearch，Logstash，Kibana) 是目前业界最流行的开源日志解决方案。而在容器领域，由于 Fluentd 更加轻量级且对容器支持更好，EFK (Elasticsearch，Fluentd，Kibana) 组合也变得非常流行。 - -### 19.2.1 方案架构 - -我们将采用以下架构： - -1. **Docker Container**：容器将日志输出到标准输出 (stdout/stderr)。 -2. **Fluentd**：作为 Docker 的 Logging Driver 或运行为守护容器，收集容器日志。 -3. **Elasticsearch**：存储从 Fluentd 接收到的日志数据。 -4. **Kibana**：从 Elasticsearch 读取数据并进行可视化展示。 - -### 19.2.2 部署流程 - -我们将使用 Docker Compose 来一键部署整个日志堆栈。 - -#### 1. 编写 Compose 文件 - -1. 编写 `compose.yaml` (或 `docker-compose.yml`) 配置如下： - -```yaml -services: - elasticsearch: - image: docker.elastic.co/elasticsearch/elasticsearch:7.17.0 - container_name: elasticsearch - environment: - - "discovery.type=single-node" - - "ES_JAVA_OPTS=-Xms512m -Xmx512m" - ports: - - "9200:9200" - volumes: - - es_data:/usr/share/elasticsearch/data - networks: - - logging - - kibana: - image: docker.elastic.co/kibana/kibana:7.17.0 - container_name: kibana - environment: - - ELASTICSEARCH_HOSTS=http://elasticsearch:9200 - ports: - - "5601:5601" - links: - - elasticsearch - networks: - - logging - - fluentd: - image: fluent/fluentd-kubernetes-daemonset:v1.14.3-debian-elasticsearch7-1.0 - container_name: fluentd - environment: - - "FLUENT_ELASTICSEARCH_HOST=elasticsearch" - - "FLUENT_ELASTICSEARCH_PORT=9200" - - "FLUENT_ELASTICSEARCH_SCHEME=http" - - "FLUENT_UID=0" - ports: - - "24224:24224" - - "24224:24224/udp" - links: - - elasticsearch - volumes: - - ./fluentd/conf:/fluentd/etc - networks: - - logging - -volumes: - es_data: - -networks: - logging: -``` - -#### 2. 配置 Fluentd - -创建 `fluentd/conf/fluent.conf`： - -```ini - - @type forward - port 24224 - bind 0.0.0.0 - - - - @type copy - - @type elasticsearch - host elasticsearch - port 9200 - logstash_format true - logstash_prefix docker - logstash_dateformat %Y%m%d - include_tag_key true - type_name access_log - tag_key @log_name - flush_interval 1s - - - @type stdout - - -``` - -#### 3. 配置应用容器使用 fluentd 驱动 - -启动一个测试容器，指定日志驱动为 `fluentd`： - -```bash -docker run -d \ - --log-driver=fluentd \ - --log-opt fluentd-address=localhost:24224 \ - --log-opt tag=nginx-test \ - --name nginx-test \ - nginx -``` - -**注意**：确保 `fluentd` 容器已经启动并监听在 `localhost:24224`。在生产环境中，如果你是在不同机器上，需要将 `localhost` 替换为运行 fluentd 的主机 IP。 - -#### 4. 在 Kibana 中查看日志 - -1. 访问 `http://localhost:5601`。 -2. 进入 **Management**->**Kibana**->**Index Patterns**。 -3. 创建新的 Index Pattern，输入 `docker-*` (我们在 fluent.conf 中配置的前缀)。 -4. 选择 `@timestamp` 作为时间字段。 -5. 去 **Discover** 页面，你就能看到 Nginx 容器的日志了。 - -### 19.2.3 总结 - -通过 Docker 的日志驱动机制，结合 ELK/EFK 强大的收集和分析能力，我们可以轻松构建一个能够处理海量日志的监控平台，这对于排查生产问题至关重要。 diff --git a/19_observability/prometheus.md b/19_observability/prometheus.md deleted file mode 100644 index 045d6bf..0000000 --- a/19_observability/prometheus.md +++ /dev/null @@ -1,109 +0,0 @@ -## 19.1 Prometheus + Grafana - -Prometheus 和 Grafana 是目前最流行的开源监控组合，前者负责数据采集与存储，后者负责数据可视化。 - -[Prometheus](https://prometheus.io/) 是一个开源的系统监控和报警工具包。它受 Google Borgmon 的启发，由 SoundCloud 在 2012 年创建。 - -### 19.1.1 架构简介 - -Prometheus 的主要组件包括： - -* **Prometheus Server**：核心组件，负责收集和存储时间序列数据。 -* **Exporters**：负责向 Prometheus 暴露监控数据 (如 Node Exporter，cAdvisor)。 -* **Alertmanager**：处理报警发送。 -* **Pushgateway**：用于支持短生命周期的 Job 推送数据。 - -### 19.1.2 快速部署 - -我们可以使用 Docker Compose 快速部署一套 Prometheus + Grafana 监控环境。 - -#### 1. 准备配置文件 - -创建 `prometheus.yml`： - -```yaml -global: - scrape_interval: 15s - -scrape_configs: - - job_name: 'prometheus' - static_configs: - - targets: ['localhost:9090'] - - - job_name: 'node-exporter' - static_configs: - - targets: ['node-exporter:9100'] - - - job_name: 'cadvisor' - static_configs: - - targets: ['cadvisor:8080'] -``` - -#### 2. 编写 Docker Compose 文件 - -创建 `compose.yaml` (或 `docker-compose.yml`)： - -```yaml -services: - prometheus: - image: prom/prometheus:latest - volumes: - - ./prometheus.yml:/etc/prometheus/prometheus.yml - ports: - - "9090:9090" - networks: - - monitoring - - grafana: - image: grafana/grafana:latest - ports: - - "3000:3000" - environment: - - GF_SECURITY_ADMIN_PASSWORD=admin - networks: - - monitoring - depends_on: - - prometheus - - node-exporter: - image: prom/node-exporter:latest - ports: - - "9100:9100" - networks: - - monitoring - - cadvisor: - image: gcr.io/cadvisor/cadvisor:latest - ports: - - "8080:8080" - volumes: - - /:/rootfs:ro - - /var/run:/var/run:ro - - /sys:/sys:ro - - /var/lib/docker/:/var/lib/docker:ro - networks: - - monitoring - -networks: - monitoring: -``` - -#### 3. 启动服务 - -运行以下命令： - -```bash -$ docker compose up -d -``` - -启动后，访问以下地址： - -* Prometheus: `http://localhost:9090` -* Grafana：`http://localhost:3000` (默认账号密码：admin/admin) - -### 19.1.3 配置 Grafana 面板 - -1. 在 Grafana 中添加 Prometheus 数据源，URL 填写 `http://prometheus:9090`。 -2. 导入现成的 Dashboard 模板，例如 [Node Exporter Full](https://grafana.com/grafana/dashboards/1860) (ID：1860) 和 [Docker Container](https://grafana.com/grafana/dashboards/193) (ID：193)。 - -这样，你就拥有了一个直观的容器监控大屏。 diff --git a/19_observability/summary.md b/19_observability/summary.md index c7ecb39..3415d26 100644 --- a/19_observability/summary.md +++ b/19_observability/summary.md @@ -1,10 +1,15 @@ -# 日志管理 +# 本章小结 -在容器化环境中，日志管理比传统环境更为复杂。容器是短暂的，意味着容器内的日志文件可能会随着容器的销毁而丢失。因此，我们需要一种集中式的日志管理方案来收集、存储和分析容器日志。 +本章从两个维度介绍了容器可观测性： + +* **指标监控**：以 Prometheus + Grafana 为主，完成指标采集、存储与可视化。 +* **日志管理**：以 EFK/ELK 为例，完成容器日志的集中采集、检索与分析。 + +生产环境中，建议将“可观测性”当成一个完整闭环：**采集 -> 存储 -> 展示 -> 告警 -> 排错 -> 容量治理**。 ## 19.3 Docker 日志驱动 -Docker 提供了多种日志驱动 (Log Driver) 机制，允许我们将容器日志转发到不同的后端。 +Docker 提供了多种日志驱动 (Log Driver)，用于将容器标准输出的日志转发到不同后端。 常见的日志驱动包括： @@ -15,12 +20,30 @@ Docker 提供了多种日志驱动 (Log Driver) 机制，允许我们将容器 * `gelf`：支持 GELF 协议的日志后端 (如 Graylog)。 * `awslogs`：发送到 Amazon CloudWatch Logs。 -## 19.3 日志管理方案 +生产建议：无论采用哪种驱动，都要明确日志的保留周期、容量上限与传输可靠性，避免“日志把磁盘写满”或“链路抖动导致丢日志”。 -对于大规模的容器集群，我们通常会采用 EFK (Elasticsearch + Fluentd + Kibana) 或 ELK (Elasticsearch + Logstash + Kibana) 方案。 +## 19.4 日志平台选型对比与注意事项 -* **Elasticsearch**：负责日志的存储和全文检索。 -* **Fluentd/Logstash**：负责日志的采集、过滤和转发。 -* **Kibana**：负责日志的可视化展示。 +日志平台通常由“采集/处理/存储/查询展示”几部分组成。常见选型包括： -本章将介绍如何使用 EFK 方案来处理 Docker 容器日志。 +* **EFK/ELK**：Elasticsearch + Fluentd/Logstash + Kibana，适合全文检索与结构化查询。 +* **Loki + Grafana**：更偏“日志像指标一样存储”的思路，部署与成本可能更友好，但查询能力与使用习惯不同。 + +选型时建议关注： + +* **写入压力与背压**：当存储端变慢时，采集端是否会缓冲、落盘、重试，是否会影响业务。 +* **容量治理**：是否具备按天/按大小滚动、保留策略、生命周期管理 (ILM) 等能力。 +* **安全与合规**：鉴权、TLS、审计、敏感字段脱敏。 +* **可运维性**：升级策略、备份恢复、告警指标是否齐全。 + +## 19.5 上线前检查清单 + +你可以用下面的清单快速检查“是否具备最小生产可用性”： + +* Prometheus 数据目录已持久化，并设置了合理的保留周期。 +* Prometheus Targets 全部为 `UP`，并且关键查询 (CPU/内存/容器指标) 有数据。 +* Grafana 已导入面板并能定位到具体实例/容器；默认账号密码已修改。 +* 至少有一条关键告警已打通 Alertmanager 的接收链路，并验证告警能被正确发送与抑制。 +* Elasticsearch 数据目录已持久化，并有明确的日志保留周期与容量上限策略。 +* Kibana 能查询到最新日志；当 UI 异常时能用 Elasticsearch API 验证入库。 +* 可观测性组件未直接暴露到公网，访问已加鉴权或置于内网。 diff --git a/20_cases_os/busybox.md b/20_cases_os/20.1_busybox.md similarity index 100% rename from 20_cases_os/busybox.md rename to 20_cases_os/20.1_busybox.md diff --git a/20_cases_os/alpine.md b/20_cases_os/20.2_alpine.md similarity index 100% rename from 20_cases_os/alpine.md rename to 20_cases_os/20.2_alpine.md diff --git a/20_cases_os/debian.md b/20_cases_os/20.3_debian.md similarity index 100% rename from 20_cases_os/debian.md rename to 20_cases_os/20.3_debian.md diff --git a/20_cases_os/centos.md b/20_cases_os/20.4_centos.md similarity index 100% rename from 20_cases_os/centos.md rename to 20_cases_os/20.4_centos.md diff --git a/20_cases_os/README.md b/20_cases_os/README.md index ca4c643..229bbd3 100644 --- a/20_cases_os/README.md +++ b/20_cases_os/README.md @@ -2,8 +2,8 @@ 本章将介绍 Docker 在不同操作系统镜像场景下的实战案例。 -* [Busybox](busybox.md) -* [Alpine](alpine.md) -* [Debian Ubuntu](debian.md) -* [CentOS Fedora](centos.md) +* [Busybox](20.1_busybox.md) +* [Alpine](20.2_alpine.md) +* [Debian Ubuntu](20.3_debian.md) +* [CentOS Fedora](20.4_centos.md) * [本章小结](summary.md) diff --git a/21_case_devops/devops_workflow.md b/21_case_devops/21.1_devops_workflow.md similarity index 100% rename from 21_case_devops/devops_workflow.md rename to 21_case_devops/21.1_devops_workflow.md diff --git a/21_case_devops/github_actions.md b/21_case_devops/21.2_github_actions.md similarity index 100% rename from 21_case_devops/github_actions.md rename to 21_case_devops/21.2_github_actions.md diff --git a/21_case_devops/drone.md b/21_case_devops/21.3_drone.md similarity index 100% rename from 21_case_devops/drone.md rename to 21_case_devops/21.3_drone.md diff --git a/21_case_devops/drone_demo.md b/21_case_devops/21.4_drone_demo.md similarity index 100% rename from 21_case_devops/drone_demo.md rename to 21_case_devops/21.4_drone_demo.md diff --git a/21_case_devops/ide.md b/21_case_devops/21.5_ide.md similarity index 100% rename from 21_case_devops/ide.md rename to 21_case_devops/21.5_ide.md diff --git a/21_case_devops/vsCode.md b/21_case_devops/21.6_vsCode.md similarity index 100% rename from 21_case_devops/vsCode.md rename to 21_case_devops/21.6_vsCode.md diff --git a/21_case_devops/README.md b/21_case_devops/README.md index 83098ca..f043357 100644 --- a/21_case_devops/README.md +++ b/21_case_devops/README.md @@ -2,10 +2,10 @@ 本章将介绍 Docker 在 DevOps 场景下的实战案例。 -* [DevOps 完整工作流](devops_workflow.md) -* [GitHub Actions](github_actions.md) -* [Drone](drone.md) -* [Drone Demo](drone_demo.md) -* [在 IDE 中使用 Docker](ide.md) -* [VS Code](vsCode.md) +* [DevOps 完整工作流](21.1_devops_workflow.md) +* [GitHub Actions](21.2_github_actions.md) +* [Drone](21.3_drone.md) +* [Drone Demo](21.4_drone_demo.md) +* [在 IDE 中使用 Docker](21.5_ide.md) +* [VS Code](21.6_vsCode.md) * [本章小结](summary.md) diff --git a/README.md b/README.md index 1cafe18..4a58284 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![图](https://img.shields.io/github/stars/yeasy/docker_practice.svg?style=social&label=Stars)](https://github.com/yeasy/docker_practice) [![图](https://img.shields.io/github/release/yeasy/docker_practice/all.svg)](https://github.com/yeasy/docker_practice/releases) [![图](https://img.shields.io/badge/Based-Docker%20Engine%20v29.x-blue.svg)](https://docs.docker.com/engine/release-notes/) [![图](https://img.shields.io/badge/Docker%20%E6%8A%80%E6%9C%AF%E5%85%A5%E9%97%A8%E4%B8%8E%E5%AE%9E%E6%88%98-jd.com-red.svg)][1] -**v1.5.8** +**v1.5.9** [Docker](https://www.docker.com) 是个划时代的开源项目，它彻底释放了计算虚拟化的威力，极大提高了应用的维护效率，降低了云计算应用开发的成本！使用 Docker，可以让应用的部署、测试和分发都变得前所未有的高效和轻松！ diff --git a/SUMMARY.md b/SUMMARY.md index 2b26c12..1912782 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -75,17 +75,17 @@ * [7.18 实战多阶段构建 Laravel 镜像](07_dockerfile/7.18_multistage_builds_laravel.md) * [本章小结](07_dockerfile/summary.md) * [第八章 数据管理](08_data/README.md) - * [8.1 数据卷](08_data/volume.md) - * [8.2 挂载主机目录](08_data/bind-mounts.md) - * [8.3 tmpfs 挂载](08_data/tmpfs.md) + * [8.1 数据卷](08_data/8.1_volume.md) + * [8.2 挂载主机目录](08_data/8.2_bind-mounts.md) + * [8.3 tmpfs 挂载](08_data/8.3_tmpfs.md) * [本章小结](08_data/summary.md) * [第九章 网络配置](09_network/README.md) - * [9.1 配置 DNS](09_network/dns.md) - * [9.2 网络类型](09_network/network_types.md) - * [9.3 自定义网络](09_network/custom_network.md) - * [9.4 容器互联](09_network/container_linking.md) - * [9.5 外部访问容器](09_network/port_mapping.md) - * [9.6 网络隔离](09_network/network_isolation.md) + * [9.1 配置 DNS](09_network/9.1_dns.md) + * [9.2 网络类型](09_network/9.2_network_types.md) + * [9.3 自定义网络](09_network/9.3_custom_network.md) + * [9.4 容器互联](09_network/9.4_container_linking.md) + * [9.5 外部访问容器](09_network/9.5_port_mapping.md) + * [9.6 网络隔离](09_network/9.6_network_isolation.md) * [本章小结](09_network/summary.md) * [第十章 Docker Buildx](10_buildx/README.md) * [10.1 BuildKit](10_buildx/10.1_buildkit.md) @@ -115,68 +115,67 @@ * [12.6 网络](12_implementation/12.6_network.md) * [本章小结](12_implementation/summary.md) * [第十三章 容器编排基础](13_kubernetes_concepts/README.md) - * [13.1 简介](13_kubernetes_concepts/intro.md) - * [13.2 基本概念](13_kubernetes_concepts/concepts.md) - * [13.3 架构设计](13_kubernetes_concepts/design.md) - * [13.4 高级特性](13_kubernetes_concepts/advanced.md) - * [13.5 实战练习](13_kubernetes_concepts/practice.md) + * [13.1 简介](13_kubernetes_concepts/13.1_intro.md) + * [13.2 基本概念](13_kubernetes_concepts/13.2_concepts.md) + * [13.3 架构设计](13_kubernetes_concepts/13.3_design.md) + * [13.4 高级特性](13_kubernetes_concepts/13.4_advanced.md) + * [13.5 实战练习](13_kubernetes_concepts/13.5_practice.md) * [本章小结](13_kubernetes_concepts/summary.md) * [第十四章 部署 Kubernetes](14_kubernetes_setup/README.md) - * [14.1 使用 kubeadm 部署 Kubernetes (CRI 使用 containerd)](14_kubernetes_setup/kubeadm.md) - * [14.2 使用 kubeadm 部署 Kubernetes (使用 Docker)](14_kubernetes_setup/kubeadm-docker.md) - * [14.3 在 Docker Desktop 使用](14_kubernetes_setup/docker-desktop.md) - * [14.4 Kind - Kubernetes IN Docker](14_kubernetes_setup/kind.md) - * [14.5 K3s - 轻量级 Kubernetes](14_kubernetes_setup/k3s.md) - * [14.6 一步步部署 Kubernetes 集群](14_kubernetes_setup/systemd.md) - * [14.7 部署 Dashboard](14_kubernetes_setup/dashboard.md) - * [14.8 Kubernetes 命令行 kubectl](14_kubernetes_setup/kubectl.md) + * [14.1 使用 kubeadm 部署 Kubernetes (CRI 使用 containerd)](14_kubernetes_setup/14.1_kubeadm.md) + * [14.2 使用 kubeadm 部署 Kubernetes (使用 Docker)](14_kubernetes_setup/14.2_kubeadm-docker.md) + * [14.3 在 Docker Desktop 使用](14_kubernetes_setup/14.3_docker-desktop.md) + * [14.4 Kind - Kubernetes IN Docker](14_kubernetes_setup/14.4_kind.md) + * [14.5 K3s - 轻量级 Kubernetes](14_kubernetes_setup/14.5_k3s.md) + * [14.6 一步步部署 Kubernetes 集群](14_kubernetes_setup/14.6_systemd.md) + * [14.7 部署 Dashboard](14_kubernetes_setup/14.7_dashboard.md) + * [14.8 Kubernetes 命令行 kubectl](14_kubernetes_setup/14.8_kubectl.md) * [本章小结](14_kubernetes_setup/summary.md) * [第十五章 Etcd 项目](15_etcd/README.md) - * [15.1 简介](15_etcd/intro.md) - * [15.2 安装](15_etcd/install.md) - * [15.3 集群](15_etcd/cluster.md) - * [15.4 使用 etcdctl](15_etcd/etcdctl.md) + * [15.1 简介](15_etcd/15.1_intro.md) + * [15.2 安装](15_etcd/15.2_install.md) + * [15.3 集群](15_etcd/15.3_cluster.md) + * [15.4 使用 etcdctl](15_etcd/15.4_etcdctl.md) * [本章小结](15_etcd/summary.md) * [第十六章 容器与云计算](16_cloud/README.md) - * [16.1 简介](16_cloud/intro.md) - * [16.2 腾讯云](16_cloud/tencentCloud.md) - * [16.3 阿里云](16_cloud/alicloud.md) - * [16.4 亚马逊云](16_cloud/aws.md) - * [16.6 多云部署策略](16_cloud/multicloud.md) + * [16.1 简介](16_cloud/16.1_intro.md) + * [16.2 腾讯云](16_cloud/16.2_tencentCloud.md) + * [16.3 阿里云](16_cloud/16.3_alicloud.md) + * [16.4 亚马逊云](16_cloud/16.4_aws.md) + * [16.6 多云部署策略](16_cloud/16.6_multicloud.md) * [本章小结](16_cloud/summary.md) * [第十七章 容器其它生态](17_ecosystem/README.md) - * [17.1 Fedora CoreOS 简介](17_ecosystem/coreos_intro.md) - * [17.2 Fedora CoreOS 安装](17_ecosystem/coreos_install.md) - * [17.3 podman - 下一代 Linux 容器工具](17_ecosystem/podman.md) + * [17.1 Fedora CoreOS 简介](17_ecosystem/17.1_coreos_intro.md) + * [17.2 Fedora CoreOS 安装](17_ecosystem/17.2_coreos_install.md) + * [17.3 podman - 下一代 Linux 容器工具](17_ecosystem/17.3_podman.md) * [本章小结](17_ecosystem/summary.md) ## 第四部分：实战篇 * [第十八章 安全](18_security/README.md) - * [18.1 内核命名空间](18_security/kernel_ns.md) - * [18.2 控制组](18_security/control_group.md) - * [18.3 服务端防护](18_security/daemon_sec.md) - * [18.4 内核能力机制](18_security/kernel_capability.md) - * [18.5 其它安全特性](18_security/other_feature.md) + * [18.1 内核命名空间](18_security/18.1_kernel_ns.md) + * [18.2 控制组](18_security/18.2_control_group.md) + * [18.3 服务端防护](18_security/18.3_daemon_sec.md) + * [18.4 内核能力机制](18_security/18.4_kernel_capability.md) + * [18.5 其它安全特性](18_security/18.5_other_feature.md) * [本章小结](18_security/summary.md) * [第十九章 容器监控与日志](19_observability/README.md) - * [19.1 Prometheus](19_observability/prometheus.md) - * [19.2 ELK 套件](19_observability/elk.md) + * [19.1 Prometheus](19_observability/19.1_prometheus.md) + * [19.2 ELK 套件](19_observability/19.2_elk.md) * [本章小结](19_observability/summary.md) * [第二十章 实战案例 - 操作系统](20_cases_os/README.md) - * [20.1 Busybox](20_cases_os/busybox.md) - * [20.2 Alpine](20_cases_os/alpine.md) - * [20.3 Debian Ubuntu](20_cases_os/debian.md) - * [20.4 CentOS Fedora](20_cases_os/centos.md) + * [20.1 Busybox](20_cases_os/20.1_busybox.md) + * [20.2 Alpine](20_cases_os/20.2_alpine.md) + * [20.3 Debian Ubuntu](20_cases_os/20.3_debian.md) + * [20.4 CentOS Fedora](20_cases_os/20.4_centos.md) * [本章小结](20_cases_os/summary.md) - * [第二十一章 实战案例 - Devops](21_case_devops/README.md) - * [21.1 DevOps 完整工作流](21_case_devops/devops_workflow.md) - * [21.2 GitHub Actions](21_case_devops/github_actions.md) - * [21.3 Drone](21_case_devops/drone.md) - * [21.4 Drone Demo](21_case_devops/drone_demo.md) - * [21.5 在 IDE 中使用 Docker](21_case_devops/ide.md) - * [21.6 VS Code](21_case_devops/vsCode.md) + * [21.1 DevOps 完整工作流](21_case_devops/21.1_devops_workflow.md) + * [21.2 GitHub Actions](21_case_devops/21.2_github_actions.md) + * [21.3 Drone](21_case_devops/21.3_drone.md) + * [21.4 Drone Demo](21_case_devops/21.4_drone_demo.md) + * [21.5 在 IDE 中使用 Docker](21_case_devops/21.5_ide.md) + * [21.6 VS Code](21_case_devops/21.6_vsCode.md) * [本章小结](21_case_devops/summary.md) ## 附录 @@ -184,13 +183,13 @@ * [附录](appendix/README.md) * [附录一：常见问题与错误速查](appendix/faq/README.md) * [附录二：热门镜像介绍](appendix/repo/README.md) - * [Ubuntu](appendix/repo/ubuntu.md) - * [CentOS](appendix/repo/centos.md) + * [Ubuntu](appendix/repo/3.1_ubuntu.md) + * [CentOS](appendix/repo/3.4_centos.md) * [Nginx](appendix/repo/nginx.md) * [PHP](appendix/repo/php.md) * [Node.js](appendix/repo/nodejs.md) * [MySQL](appendix/repo/mysql.md) - * [WordPress](appendix/repo/wordpress.md) + * [WordPress](appendix/repo/11.8_wordpress.md) * [MongoDB](appendix/repo/mongodb.md) * [Redis](appendix/repo/redis.md) * [Minio](appendix/repo/minio.md) diff --git a/appendix/20.1_best_practices.md b/appendix/20.1_best_practices.md index de1e38f..1e23ddb 100644 --- a/appendix/20.1_best_practices.md +++ b/appendix/20.1_best_practices.md @@ -26,7 +26,7 @@ 应该保证在一个容器中只运行一个进程。将多个应用解耦到不同容器中，保证了容器的横向扩展和复用。例如 web 应用应该包含三个容器：web 应用、数据库、缓存。 -如果容器互相依赖，你可以使用 [Docker 自定义网络](../09_network/custom_network.md)来把这些容器连接起来。 +如果容器互相依赖，你可以使用 [Docker 自定义网络](../09_network/9.3_custom_network.md)来把这些容器连接起来。 #### 镜像层数尽可能少 diff --git a/check_dashes.py b/check_dashes.py deleted file mode 100644 index 8f4ddca..0000000 --- a/check_dashes.py +++ /dev/null @@ -1,21 +0,0 @@ -import os -import re - -count = 0 -for root, dirs, files in os.walk("/Users/baohua/Github/books/docker_practice"): - if ".git" in root or "node_modules" in root: - continue - for file in files: - if file.endswith(".md"): - filepath = os.path.join(root, file) - with open(filepath, "r", encoding="utf-8") as f: - lines = f.readlines() - - for i, line in enumerate(lines): - # match optional spaces, then exactly one dash, then no space and no dash - m = re.match(r'^(\s*)-([^- \t\n].*)$', line) - if m: - print(f"{filepath}:{i+1}:{line.rstrip()}") - count += 1 - -print(f"Total found: {count}") diff --git a/checker.py b/checker.py deleted file mode 100644 index b41fd3f..0000000 --- a/checker.py +++ /dev/null @@ -1,109 +0,0 @@ -import os -import re - -def check_file(filepath): - issues = [] - try: - with open(filepath, 'r', encoding='utf-8') as f: - lines = f.readlines() - except Exception as e: - return [f"Could not read file: {e}"] - - in_code_block = False - - for i, line in enumerate(lines): - line_stripped = line.strip() - - # Code block tracking - if line_stripped.startswith('```'): - in_code_block = not in_code_block - - if in_code_block: - continue - - # 1. Full-width parentheses `（` `）` - if '（' in line or '）' in line: - if line_stripped.startswith('#'): - issues.append(f"Line {i+1}: Header contains full-width parentheses '（' or '）'") - else: - issues.append(f"Line {i+1}: Text contains full-width parentheses '（' or '）'") - - # 2. Missing intro text after headers - if line_stripped.startswith('#'): - j = i + 1 - while j < len(lines) and lines[j].strip() == '': - j += 1 - if j < len(lines): - next_line = lines[j].strip() - if next_line.startswith('```'): - issues.append(f"Line {i+1}: Header immediately followed by code block without text") - elif next_line.startswith('|') and len(next_line.split('|')) > 2: - issues.append(f"Line {i+1}: Header immediately followed by table without text") - elif next_line.startswith('#') and next_line.count('#') == line_stripped.count('#') + 1: - issues.append(f"Line {i+1}: Header immediately followed by sub-header (missing text between)") - elif next_line.startswith('!['): - issues.append(f"Line {i+1}: Header immediately followed by image without text") - - # 3. Missing blank line before list item - # Is this line a list item? - is_list_item = re.match(r'^(\s*[-*+]\s|\s*\d+\.\s)', line) - if is_list_item and i > 0: - prev_line = lines[i-1] - prev_line_stripped = prev_line.strip() - - # If prev line is not empty, and not already a list item, header, quote, or HTML comment - if prev_line_stripped and not prev_line_stripped.startswith('#') and not prev_line_stripped.startswith('>'): - if not re.match(r'^(\s*[-*+]\s|\s*\d+\.\s)', prev_line) and not prev_line_stripped.startswith('