rook/rook-ceph-cluster

rook-ceph-cluster Helm OCI仓库镜像文档

1. 镜像概述和主要用途

本镜像为基于OCI（Open Container Initiative）标准的Helm仓库镜像，用于存储和分发rook-ceph-cluster Helm Chart。Rook-Ceph是Kubernetes环境中的分布式存储解决方案，该镜像通过OCI规范提供Chart的标准化存储与分发能力，简化Rook-Ceph集群在容器化环境中的部署、升级与版本管理流程。

2. 核心功能和特性

• OCI标准兼容：遵循OCI规范，支持通过Helm及OCI客户端工具（如crane、skopeo）进行Chart的拉取、推送和元数据管理。
• 版本化Chart管理：支持多版本rook-ceph-cluster Chart存储，可按版本号精确检索和使用特定版本的Chart。
• 安全分发机制：集成OCI仓库认证体系（支持用户名密码、Token、TLS加密），确保Chart分发过程的安全性。
• 原生Helm集成：与Helm 3.8+版本无缝兼容，可直接通过helm CLI完成仓库添加、Chart搜索及部署操作。
• 跨平台兼容性：适配主流OCI Registry实现（如Docker Registry、Harbor、AWS ECR、GCP GCR），支持私有/公共仓库环境。

3. 使用场景和适用范围

• Kubernetes集群Rook-Ceph部署：在Kubernetes集群中，通过该OCI仓库快速获取rook-ceph-cluster Chart，实现Rook-Ceph存储集群的标准化部署。
• CI/CD流程集成：在自动化部署流水线中，从OCI仓库拉取指定版本的Chart，实现Rook-Ceph集群的自动化部署与升级。
• 多环境Chart分发：通过统一的OCI仓库向开发、测试、生产等多环境分发Chart，确保各环境使用一致的部署配置。
• 离线环境部署：支持将Chart拉取至本地后推送至私有OCI仓库，满足无互联网访问环境的Rook-Ceph部署需求。

4. 使用方法和配置说明

4.1 前提条件

• Helm 3.8.0及以上版本（需支持OCI仓库功能）。
• Kubernetes集群（版本需与Rook-Ceph兼容，具体参考Rook-Ceph官方兼容性矩阵）。
• OCI仓库访问权限（如为私有仓库，需准备认证凭据）。

4.2 基础操作步骤

4.2.1 添加OCI仓库

通过Helm CLI添加本OCI仓库：

bash
helm repo add --oci https://<oci-registry-url>/rook-ceph-cluster rook-ceph-oci

参数说明：

• <oci-registry-url>：OCI仓库基础URL（如my-registry.example.com/helm-charts）。
• rook-ceph-oci：仓库别名（可自定义，用于后续命令简化引用）。

私有仓库认证：若仓库需认证，添加时需指定凭据：

bash
helm repo add --oci --username <username> --password <password> https://<oci-registry-url>/rook-ceph-cluster rook-ceph-oci

4.2.2 搜索Chart版本

查看仓库中可用的rook-ceph-cluster Chart及版本：

bash
helm search repo rook-ceph-oci/rook-ceph-cluster --versions

输出示例：

NAME                            CHART VERSION   APP VERSION     DESCRIPTION
rook-ceph-oci/rook-ceph-cluster 1.12.0          1.12.0          A Helm chart for Rook Ceph Cluster
rook-ceph-oci/rook-ceph-cluster 1.11.9          1.11.9          A Helm chart for Rook Ceph Cluster

4.2.3 拉取Chart到本地

拉取指定版本的Chart至本地文件系统：

bash
helm pull oci://<oci-registry-url>/rook-ceph-cluster --version 1.12.0

执行后，本地生成rook-ceph-cluster-1.12.0.tgz文件（文件名格式为<chart-name>-<version>.tgz）。

4.2.4 推送Chart到仓库（需写入权限）

若需向仓库推送自定义修改后的rook-ceph-cluster Chart（如修改values.yaml后重新打包）：

bash
# 打包修改后的Chart（若未打包）
helm package ./rook-ceph-cluster --version <custom-version>
# 推送至OCI仓库
helm push rook-ceph-cluster-<custom-version>.tgz oci://<oci-registry-url>/rook-ceph-cluster

4.3 部署Rook-Ceph集群

4.3.1 基于本地Chart部署

bash
# 解压拉取的Chart（如需修改配置）
tar -zxvf rook-ceph-cluster-1.12.0.tgz
# 编辑配置（如存储类、资源限制等）
vi rook-ceph-cluster/values.yaml
# 部署Chart（创建rook-ceph命名空间并部署）
helm install rook-ceph-cluster ./rook-ceph-cluster \
  --namespace rook-ceph \
  --create-namespace

4.3.2 直接从OCI仓库部署

无需本地拉取，直接通过OCI仓库URL部署：

bash
helm install rook-ceph-cluster oci://<oci-registry-url>/rook-ceph-cluster \
  --version 1.12.0 \
  --namespace rook-ceph \
  --create-namespace

自定义配置：通过--set参数或本地values文件覆盖默认配置：

bash
helm install rook-ceph-cluster oci://<oci-registry-url>/rook-ceph-cluster \
  --version 1.12.0 \
  --namespace rook-ceph \
  --create-namespace \
  --set storageClass.name=rook-ceph-block \  # 自定义存储类名称
  --set resources.requests.cpu=1 \            # 设置CPU请求
  --values custom-values.yaml                 # 引用本地自定义配置文件

4.4 配置参数说明

4.4.1 核心配置参数

4.4.2 环境变量配置

4.5 注意事项

• Helm版本要求：必须使用Helm 3.8.0及以上版本，低版本不支持OCI仓库操作。
• 认证优化：私有仓库建议通过helm registry login预配置凭据，避免重复输入：

  bash
  helm registry login <oci-registry-url> --username <username> --password <password>
  

• 兼容性检查：部署前需确认rook-ceph-cluster Chart版本与Kubernetes集群版本的兼容性（参考Rook-Ceph官方文档）。
• 存储配置：根据实际环境调整values.yaml中的存储相关参数（如OSD数量、存储设备路径、副本数），避免资源不足或配置冲突。