BackupPlan v1.4.0 カスタム リソース定義

仕様スキーマ

BackupPlanSpec は、BackupPlan の望ましい状態を定義します。

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

フィールド タイプ 必須または省略可	説明
backupLocation
object 省略可	BackupLocation には、バックアップを保存するリモート オブジェクトの保存場所を指定します。たとえば、Cloud Storage バケットの仕様などです。このフィールドは省略可能です。デフォルトでは、バックアップはバックアップ ディスクに保存されます。
backupLocation.gcsOptions
object 省略可	gcsOptions は、Cloud Storage の依存オプションへの参照です。
backupLocation.gcsOptions.bucket
string 必須	Bucket は必須フィールドです（例: dbs-dump-bucket）。ユーザーは、オペレーター内からストレージ バケットへの適切な書き込みアクセス権を確保する必要があります。
backupLocation.gcsOptions.key
string 必須	ダンプファイルのオブジェクト キー。（例: ods-dump/scottschema.dmp）。
backupLocation.gcsOptions.secretRef
object 省略可	SecretRef は、GCS アクセス情報を保存するシークレットへの参照です。
backupLocation.gcsOptions.secretRef.name
string 省略可	名前は、Secret リソースを参照する Namespace 内で一意です。
backupLocation.gcsOptions.secretRef.namespace
string 省略可	Namespace は、Secret 名が一意である必要がある空間を定義します。
backupLocation.s3Options
object 省略可	s3Options は、Cloud Storage 依存のオプションへの参照です。
backupLocation.s3Options.bucket
string 必須	Bucket は必須フィールドです（例: dbs-dump-bucket）。ユーザーは、オペレーター内からストレージ バケットへの適切な書き込みアクセス権を確保する必要があります。
backupLocation.s3Options.caBundle
string 省略可	CABundle は、storageGrid のサーバー証明書の検証に使用される PEM でエンコードされた CA 証明書のプールです。
backupLocation.s3Options.endpoint
string 省略可	エンドポイントは S3 エンドポイントです。
backupLocation.s3Options.key
string 必須	ダンプファイルのオブジェクト キー。（例: ods-dump/scottschema.dmp）。
backupLocation.s3Options.secretRef
object 省略可	SecretRef は、Cloud Storage バケットへのアクセス認証情報を格納する Kubernetes Secret への参照です。
backupLocation.s3Options.secretRef.name
string 省略可	名前は、Secret リソースを参照する Namespace 内で一意です。
backupLocation.s3Options.secretRef.namespace
string 省略可	Namespace は、Secret 名が一意である必要がある空間を定義します。
backupLocation.type
string 必須	有効な値: GCS、S3。 リポジトリのタイプ（Amazon S3 の場合は S3、Google Cloud Storage の場合は GCS）。エージェントにどのストレージ システム / API を使用するかを指示します。
backupRetainDays
integer 省略可	デフォルト: 14、最小: 1、最大: 90。 サービスがバックアップを削除するまでの日数。指定した場合、この BackupPlan で作成されたバックアップは、存続期間（createTime + backupRetainDays）に達すると自動的に削除されます。有効な値は 1～90 日です。指定しない場合のデフォルトは 14 日間です。
backupSchedules
object 省略可	さまざまなタイプのバックアップのスケジュールを定義します。完全バックアップ、差分バックアップ、増分バックアップの種類がサポートされています。https://pgbackrest.org/user-guide.html#concept/backup このフィールドは省略可能です。デフォルトでは、毎日午前 0 時に 1 回フル バックアップを取得します。
backupSchedules.differential
string 省略可	差分 pgBackRest バックアップの Cron スケジュールを定義します。標準の Cron スケジュール構文に従います。https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax
backupSchedules.full
string 省略可	pgBackRest の完全バックアップの Cron スケジュールを定義します。標準の Cron スケジュール構文に従います。https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax
backupSchedules.incremental
string 省略可	pgBackRest の完全バックアップの Cron スケジュールを定義します。標準の Cron スケジュール構文に従います。https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax
dbclusterRef
string 省略可	このバックアッププランが構成する DBCluster 名。このフィールドは必須で、変更できません。
paused
boolean 省略可	デフォルトは false です。 この BackupPlan でバックアップの作成が一時停止されているかどうかを示すフラグ。true に設定すると、この BackupPlan の新しいバックアップのスケジュールがサービスによって停止されます。デフォルトは false です。

ステータス スキーマ

BackupPlanStatus は、BackupPlan の観測状態を定義します。

conditions:
- lastTransactionTime: 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) OPTIONALITY	Conditions は、エンティティの現在の状態に関する、利用可能な最新の観測値を表します。
conditions[]
object OPTIONALITY	Condition には、現在の一面の詳細が含まれています。
conditions[].lastTransactionTime
string 必須	あるステータスから別のステータスに移行した最後の時刻。これは、基本的な状態が変更されたときです。不明な場合は、API フィールドが変更された時刻を使用できます。
conditions[].message
string 必須	移行の詳細を示す人間が読めるメッセージ。空の文字列にすることもできます。
conditions[].observedGeneration
integer 省略可	条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が 12 で、.status.conditions[x].observedGeneration が 9 の場合、その状態はインスタンスの現在の状態に関して古くなっています。
conditions[].reason
string 必須	最大長: 1024、最小長: 1 状態の最後の移行の理由を示すプログラマティック ID が含まれます。特定の条件タイプのプロデューサーは、このフィールドの想定される値と意味、および値が保証付き API と見なされるかどうかを定義できます。値は CamelCase 文字列にする必要があります。このフィールドは空白にできません。
conditions[].status
string 必須	条件のステータス（True、False、Unknown のいずれか）。
conditions[].type
string 必須	最大長: 316 条件のタイプ（CamelCase または foo.example.com/CamelCase）。
criticalIncidents
object 必須	すべてのアクティブな重大インシデントのフラットなリスト。CriticalIncident には、進行中の重大なインシデントに関するすべての情報が含まれます。
criticalIncidents[].code
string 必須	この特定のエラーのエラーコード。エラーコードは DBSE と数値文字列（「DBSE1012」など）で構成されます。
criticalIncidents[].createTime
string 必須	このインシデントが送信元で作成されたときのタイムスタンプ。
criticalIncidents[].message
string 省略可	発生したインシデント / エラー。
criticalIncidents[].messageTemplateParams
object 省略可	ユーザー インターフェースでユーザー フレンドリーなデータドリブン バージョンのメッセージを生成するために必要な Key-Value ペアが含まれています。
criticalIncidents[].resource
object 必須	インシデントを報告した Database Service コンポーネントと Kubernetes リソースに関する情報が含まれます。
criticalIncidents[].resource.component
string 必須	インシデントを報告した Database Service サブシステムの内部識別子。
criticalIncidents[].resource.location
object 省略可	場所
criticalIncidents[].resource.location.cluster
string 省略可	影響を受ける Kubernetes リソースのクラスタの名前。
criticalIncidents[].resource.location.group
string 省略可	Kubernetes リソースのグループ名。
criticalIncidents[].resource.location.kind
string 省略可	Kubernetes リソースの Kind。
criticalIncidents[].resource.location.name
string 省略可	影響を受ける Kubernetes リソースの名前。
criticalIncidents[].resource.location.namespace
string 省略可	影響を受ける Kubernetes リソースの Namespace。
criticalIncidents[].resource.location.version
string 省略可	Kubernetes リソースのバージョン。
criticalIncidents[].stackTrace
object 省略可	スタック トレースからのメッセージの非構造化リスト。
criticalIncidents[].stackTrace.component
string 省略可	メッセージをログに記録した Database Service コンポーネントの名前。
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 省略可	終了時刻