BackupPlan 自定义资源定义

规范架构

BackupPlan 规范定义了 BackupPlan 的所选状态。

BackupPlan:
  metadata:
    name: string
  spec:
    backupLocation:
      gcsOptions:
        bucket: string
        key: string
        secretRef:
          name: string
      s3Options:
        bucket: string
        caBundle: []string
        endpoint: string
        key: string
        region: string
        secretRef:
          name: string
      type: string
    backupRetainDays: integer
    backupSchedules:
      differential: string
      full: string
      incremental: string
    dbclusterRef: string
    paused: boolean

字段 类型 必需或可选	说明
name
string 必需	BackupPlan 资源的名称。
backupLocation
object 必需	指定用于存储备份的远程对象存储库位置。
backupLocation.gcsOptions
object 可选	Cloud Storage 存储库的配置选项。
backupLocation.gcsOptions.bucket
string 必需	Cloud Storage 存储桶名称，例如 dbs-dump-bucket。用户必须确保对存储桶具有写入权限。
backupLocation.gcsOptions.key
string 必需	备份转储文件的对象键前缀，例如 ods-dump/scottschema.dmp。
backupLocation.gcsOptions.secretRef
object 可选	对存储 Cloud Storage 访问信息的 Secret 资源的引用。
backupLocation.gcsOptions.secretRef.name
string 必需	Secret 资源的名称。
backupLocation.s3Options
object 可选	Amazon S3 或 S3 兼容对象存储库的配置选项。
backupLocation.s3Options.bucket
string 必需	S3 存储桶名称 - 例如 dbs-dump-bucket。用户必须确保对存储桶具有写入权限。
backupLocation.s3Options.caBundle
list (string) 可选	用于验证 S3 存储服务器证书的 PEM 编码的 CA 证书池。
backupLocation.s3Options.endpoint
string 可选	S3 端点网址，例如 https://s3.amazonaws.com。
backupLocation.s3Options.key
string 必需	备份转储文件的对象键前缀，例如 ods-dump/scottschema.dmp。
backupLocation.s3Options.region
string 必需	存储桶所在的 AWS S3 区域，例如 us-west-2。
backupLocation.s3Options.secretRef
object 可选	对包含 S3 存储空间访问凭据的 Secret 的引用。
backupLocation.s3Options.secretRef.name
string 必需	Secret 资源的名称。
backupLocation.type
string 必需	有效值：GCS、S3。 仓库的类型（对于 Amazon S3 为 S3，对于 Cloud Storage 为 GCS），用于告知代理要使用哪个存储系统或 API。
backupRetainDays
integer 可选	默认值：14；最小值：1，最大值：90。 服务将在多少天后自动删除 Backup。如果指定了该值，则在此 BackupPlan 下创建的 Backup 会在存留时间达到 createTime + backupRetainDays 后自动删除。
backupSchedules
object 可选	定义不同类型的自动备份的时间表。支持完整备份、差分备份和增量备份类型。如果未指定，则每天午夜 (0 0 * * *) 进行一次完整备份。
backupSchedules.differential
string 可选	用于定义自动差分备份时间表的标准 cron 表达式。
backupSchedules.full
string 可选	用于定义自动完整备份时间表的标准 cron 表达式（例如 0 0 * * *）。
backupSchedules.incremental
string 可选	用于定义自动增量备份时间表的标准 cron 表达式。
dbclusterRef
string 必需	相应备份方案所配置的 DBCluster 自定义资源的名称。此字段是必需字段且不可更改。
paused
boolean 可选	默认值：false。 一个标志，用于指示此备份方案下的备份创建是否已暂停。如果设置为 true，服务将暂停安排新的自动备份。

状态架构

BackupPlanStatus 定义观察到的 BackupPlan 状态。

conditions:
- lastTransitionTime: string
  message: string
  observedGeneration: integer
  reason: string
  status: string
  type: string
criticalIncidents:
- code: string
  createTime: string
  message: string
  messageTemplateParams: object
  resource:
    component: string
    location:
      cluster: string
      group: string
      kind: string
      name: string
      namespace: string
      version: string
  stackTrace:
  - component: string
    message: string
  transientUntil: string
lastBackupTime: string
nextBackupTime: string
observedGeneration: integer
phase: string
reconciled: boolean
recoveryWindow:
  begin: string
  end: string

字段 类型 必需或可选	说明
conditions
list (object) 可选	Conditions 表示实体当前状态的最新可用观察结果。
conditions[].lastTransitionTime
string 必需	条件上次从一种状态转换到另一种状态的时间。这是底层条件更改的时间。如果该信息未知，则使用 API 字段更改的时间。
conditions[].message
string 必需	人类可读的消息，指示有关转换的详细信息。此字段可以为空字符串。
conditions[].observedGeneration
integer 可选	表示设置条件所基于的 .metadata.generation。例如，如果 .metadata.generation 为 12，但 .status.conditions[x].observedGeneration 为 9，则表示条件相对于实例的当前状态已过时。
conditions[].reason
string 必需	长度上限：1024；长度下限：1 包含一个程序化标识符，指示条件上次转换的原因。特定条件类型的生成者可以为此字段定义预期值和含义。值必须是 CamelCase 字符串。此字段不得留空。
conditions[].status
string 必需	条件的状态，可为 True、False、Unknown 之一。
conditions[].type
string 必需	长度上限：316 条件的类型，采用 CamelCase 或 foo.example.com/CamelCase 形式。
criticalIncidents
list (object) 必需	所有活跃的严重突发事件的扁平列表。包含有关正在进行的严重突发事件的所有信息。
criticalIncidents[].code
string 必需	此特定错误的错误代码。错误代码的格式为 DBSE，后跟一个数字，例如 DBSE1012。
criticalIncidents[].createTime
string 必需	在源头创建此突发事件时的时间戳。
criticalIncidents[].message
string 可选	发生的突发事件或错误。
criticalIncidents[].messageTemplateParams
object 可选	包含在界面中生成人性化数据驱动型消息版本所需的键值对。
criticalIncidents[].resource
object 必需	包含有关报告突发事件的数据库服务组件的信息，以及有关集群管理器资源的信息。
criticalIncidents[].resource.component
string 必需	报告突发事件的数据库服务子系统的内部标识符。
criticalIncidents[].resource.location
object 可选	资源所在的位置。
criticalIncidents[].resource.location.cluster
string 可选	受影响的集群管理器资源的集群名称。
criticalIncidents[].resource.location.group
string 可选	集群管理器资源的组名称。
criticalIncidents[].resource.location.kind
string 可选	集群管理器资源的种类。
criticalIncidents[].resource.location.name
string 可选	受影响的集群管理器资源的名称。
criticalIncidents[].resource.location.namespace
string 可选	受影响的集群管理器资源的命名空间。
criticalIncidents[].resource.location.version
string 可选	集群管理器资源的版本。
criticalIncidents[].stackTrace
list (object) 可选	来自堆栈轨迹的消息的非结构化列表。
criticalIncidents[].stackTrace.component
string 可选	记录消息的数据库服务组件的名称。
criticalIncidents[].stackTrace.message
string 可选	记录的消息。
criticalIncidents[].transientUntil
string 可选	如果存在，则 TransientUntil 指示在指定时间之前，问题必须被视为暂时性问题。
lastBackupTime
string 可选	最近执行的备份的时间戳。
nextBackupTime
string 可选	下一个预定备份的时间戳。
observedGeneration
integer 可选	控制器观察到的生成。
phase
string 可选	BackupPlan 的阶段。
reconciled
boolean 可选	资源是否由控制器进行了协调。
recoveryWindow
object 可选	可用的恢复时段。
recoveryWindow.begin
string 可选	开始时间。
recoveryWindow.end
string 可选	结束时间。