couchbase/operator-backup

Couchbase Operator Backup 镜像文档

1. 镜像概述与主要用途

couchbase/operator-backup 镜像是 Couchbase Autonomous Operator 的配套组件，用于提供自动化备份与恢复能力。该镜像内置 Couchbase Server 官方备份工具 cbbackupmgr，通过与 Couchbase Autonomous Operator 的原生集成，实现 Kubernetes 环境中 Couchbase 集群的自动化数据备份、恢复及策略管理。

核心用途：
作为 Couchbase Autonomous Operator 的扩展组件，支持通过 Kubernetes 资源定义备份策略，自动执行备份作业，并利用 cbbackupmgr 完成数据的备份与恢复操作。

2. 核心功能与特性

2.1 原生集成 cbbackupmgr

镜像内置 Couchbase Server 企业版备份工具 cbbackupmgr，支持全量/增量备份、数据恢复、备份集管理等核心功能。

2.2 自动化备份策略

通过 Kubernetes 自定义资源 CouchbaseBackup 定义备份策略，包括：

• 备份调度（基于 Cron 表达式的执行周期）
• 备份类型（全量/增量）
• 备份保留策略（如保留份数、过期清理）

2.3 Kubernetes 原生调度

每个 CouchbaseBackup 资源自动创建 1-2 个 Kubernetes CronJob 资源，根据配置的调度规则生成临时备份作业（Job），无需手动干预。

2.4 作业生命周期管理

备份作业内置辅助脚本，自动处理：

• 日志采集与输出
• 备份前/后清理（如临时文件、过期备份）
• 作业状态上报（与 Kubernetes 事件集成）

3. 使用场景与适用范围

3.1 适用场景

• 企业级 Couchbase 集群的自动化数据保护
• 需定期（如每日/每周）执行全量/增量备份的场景
• 需通过声明式配置管理备份策略的 Kubernetes 环境
• 灾难恢复（通过备份数据快速恢复集群状态）

3.2 适用范围

• 仅与 Couchbase Autonomous Operator 企业版 配合使用
• 部署于 Kubernetes 集群（版本需满足 Operator 系统要求）
• 目标为 Couchbase Server 企业版集群（需与 Operator 版本兼容）

4. 使用方法与配置说明

4.1 前置条件

• 已部署 Couchbase Autonomous Operator 企业版（版本需与镜像兼容）
• Kubernetes 集群满足 Operator 系统要求（参考 官方文档）
• 已配置 Couchbase 集群（CouchbaseCluster 资源）并正常运行

4.2 启用自动化备份

4.2.1 配置 CouchbaseCluster 资源

在 CouchbaseCluster 资源的 spec.backup 字段中启用备份，并指定 couchbase/operator-backup 镜像：

yaml
apiVersion: couchbase.com/v2
kind: CouchbaseCluster
metadata:
  name: cb-cluster
spec:
  # ... 其他集群配置 ...
  backup:
    enabled: true  # 启用自动化备份
    image: couchbase/operator-backup:2.6.0  # 指定镜像版本（需与 Operator 版本匹配）
    serviceAccountName: couchbase-backup  # 备份作业使用的 ServiceAccount（需预配置权限）

4.2.2 应用配置

通过 kubectl apply 应用上述配置，Operator 将自动初始化备份环境。

4.3 定义备份策略（CouchbaseBackup 资源）

通过 CouchbaseBackup 资源定义具体备份策略，示例如下：

yaml
apiVersion: couchbase.com/v2
kind: CouchbaseBackup
metadata:
  name: daily-backup
spec:
  cluster: cb-cluster  # 关联的 CouchbaseCluster 名称
  schedule: "0 3 * * *"  # Cron 调度：每日凌晨 3 点执行
  backupRetention: 7  # 保留最近 7 份备份
  type: full  # 备份类型：full（全量）或 incremental（增量）
  repository:
    path: "/backup"  # 备份存储路径（需通过 PersistentVolume 挂载）
    storage:
      persistentVolumeClaim:
        claimName: backup-pvc  # 挂载的 PVC 名称（需预创建）

关键配置说明：

• schedule：Cron 表达式，定义备份执行周期（如 0 3 * * * 表示每日 3 点）
• backupRetention：保留的备份集数量，超过将自动清理过期备份
• type：备份类型，full（全量）或 incremental（增量，基于最近全量备份）
• repository：备份数据存储配置，支持 PersistentVolume、S3 等（需根据存储类型调整）

4.4 查看备份状态

• 查看 CronJob 资源：

  bash
  kubectl get cronjobs -l couchbase.com/backup=daily-backup
  

• 查看当前备份作业：

  bash
  kubectl get jobs -l couchbase.com/backup=daily-backup
  

• 查看作业日志：

  bash
  kubectl logs <backup-job-pod-name>
  

5. 许可信息

5.1 使用限制

couchbase/operator-backup 镜像仅可与 Couchbase Autonomous Operator 企业版 配合使用，未获得商业许可前不得用于生产环境。

5.2 许可详情

完整许可条款参见 Couchbase ***协议页面 中的“License Agreement”。

5.3 免费使用范围

• 允许无限期用于 预生产环境（开发、测试），无需支付许可费用
• 预生产环境支持仅通过 Couchbase 社区论坛 提供

参考资料

• Couchbase Autonomous Operator 备份文档
• cbbackupmgr 官方文档
• CouchbaseCluster 资源参考
• CouchbaseBackup 资源参考