Kubernetes SIG Storage Lib External Provisioner 使用教程

2024-08-15 15:33:01作者：冯爽妲Honey

sig-storage-lib-external-provisioner

这是一个用于编写外部存储提供者的库，让你能够轻松创建动态子目录卷提供者或NFS服务器解决方案。通过实现Provisioner接口并结合提供的控制器，你可以打造自己的Kubernetes存储插件。库中包含了一个监控PersistentVolume和PersistentVolumeClaims的自定义控制器，以及实用工具包，如GID分配器和挂载表读取功能。参与、讨论和支持请查看社区页面，并遵守Kubernetes的代码行为准则。开始你的存储扩展之旅吧！

1. 项目的目录结构及介绍

sig-storage-lib-external-provisioner/
├── controller/
│   ├── controller.go
│   ├── provisioner.go
│   └── ...
├── pkg/
│   ├── apis/
│   │   └── storage/
│   │       └── v1/
│   │           └── storage_class.go
│   └── util/
│       └── util.go
├── vendor/
│   └── ...
├── go.mod
├── go.sum
└── README.md

controller/: 包含控制器的主要逻辑文件，如 controller.go 和 provisioner.go。
pkg/: 包含项目使用的各种包，如 API 定义和工具函数。
vendor/: 依赖包的管理目录。
go.mod 和 go.sum: Go 模块文件，用于管理项目的依赖。
README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件主要位于 controller/ 目录下，其中 controller.go 是主要的启动文件。该文件负责初始化控制器并启动监听 Kubernetes API 的服务。

// controller/controller.go
package controller

import (
    "k8s.io/client-go/kubernetes"
    "k8s.io/client-go/rest"
    "k8s.io/client-go/tools/clientcmd"
    "k8s.io/klog/v2"
    "sigs.k8s.io/sig-storage-lib-external-provisioner/v7/controller"
)

func main() {
    // 初始化 Kubernetes 客户端
    config, err := rest.InClusterConfig()
    if err != nil {
        klog.Fatalf("Failed to create config: %v", err)
    }
    clientset, err := kubernetes.NewForConfig(config)
    if err != nil {
        klog.Fatalf("Failed to create client: %v", err)
    }

    // 初始化控制器
    ctrl := controller.NewProvisionController(clientset, ...)

    // 启动控制器
    ctrl.Run(context.Background())
}

3. 项目的配置文件介绍

项目的配置文件主要涉及 Kubernetes 的 StorageClass 和 PersistentVolumeClaim 对象。以下是一个示例 StorageClass 配置文件：

apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
  name: standard
provisioner: kubernetes.io/no-provisioner
volumeBindingMode: WaitForFirstConsumer

apiVersion: 指定 API 版本。
kind: 指定对象类型为 StorageClass。
metadata: 包含存储类的元数据，如名称。
provisioner: 指定存储类的供应器。
volumeBindingMode: 指定卷绑定模式。

此外，PersistentVolumeClaim 对象的配置文件如下：

apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: my-pvc
spec:
  accessModes:
    - ReadWriteOnce
  resources:
    requests:
      storage: 1Gi
  storageClassName: standard

apiVersion: 指定 API 版本。
kind: 指定对象类型为 PersistentVolumeClaim。
metadata: 包含 PVC 的元数据，如名称。
spec: 指定 PVC 的详细规格，如访问模式、存储请求和存储类名称。

以上是 Kubernetes SIG Storage Lib External Provisioner 项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该项目。

sig-storage-lib-external-provisioner