crossplane/stack-rook

Crossplane Stack for Rook 镜像文档

概述

Crossplane Stack for Rook是一个为Crossplane控制平面设计的扩展组件，旨在将Rook存储编排器的功能集成到Crossplane生态中。通过该栈，用户可利用Crossplane的声明式API统一管理Kubernetes集群中的Rook存储资源，实现存储配置的标准化、自动化与生命周期管理，简化分布式存储（如Ceph）在Kubernetes环境中的部署与运维。

核心功能和特性

核心功能

• Rook资源声明式管理：通过Crossplane自定义资源定义（CRD）管理Rook集群、存储类、对象存储、块存储等核心资源。
• 与Crossplane生态集成：无缝对接Crossplane的组合（Composition）、声明（Claim）等机制，支持存储资源的抽象与复用。
• 生命周期自动化：自动处理Rook存储资源的创建、更新、删除流程，确保状态一致性。
• 配置标准化：提供统一的API抽象，屏蔽底层Rook配置细节，降低存储管理复杂度。

主要特性

• Kubernetes原生：基于Kubernetes API设计，支持kubectl等原生工具操作。
• 声明式配置：采用YAML声明式定义存储资源，支持版本控制与审计。
• 多存储后端支持：兼容Rook支持的存储后端（如Ceph、NFS等）。
• 状态监控：通过Crossplane状态字段暴露Rook资源健康状态与运行信息。

使用场景和适用范围

适用场景

• 云原生存储统一管理：在Kubernetes集群中通过Crossplane统一管理计算、网络、存储资源时，集成Rook存储管理。
• 多云/混合云存储编排：在跨集群或多云环境中，通过Crossplane抽象层标准化Rook存储配置，实现一致的存储管理体验。
• 存储即服务（SaaS）：为平台团队提供自助式存储资源申请接口，基于Crossplane Claim实现存储资源的按需分配。
• DevOps与GitOps工作流：将存储配置纳入Git版本控制，通过CI/CD流水线自动化部署与更新。

适用范围

• Kubernetes集群版本：1.21+（需与Rook和Crossplane版本兼容）。
• Crossplane版本：v1.6+。
• Rook版本：v1.8+。
• 支持的存储后端：Ceph（块存储、对象存储、文件存储）、NFS等Rook支持的存储系统。

使用方法和配置说明

前提条件

• Kubernetes集群已部署Crossplane控制平面（v1.6+）。
• 集群已满足Rook部署的基础环境要求（如节点存储、网络等，具体参见Rook官方文档）。
• 具备集群管理员权限（可执行kubectl apply等操作）。

安装步骤

1. 部署Crossplane Stack for Rook CRD
   通过以下命令安装栈的自定义资源定义：

   bash
   kubectl apply -f https://github.com/crossplane-contrib/stack-rook/releases/latest/download/crds.yaml
   

2. 部署Stack控制器
   应用控制器部署YAML，将Stack组件部署到Crossplane命名空间：

   bash
   kubectl apply -f https://github.com/crossplane-contrib/stack-rook/releases/latest/download/controller.yaml
   

3. 验证安装
   检查控制器Pod状态及CRD是否就绪：

   bash
   kubectl get pods -n crossplane-system | grep stack-rook
   kubectl get crds | grep rook.crossplane.io
   

配置示例

示例1：通过Crossplane管理Rook Ceph集群

创建RookCluster自定义资源，声明式定义Rook Ceph集群配置：

yaml
apiVersion: rook.crossplane.io/v1alpha1
kind: RookCluster
metadata:
  name: example-ceph-cluster
spec:
  forProvider:
    # Rook集群配置（与原生Rook Cluster CR配置兼容）
    clusterSpec:
      dataDirHostPath: /var/lib/rook
      mon:
        count: 3
        allowMultiplePerNode: false
      storage:
        useAllNodes: true
        useAllDevices: false
        devices:
          - name: sdb
      network:
        hostNetwork: false
      rbdMirroring:
        workers: 0
  providerConfigRef:
    name: default

应用上述配置：

bash
kubectl apply -f example-rook-cluster.yaml

示例2：创建Rook存储类

通过Crossplane声明Rook Ceph存储类：

yaml
apiVersion: storage.crossplane.io/v1alpha1
kind: StorageClass
metadata:
  name: example-rook-ceph-rbd
spec:
  forProvider:
    provisioner: rook-ceph.rbd.csi.ceph.com
    parameters:
      clusterID: rook-ceph
      pool: replicapool
      imageFormat: "2"
      imageFeatures: layering
      csi.storage.k8s.io/provisioner-secret-name: rook-csi-rbd-provisioner
      csi.storage.k8s.io/provisioner-secret-namespace: rook-ceph
      csi.storage.k8s.io/node-stage-secret-name: rook-csi-rbd-node
      csi.storage.k8s.io/node-stage-secret-namespace: rook-ceph
  reclaimPolicy: Delete

参数说明

RookCluster等自定义资源的核心配置参数与原生Rook CR兼容，主要包括：

• clusterSpec.dataDirHostPath：Rook数据持久化路径。
• clusterSpec.mon.count：Ceph Monitor节点数量。
• clusterSpec.storage：存储设备配置，包括节点选择、设备列表等。
• clusterSpec.network：网络配置（是否启用主机网络等）。

具体参数可参考Rook官方文档及Crossplane Stack for Rook的https://github.com/crossplane-contrib/stack-rook/blob/main/config/crd/bases/rook.crossplane.io_rookclusters.yaml%E3%80%82

注意事项

• 确保Crossplane、Rook及Stack版本兼容性，参考项目Release说明。
• Rook存储后端（如Ceph）的底层依赖（如内核模块、硬件资源）需提前配置。
• 生产环境中建议通过Crossplane ProviderConfig配置认证信息，避免明文敏感数据。