kindest/local-path-provisioner

kind local-path-provisioner 镜像文档

1. 镜像概述和主要用途

1.1 基本信息

本镜像由 kind 项目维护团队预构建，托管于 kind.sigs.k8s.io。镜像包含基于 https://github.com/rancher/local-path-provisioner 自定义构建的组件，专为 kind 节点设计，是 kind 集群存储供应的核心依赖。

1.2 主要用途

作为 kind 工具链的一部分，该镜像用于在 kind 创建 Kubernetes 集群时，为集群节点提供本地路径存储供应能力，支持 Pod 对本地存储的动态申请与管理。

2. 核心功能和特性

2.1 核心组件

• 自定义构建的 local-path-provisioner：基于 rancher/local-path-provisioner 源码定制，适配 kind 节点的运行环境与存储需求。

2.2 关键特性

• 专为 kind 优化：针对 kind 集群的本地存储场景（如开发、测试环境）优化存储路径管理与资源分配逻辑。
• 预构建可用性：由 kind 维护团队预先构建并发布，确保与 kind 工具版本兼容。

3. 使用场景和适用范围

3.1 典型场景

• kind 工具创建 Kubernetes 集群时，自动部署为本集群的默认存储供应器（StorageClass）。
• 为 kind 集群中的 Pod 提供本地路径（HostPath）类型的持久化存储支持。

3.2 适用范围

• 环境限制：仅适用于通过 kind 创建的 Kubernetes 集群。
• 用途限制：主要面向开发、测试环境，不建议用于生产环境。

4. 使用方法和配置说明

4.1 常规使用（通过 kind 工具）

该镜像通常由 kind 工具在集群创建过程中自动调用，用户无需手动部署。当执行 kind create cluster 时，kind 会自动拉取并部署本镜像作为集群的存储供应器组件。

4.2 自行构建镜像

若需基于源码自定义构建，可按以下步骤操作：

1. 克隆 kind 项目源码：

   bash
   git clone https://github.com/kubernetes-sigs/kind.git
   cd kind
   

2. 执行构建命令：

   bash
   make -C images/local-path-provisioner quick
   

   构建完成后，镜像将存储在本地 Docker 仓库，可通过 docker images 查看。

4.3 配置说明

该镜像的配置由 kind 工具内部管理，用户无需手动调整。如需自定义存储行为，可通过 kind 集群配置文件（kind-config.yaml）修改 StorageClass 参数，具体参考 kind 官方文档。

5. 源代码与贡献

5.1 源代码位置

镜像构建相关源码位于 kind 项目仓库：
https://github.com/kubernetes-sigs/kind/tree/main/images/local-path-provisioner

5.2 贡献指南

如需参与镜像开发或提交改进，可参考 kind 项目贡献指南：
[***]

6. 参考文档

• kind 官方文档：[***]
• local-path-provisioner 上游项目：https://github.com/rancher/local-path-provisioner