k8s 官方文档组织结构

90 阅读5分钟

Kubernetes(k8s)官方文档的组织结构逻辑清晰、层次分明,覆盖了从 “入门使用” 到 “深度实践”,再到 “社区贡献” 的全流程需求,以下是对各核心板块的详细解释:

考试专用

日常专用

4. Tasks(任务指南)

实践导向,聚焦 “如何完成具体操作”,以 “步骤化” 的方式讲解各类场景下的实操流程。

  • 典型任务示例:
    • 如何创建 Deployment 并滚动更新应用。
    • 如何通过 Service 实现服务发现与负载均衡。
    • 如何配置持久存储卷(PV/PVC)。
    • 如何设置网络策略限制 Pod 通信。
    • 如何扩展应用(水平扩缩容)。
  • 特点:不深入原理,只讲 “怎么做”,适合解决 “某类具体问题” 时查阅。

1. Available Documentation Versions(可用文档版本)

Kubernetes 版本迭代频繁,官方会同时维护当前版本 + 最近几个历史版本的文档(例如,当前版本是 v1.29,会同时保留 v1.28、v1.27 等版本的文档)。

  • 作用:让用户根据自己实际部署的 K8s 版本,精准查阅对应文档。
  • 补充信息:文档还会说明「版本支持周期」(哪些版本仍受官方支持、支持时长),帮助用户判断版本的维护状态。

2. Getting started(快速入门)

面向K8s 新手,目标是 “快速搭建环境 + 运行第一个应用”,降低入门门槛。

  • 核心内容包括:
    • 「学习环境」:如何用 Minikube 等工具在本地快速搭建单节点 K8s 集群,用于学习和测试。
    • 「生产环境准备」:容器运行时(如 containerd、CRI-O)的选择与配置;用 kubeadm 等工具部署生产级 K8s 集群的步骤。
    • 「基础实践」:如何部署简单应用、初步理解 Pod 等核心对象,以及基础的 Pod 安全标准实施等。

3. Concepts(核心概念)

K8s 的理论核心,回答 “K8s 是什么、核心组件如何工作、对象模型是什么” 等 “知其所以然” 的问题。

  • 覆盖范畴极广,包括但不限于:
    • 组件与架构:控制平面(api-server、etcd、scheduler、controller-manager)和工作节点(kubelet、kube-proxy、容器运行时)的角色与交互。
    • 对象模型:Pod(最小调度单元)、Deployment(无状态应用控制器)、Service(服务发现与负载均衡)等核心对象;以及对象的管理方式、命名规则、标签(Labels)与选择器(Selectors)、命名空间(Namespaces)、注解(Annotations)等元数据机制。
    • 工作负载:Pod 的生命周期、Init 容器、Sidecar 容器;各类控制器(Deployment、StatefulSet、DaemonSet、Job、CronJob 等)的设计意图与使用场景。
    • 网络与服务:Service 的类型(ClusterIP、NodePort、LoadBalancer)、Ingress(对外暴露服务)、网络策略(NetworkPolicy,控制 Pod 间通信)。
    • 存储:卷(Volumes)、持久卷(PersistentVolumes)、存储类(StorageClasses,动态存储供应)。
    • 配置与安全:ConfigMap(配置注入)、Secret(敏感信息管理);探针(Liveness/Readiness/Startup Probe,健康检查);Pod 安全标准、RBAC(基于角色的访问控制)等安全机制。

4. Tasks(任务指南)

实践导向,聚焦 “如何完成具体操作”,以 “步骤化” 的方式讲解各类场景下的实操流程。

  • 典型任务示例:
    • 如何创建 Deployment 并滚动更新应用。
    • 如何通过 Service 实现服务发现与负载均衡。
    • 如何配置持久存储卷(PV/PVC)。
    • 如何设置网络策略限制 Pod 通信。
    • 如何扩展应用(水平扩缩容)。
  • 特点:不深入原理,只讲 “怎么做”,适合解决 “某类具体问题” 时查阅。

5. Tutorials(教程)

比「快速入门」更场景化、深入的实践引导,通常围绕 “完整应用流程” 或 “复杂工作流” 展开。

  • 示例场景:
    • 部署一个多服务的 Web 应用(含前端、后端、数据库),并配置服务间通信与外部访问。
    • 结合 CI/CD 工具(如 Jenkins、GitLab CI)实现 “代码提交 → 镜像构建 → K8s 自动部署” 的流水线。
    • 基于 K8s 实现微服务架构的灰度发布、流量治理。
  • 特点:注重 “全流程连贯性”,帮助用户掌握 K8s 在真实场景中的综合运用。

6. Reference(参考文档)

技术细节的权威依据,提供各类组件、命令、API 的精准参考。

  • 核心内容:
    • Kubernetes API 参考:各版本 API 的结构、字段含义、使用示例(如 Pod、Deployment 的 API 定义)。
    • kubectl 命令行工具:所有子命令(如 kubectl apply、kubectl get、kubectl logs)的参数、用法、示例。
    • 组件配置参考:api-server、kubelet、controller-manager 等核心组件的启动参数、配置文件说明。
    • 指标(Metrics):各组件暴露的监控指标(如 Prometheus 可采集的指标)说明。
    • 工具与组件参考:如 CSI(容器存储接口)、CNI(容器网络接口)等扩展接口的实现与配置参考。

7. Contribute(贡献指南)

面向开源贡献者,讲解如何为 Kubernetes 文档或代码库做贡献。

  • 内容包括:
    • 文档规范:内容指南、风格指南、 diagram( diagrams)设计规范、新文档编写流程。
    • 代码与文档协同:如何生成 API 参考文档、kubectl 命令文档;如何向 Kubernetes 上游代码库提交贡献。
    • 高级贡献:如参与社区会议、代码评审、特性开发等深度协作的方式。

整体逻辑:从 “入门” 到 “精通”,从 “用户” 到 “贡献者”

K8s 官方文档的结构,是一个 ** 从 “新手引导” 到 “理论深化”,再到 “实践落地”“细节参考”,最终到 “社区参与”** 的完整闭环,覆盖了不同阶段用户(从初学者到开源贡献者)的需求,确保用户能 “按阶段、按场景” 高效获取信息。