CSM (容器存储模块) Operator 镜像文档

镜像概述和主要用途

CSM (Container Storage Modules) Operator是基于Kubernetes Operator模式开发的容器化管理工具，专注于容器环境中存储模块的全生命周期管理。通过自定义资源定义（CRD）和声明式API，该Operator实现存储模块的自动化部署、配置调整、状态监控及故障恢复，降低容器存储运维复杂度，适用于各类Kubernetes集群的存储管理场景。

核心功能和特性

• 声明式管理：通过Kubernetes CRD定义存储模块期望状态，Operator自动协调实际状态与期望状态，减少手动干预
• 自动化部署配置：根据CR规格自动部署存储模块组件（控制器、代理等），并完成初始化配置
• 全生命周期管理：支持存储模块的创建、更新、升级、删除等完整生命周期操作，支持版本平滑过渡
• 实时监控告警：集成存储使用率、性能指标、健康状态等监控能力，支持对接Prometheus，异常状态自动告警
• 故障自愈机制：检测到组件故障时自动执行重启、重建或迁移操作，保障存储服务连续性
• 多后端兼容性：支持主流存储后端（Ceph、NFS、iSCSI等），可扩展支持自定义存储类型

使用场景和适用范围

• Kubernetes集群存储管理：适用于自管理或云托管Kubernetes集群的存储模块部署与运维
• 自动化存储运维：适合需要减少手动操作、实现存储管理自动化的中大型容器集群
• 企业级存储部署：满足企业应用对存储高可用、可扩展性和可管理性的需求
• 混合存储环境：统一管理多类型存储后端，简化复杂存储环境的协调与配置

使用方法和配置说明

前提条件

• Kubernetes集群版本：v1.19+
• 集群已启用RBAC权限控制
• 可访问容器镜像仓库（公网或私有仓库）

部署步骤

1. 拉取镜像

bash
docker pull [镜像仓库地址]/csm-operator:[版本标签]

注：替换[镜像仓库地址]和[版本标签]为实际值（如***仓库或私有仓库地址）

2. 部署CRD

bash
kubectl apply -f [***][项目仓库]/csm-operator/v[版本]/config/crd/bases/csm.example.com_csminstances.yaml

3. 部署Operator

创建部署配置文件csm-operator-deployment.yaml：

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: csm-operator
  namespace: csm-system
spec:
  replicas: 1
  selector:
    matchLabels:
      app: csm-operator
  template:
    metadata:
      labels:
        app: csm-operator
    spec:
      containers:
      - name: csm-operator
        image: [镜像仓库地址]/csm-operator:[版本标签]
        imagePullPolicy: IfNotPresent
        env:
        - name: WATCH_NAMESPACE
          value: ""  # 留空监控所有命名空间，指定具体命名空间如"default"
        - name: POD_NAME
          valueFrom:
            fieldRef:
              fieldPath: metadata.name
        - name: OPERATOR_NAME
          value: "csm-operator"
        - name: LOG_LEVEL
          value: "info"  # 日志级别：debug, info, warn, error

执行部署：

bash
kubectl create namespace csm-system  # 若命名空间不存在
kubectl apply -f csm-operator-deployment.yaml -n csm-system

4. 创建存储模块实例

创建实例配置文件csm-instance-example.yaml：

yaml
apiVersion: csm.example.com/v1alpha1
kind: CSMInstance
metadata:
  name: csm-example
  namespace: default
spec:
  storageBackend: "ceph"  # 存储后端类型：ceph/nfs/iscsi
  replicas: 3  # 存储模块副本数
  resources:
    requests:
      cpu: "1"
      memory: "2Gi"
    limits:
      cpu: "2"
      memory: "4Gi"
  storageClass:
    name: "csm-ceph-sc"  # 生成的StorageClass名称
    provisioner: "csm.example.com/ceph"
  monitoring:
    enabled: true  # 启用监控
    interval: "30s"  # 监控采集间隔

部署实例：

bash
kubectl apply -f csm-instance-example.yaml -n default

配置参数说明

CSMInstance自定义资源主要参数

环境变量配置

验证与监控

验证部署状态

bash
# 检查Operator运行状态
kubectl get pods -n csm-system

# 检查实例状态
kubectl get csminstance csm-example -n default -o yaml

监控指标访问

启用监控后通过端口转发访问指标：

bash
kubectl port-forward -n csm-system pod/[operator-pod-name] 8080:8080

访问 http://localhost:8080/metrics 查看存储模块监控指标（存储使用率、性能指标等）。