fischerman/k8s-btrfs-provisioner

Btrfs PVC子卷供应器镜像

镜像概述

该镜像用于为Kubernetes持久卷声明（PVC）创建btrfs子卷，是hostdir provisioner的适配实现。通过利用btrfs文件系统的子卷特性，为PVC提供轻量级、隔离的持久化存储解决方案，适用于需要btrfs文件系统功能的Kubernetes环境。

核心功能与特性

• btrfs子卷管理：自动为PVC创建和管理btrfs子卷，实现存储隔离
• hostdir provisioner兼容：遵循hostdir provisioner的工作流程和接口规范，易于集成
• 动态供应：支持Kubernetes动态卷供应机制，根据PVC需求自动分配存储
• btrfs特性支持：可利用btrfs的快照、压缩、配额等高级文件系统功能
• 轻量级设计：资源占用低，部署简单，适合边缘计算和资源受限环境

使用场景与适用范围

• Kubernetes持久化存储：为需要持久化数据的Pod提供基于btrfs的存储卷
• btrfs环境适配：在已部署btrfs文件系统的节点上提供PVC支持
• hostdir provisioner扩展：为现有hostdir provisioner环境添加btrfs子卷管理能力
• 存储隔离需求：需要通过子卷实现数据隔离的多租户或多应用场景
• 快照与备份场景：利用btrfs子卷快照功能实现数据快速备份与恢复

使用方法与配置说明

前置条件

• 节点已挂载btrfs文件系统
• Kubernetes集群已启用动态卷供应
• 具备适当的存储权限（访问btrfs卷和存储路径）

配置参数

Docker运行示例

bash
docker run -d \
  --name btrfs-pvc-provisioner \
  --privileged \
  -v /mnt/btrfs:/mnt/btrfs \  # 挂载btrfs父卷
  -v /var/lib/k8s/pvc:/var/lib/k8s/pvc \  # 挂载PVC存储根目录
  -e BTRFS_PARENT_VOLUME=/mnt/btrfs \
  -e STORAGE_PATH=/var/lib/k8s/pvc \
  -e PROVISIONER_NAME=example.com/btrfs-hostdir \
  -e SUBVOLUME_PREFIX="k8s-pvc-" \
  [镜像名称]:[标签]

Kubernetes部署示例

1. 创建StorageClass

yaml
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
  name: btrfs-hostdir
provisioner: example.com/btrfs-hostdir  # 需与PROVISIONER_NAME一致
reclaimPolicy: Delete  # 或Retain
volumeBindingMode: Immediate

2. 部署Provisioner

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: btrfs-hostdir-provisioner
  namespace: kube-system
spec:
  replicas: 1
  selector:
    matchLabels:
      app: btrfs-hostdir-provisioner
  template:
    metadata:
      labels:
        app: btrfs-hostdir-provisioner
    spec:
      containers:
      - name: provisioner
        image: [镜像名称]:[标签]
        env:
        - name: BTRFS_PARENT_VOLUME
          value: /mnt/btrfs
        - name: STORAGE_PATH
          value: /var/lib/k8s/pvc
        - name: PROVISIONER_NAME
          value: example.com/btrfs-hostdir
        volumeMounts:
        - name: btrfs-volume
          mountPath: /mnt/btrfs
        - name: storage-path
          mountPath: /var/lib/k8s/pvc
      volumes:
      - name: btrfs-volume
        hostPath:
          path: /mnt/btrfs
          type: Directory
      - name: storage-path
        hostPath:
          path: /var/lib/k8s/pvc
          type: Directory

3. 创建PVC使用示例

yaml
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: btrfs-example-pvc
spec:
  accessModes:
    - ReadWriteOnce
  storageClassName: btrfs-hostdir
  resources:
    requests:
      storage: 10Gi

工作流程说明

1. 用户创建PVC并指定storageClassName: btrfs-hostdir
2. Kubernetes调用该provisioner处理PVC请求
3. Provisioner在BTRFS_PARENT_VOLUME路径下创建btrfs子卷
4. 将子卷挂载到STORAGE_PATH下的对应目录
5. 创建并绑定PersistentVolume到PVC
6. Pod可通过PVC访问btrfs子卷存储