BackupPlan 自訂資源定義

規格結構定義

BackupPlan Spec 會定義 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 bucket 名稱,例如 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 的天數。如果指定了這項設定,系統會在 達到 createTime + backupRetainDays 歲時,自動刪除根據這個 BackupPlan 建立的 Backup。
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[].lastTransitionTime
string
必填
條件最近一次從一個狀態轉變為另一個狀態的時間。這是指基礎條件發生變化。如果不知道,請使用 API 欄位變更的時間。
conditions[].message
string
必填
使用者可理解的訊息,指出轉換的詳細資料。這個值可以是空白字串。
conditions[].observedGeneration
integer
選填
代表設定條件的 .metadata.generation。舉例來說,如果 .metadata.generation 為 12,但 .status.conditions[x].observedGeneration 為 9,則條件與執行個體的目前狀態不符。
conditions[].reason
string
必填
長度上限:1024,長度下限:1。包含程式化 ID,指出條件上次轉換的原因。特定條件類型的產生者可能會定義這個欄位的預期值和意義。值必須是 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
必填
回報事件的資料庫服務子系統內部 ID。
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
選填
結束時間。