KRM API gkebackup.gke.io/v1 API

gkebackup.gke.io/v1

gkebackup.gke.io v1 API グループの API スキーマ定義が含まれています。

BackupAllRestoreAll

このコンポーネントで選択されたすべてのものをバックアップし、復元時にすべてを復元する戦略を定義します。

表示場所: - 戦略

フィールド 説明
backupPreHooks HookSpec 配列 このコンポーネントの選択されたすべてのボリュームをバックアップする前に実行されるフックのリスト。通常、これらは静止手順です。実行ターゲット Pod は、このコンポーネント内のすべての Pod です。
backupPostHooks HookSpec 配列 このコンポーネントのすべてのボリュームがバックアップされた後に実行されるフックのリスト。通常、これらは非静止化の手順です。実行ターゲット Pod は、このコンポーネント内のすべての Pod です。
volumeSelector LabelSelector このコンポーネント内でバックアップおよび復元される永続ボリュームを選択するために使用されるラベル セレクタ。指定しない場合は、すべての永続ボリュームが選択されます。

BackupJobList

バックアップ ジョブのリストが含まれます。

フィールド 説明
apiVersion 文字列 gkebackup.gke.io/v1
kind 文字列 BackupJobList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items BackupJob の配列

BackupJobSpec

バックアップ ジョブの望ましい状態を定義します。

表示場所: - BackupJob

フィールド 説明
backupName 文字列 バックアップ ジョブが実行されているコントロール プレーンのバックアップ名。名前は変更できません。

BackupJobStatus

バックアップ ジョブの観測された状態を定義します。

表示場所: - BackupJob

フィールド 説明
phase BackupJobPhase バックアップの現在のフェーズ。
message 文字列 バックアップがこの状態にある理由の詳細を示す、人間が読める形式のメッセージ。
reason 文字列 更新内容を説明する短いキャメルケースの文字列。機械による解析と整然とした表示に使用されます。

BackupOneRestoreAll

このコンポーネント内の 1 つの Pod のボリュームのみをバックアップし、復元時にこれらのボリュームが他のすべての Pod に復元される戦略を定義します。この戦略は、1 つのプライマリと 1 つ以上のセカンダリの高可用性構成でデプロイされるアプリケーションに使用されます。この戦略は、定義された volumeClaimTemplate リソースを使用してボリュームをプロビジョニングする StatefulSet コンポーネントにのみ適用されます。

コンポーネントが複数の Deployment リソースで構成されている場合、すべての Deployment に 1 つのレプリカがあり、すべてのレプリカに同じ数の永続ボリュームがあり、すべての永続ボリュームが同じ順序で定義されている必要があります。これらのボリュームは .spec.template.spec.volumes フィールドで定義され、非永続ボリュームはスキップされます。

コンポーネントが複数の StatefulSet リソースで構成されている場合、すべての StatefulSet リソースのボリューム クレーム テンプレートの数は同じである必要があり、すべてのボリューム クレーム テンプレートは同じ順序に従う必要があります。これらは .spec.volumeClaimTemplates フィールドで定義されます。

表示場所: - 戦略

フィールド 説明
backupTargetName 文字列 バックアップに使用される優先 Deployment リソースまたは StatefulSet リソースの名前。このコンポーネントの構成方法に基づいて、ターゲット Pod を選択します。マルチ Deployment の場合は、この Deployment リソースによって作成された Pod を選択します。マルチ StatefulSet の場合は、ターゲット StatefulSet リソースによって作成された最初の Pod を選択します。単一の StatefulSet の場合は、ターゲット StatefulSet リソースによって作成された 2 番目の Pod を選択します。
backupPreHooks HookSpec 配列 このコンポーネントの選択されたすべてのボリュームをバックアップする前に実行されるフックのリスト。通常、これらは静止手順です。フックは、選択したバックアップ Pod でのみ実行されます。
backupPostHooks HookSpec 配列 このコンポーネントのすべてのボリュームがバックアップされた後に実行されるフックのリスト。通常、これらは非静止化の手順です。フックは、選択したバックアップ Pod でのみ実行されます。
volumeSelector LabelSelector ターゲット Pod 内でバックアップされるすべての永続ボリュームを選択するために使用されるラベルセレクタ。セレクタがターゲット Pod の外部のボリュームを選択する可能性がありますが、バックアップされるのはターゲット Pod に属するボリュームのみです。これらのボリューム バックアップは、復元時にセレクタによって選択された他のすべてのボリュームに復元されます。指定しない場合は、すべての永続ボリュームが選択されます。

コンポーネント

アプリケーション リソースのサブセットと、そのバックアップと復元の戦略を定義します。個々のコンポーネントは、StatefulSet リソースまたは Deployment リソースのリストで表されます。

表示場所: - ProtectedApplicationSpec

フィールド 説明
name 文字列 このコンポーネントの一意の名前。
resourceKind ResourceKind このコンポーネントに含まれるリソースの種類。リソースの種類は Deployment、StatefulSet、Pod のいずれかになります。Pod リソースの種類で現在サポートされているのは BackupAllRestoreAll 戦略のみです。
resourceNames 文字列配列 このコンポーネントに属するリソースの名前。resourceKind フィールドで定義されている内容に基づいて、Deployment、StatefulSet、または Pod リソースの名前のリストである必要があります。
strategy 戦略 このコンポーネントのバックアップと復元の方法の詳細。

DumpAndLoad

コンポーネントのバックアップと復元が、MySQL の mysqldump や PostgreSQL の pg_dump などのアプリケーション固有のツールを使用してデータのダンプと読み込みを行う戦略を定義します。ダンプファイルは専用のボリュームに保存されます。この戦略では、専用ボリュームのみがバックアップ対象として選択されます。ダンプ ターゲットと読み込みターゲットは異なる場合があります。この戦略は、定義された volumeClaimTemplate リソースを使用してボリュームをプロビジョニングする StatefulSet コンポーネントにのみ適用されます。

表示場所: - 戦略

フィールド 説明
dumpTarget 文字列 コンポーネント データのダンプに使用される優先 Deployment または StatefulSet リソースの名前。このコンポーネントの構成方法に基づいて、ターゲット Pod を選択します。Deployment には、ターゲット Deployment リソースによって作成された唯一の Pod を選択します。単一の StatefulSet の場合、レプリカ数が 2 より大きい場合は、ターゲット StatefulSet リソースによって作成された 2 番目の Pod を選択します。それ以外の場合は、唯一の Pod を選択します。マルチ StatefulSet の場合は、ターゲット StatefulSet リソースによって作成された最初の Pod を選択します。
loadTarget 文字列 コンポーネント データの読み込みに使用される優先 Deployment リソースまたは StatefulSet リソースの名前。このコンポーネントの構成方法に基づいて、ターゲット Pod を選択します。Deployment の場合は、ターゲット Deployment リソースによって作成された Pod を 1 つだけ選択します。StatefulSet の場合は、ターゲット StatefulSet リソースによって作成された最初の Pod を常に選択します。
dumpHooks HookSpec 配列 このコンポーネントのデータを専用ボリュームにダンプするために使用されるフックのリスト。実行ターゲット Pod は、DumpTarget フィールドから選択された Pod のいずれかです。
backupPostHooks HookSpec 配列 専用のダンプ ボリュームのバックアップ後に実行されるフックのリスト。通常、これらはクリーンアップ手順です。
loadHooks HookSpec 配列 専用ボリュームからこのコンポーネントのデータを読み込むために使用されるフックのリスト。読み込みの完了後にクリーンアップの手順が含まれる場合があります。実行ターゲット Pod は、LoadTarget フィールドから選択された Pod のいずれかです。
volumeSelector LabelSelector アプリケーション データのダンプと読み込みに使用される専用ボリュームを選択する必要があるラベルセレクタ。DumpTarget フィールドと LoadTarget フィールドの両方で、1 つのボリュームのみを選択する必要があります。

HookFailurePolicy

基になる型: string フックの実行でエラーが発生した場合に実行する動作。

表示場所: - HookSpec

HookSpec

ターゲット Pod が選択されていることを前提として、選択したコンテナでフックがどのように実行されるかを定義します。

表示される場所: - BackupAllRestoreAll - BackupOneRestoreAll - DumpAndLoad

フィールド 説明
name 文字列 このフックの名前。このフィールドは、フック実行のステータスと発生したエラーを特定するために使用されます。
container 文字列 このフックが実行されるコンテナ。指定しない場合、Pod の最初のコンテナで実行されます。
command 文字列配列 実行するコマンド。実行するフック コマンド。例: ["/sbin/fsfreeze", "--freeze"]
timeoutSeconds 整数 フックのタイムアウト（秒単位）。指定しない場合、デフォルト値は 30 です。
onError HookFailurePolicy フックの実行中にエラーが発生した場合の望ましい動作。有効な値は Ignore または Fail です。指定しない場合、値は Fail になります。

ProtectedApplication

Protectedapplication API のスキーマを定義します。

表示場所: - ProtectedApplicationList

フィールド 説明
apiVersion 文字列 gkebackup.gke.io/v1
kind 文字列 ProtectedApplication
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec ProtectedApplicationSpec
status ProtectedApplicationStatus

ProtectedApplicationError

この ProtectedApplication リソースの詳細なエラー情報が含まれます。

表示場所: - ProtectedApplicationStatus

フィールド 説明
reason 文字列 エラーを説明するキャメルケースの文字列。機械解析と整然とした表示に使用されます。
message 文字列 エラーの詳細を示す人が読めるメッセージ。

ProtectedApplicationList

ProtectedApplication リソースのリストが含まれます。

フィールド 説明
apiVersion 文字列 gkebackup.gke.io/v1
kind 文字列 ProtectedApplicationList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items ProtectedApplication 配列

ProtectedApplicationSpec

ProtectedApplication に属する関連リソースと、指定されたアプリケーションのバックアップまたは復元の方法を定義します。

表示場所: - ProtectedApplication

フィールド 説明
resourceSelection ResourceSelection この ProtectedApplication に属するリソース。
components コンポーネントの配列 この保護対象アプリケーションのコンポーネント。

ProtectedApplicationStatus

この ProtectedApplication リソースのステータスを定義します。

表示場所: - ProtectedApplication

フィールド 説明
readyToBackup ブール値 この ProtectedApplication リソースがバックアップの準備ができているかどうかを指定します。ProtectedApplication リソースにエラーが含まれている場合、そのリソースは準備完了になりません。
error ProtectedApplicationError 配列 この保護されたアプリケーションに関連するエラー。たとえば、1 つのコンポーネント構成が無効です。

ResourceKind

基盤となる型: string リソースの種類を定義します。

表示場所: - コンポーネント

ResourceSelection

このアプリケーションに属するリソースを識別する方法を定義します。

表示場所: - ProtectedApplicationSpec

フィールド 説明
type ResourceSelectionType アプリケーション ソースのタイプ。Type フィールドは ApplicationName または Selector にする必要があります。これはユニオン ディスクリミネータです。
applicationName 文字列 同じ Namespace 内の sig-apps アプリケーションの名前。これは、データ保護仕様が適用されるアプリケーションです。
selector LabelSelector 選択された ProtectedApplication リソースと同じ Namespace 内のリソース。データ保護仕様は、これらのリソースに適用されます。

ResourceSelectionType

基になる型: string 選択の型。

表示場所: - ResourceSelection

RestoreJob

RestoreJob API のスキーマを定義します

表示場所: - RestoreJobList

フィールド 説明
apiVersion 文字列 gkebackup.gke.io/v1
kind 文字列 RestoreJob
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec RestoreJobSpec
status RestoreJobStatus

RestoreJobList

RestoreJob リソースのリストが含まれます。

フィールド 説明
apiVersion 文字列 gkebackup.gke.io/v1
kind 文字列 RestoreJobList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items RestoreJob 配列

RestoreJobSpec

復元の望ましい状態を定義します。

表示場所: - RestoreJob

フィールド 説明
restoreName 文字列 RestoreName は、RestoreJob が実行されているコントロール プレーンの復元名です。名前は変更できません。

RestoreJobStatus

復元ジョブの観測された状態を定義します。

表示場所: - RestoreJob

フィールド 説明
phase RestoreJobPhase 復元の現在のステータス。
message 文字列 バックアップの復元がこの状態にある理由の詳細を示す、人間が読めるメッセージ。
reason 文字列 更新内容を説明するキャメルケースの文字列。機械解析と整然とした表示に使用されます。

戦略

特定のコンポーネントのバックアップと復元方法を定義します。BackupAllRestoreAll、BackupOneRestoreAll、DumpAndLoad のいずれかにする必要があります。

表示場所: - コンポーネント

フィールド 説明
type StrategyType バックアップと復元の戦略のタイプ。値は BackupAllRestoreAll、BackupOneRestoreAll、DumpAndLoad のいずれかのみです。Pod リソースの種類は BackupAllRestoreAll 戦略のみをサポートします。これはユニオン ディスクリミネータです。
backupAllRestoreAll BackupAllRestoreAll このコンポーネントで選択されたすべてのものをバックアップし、復元時にすべてのものを復元する戦略。
backupOneRestoreAll BackupOneRestoreAll このコンポーネント内の 1 つの Pod のボリュームのみをバックアップし、復元時に他のすべての Pod に復元する戦略。この戦略は、1 つのプライマリと 1 つ以上のセカンダリの高可用性構成でデプロイされるアプリケーションに使用されます。この戦略は、定義された volumeClaimTemplate リソースを使用してボリュームをプロビジョニングする StatefulSet コンポーネントにのみ適用されます。
dumpAndLoad DumpAndLoad コンポーネントのバックアップと復元を、MySQL の mysqldump や PostgreSQL の pg_dump などのアプリケーション固有のツールを使用してデータのダンプと読み込みを行う戦略。ダンプファイルは専用のボリュームに保存されます。この戦略では、バックアップする専用ボリュームのみを選択する必要があります。ダンプ ターゲットと読み込みターゲットは異なる場合があります。この戦略は、定義された volumeClaimTemplate リソースを使用してボリュームをプロビジョニングする StatefulSet コンポーネントにのみ適用されます。

StrategyType

基になる型: string コンポーネントのバックアップと復元の戦略を定義します。

表示場所: - 戦略