KRM API oracle.dbadmin.gdc.goog/v1

oracle.dbadmin.gdc.goog/v1

バックアップ

Backup は、backups API のスキーマです。

表示場所: - BackupList

フィールド 説明
apiVersion 文字列 oracle.dbadmin.gdc.goog/v1
kind 文字列 Backup
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec BackupSpec
status BackupStatus

BackupList

BackupList には Backup のリストが含まれます

フィールド 説明
apiVersion 文字列 oracle.dbadmin.gdc.goog/v1
kind 文字列 BackupList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items バックアップの配列

BackupPlan

BackupPlan は、backupplans API のスキーマです。

表示場所: - BackupPlanList

フィールド 説明
apiVersion 文字列 oracle.dbadmin.gdc.goog/v1
kind 文字列 BackupPlan
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec BackupPlanSpec
status BackupPlanStatus

BackupPlanList

BackupPlanList には BackupPlan のリストが含まれます

フィールド 説明
apiVersion 文字列 oracle.dbadmin.gdc.goog/v1
kind 文字列 BackupPlanList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items BackupPlan の配列

BackupPlanSpec

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

表示場所: - BackupPlan

フィールド 説明
dbclusterRef DBClusterRef このバックアップ プランが構成する DBCluster 名。このフィールドは必須で、変更できません。
backupRetainDays 整数 サービスがバックアップを削除するまでの日数。指定した場合、この BackupPlan で作成されたバックアップは、存続期間(create_time + backup_retain_days)に達すると自動的に削除されます。有効な値は 1~90 日です。指定しない場合のデフォルトは 14 日間です。
paused ブール値 この BackupPlan でバックアップの作成が一時停止されているかどうかを示すフラグ。true に設定すると、この BackupPlan の新しいバックアップのスケジュールがサービスによって停止されます。デフォルトは False です。
PITREnabled ブール値 ポイントインタイム リカバリをサポートするためにログ レプリケーションが有効になっているかどうかを示すフラグ。デフォルトは False です。nullon(samwise-fleet)

BackupPlanStatus

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

表示場所: - BackupPlan

フィールド 説明
observedGeneration 整数 内部: コントローラによって観測された世代。
reconciled ブール値 Internal: リソースがコントローラによって調整されたかどうか。
criticalIncidents CriticalIncident の配列 criticalIncidents は、アクティブなすべての重大インシデントのフラットなリストです。
conditions 条件の配列 conditions は、エンティティの現在の状態について利用可能な最新の観測値を表します。
phase BackupPlanPhase
lastBackupTime 時間 LastBackupTime は、最後に実行されたバックアップのタイムスタンプです。
nextBackupTime 時間 NextBackupTime は、次回スケジュールされているバックアップのタイムスタンプです。
recoveryWindow TimeWindow RecoveryWindow は、現在利用可能な復元期間です。

BackupSpec

BackupSpec は、Backup の望ましい状態を定義します。

表示場所: - バックアップ

フィールド 説明
dbclusterRef DBClusterRef このバックアップが属する DBCluster 名。このフィールドは必須です。
backupPlanRef BackupPlanRef このバックアップが作成された BackupPlan の名前。このフィールドは必須です。
manual ブール値 このバックアップがスケジュールされたバックアップと手動バックアップのどちらであるかを示します。このフィールドは省略可能です。指定しない場合は false(スケジュールされたバックアップ)にデフォルト設定されます。

BackupStatus

BackupStatus は、Backup の観測された状態を定義します。

表示場所: - バックアップ

フィールド 説明
observedGeneration 整数 内部: コントローラによって観測された世代。
reconciled ブール値 Internal: リソースがコントローラによって調整されたかどうか。
criticalIncidents CriticalIncident の配列 criticalIncidents は、アクティブなすべての重大インシデントのフラットなリストです。
conditions 条件の配列 conditions は、エンティティの現在の状態について利用可能な最新の観測値を表します。
phase BackupPhase
createTime 時間 バックアップの作成日時
completeTime 時間 バックアップの完了時間

DBCluster

DBCluster は、dbclusters API のスキーマです

表示場所: - DBClusterList

フィールド 説明
apiVersion 文字列 oracle.dbadmin.gdc.goog/v1
kind 文字列 DBCluster
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec DBClusterSpec
status DBClusterStatus

DBClusterList

DBClusterList には DBCluster のリストが含まれます

フィールド 説明
apiVersion 文字列 oracle.dbadmin.gdc.goog/v1
kind 文字列 DBClusterList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items DBCluster 配列

DBClusterSpec

DBClusterSpec は、DBCluster の望ましい状態を定義します

表示場所: - DBCluster

フィールド 説明
primaryCluster 文字列 nullon(samwise-fleet)
isDeleted ブール値 isDeleted は、DBCluster の削除リクエストを示します。このフィールドは省略可能で、デフォルトでは false です。このフィールドは、データベース クラスタのすべてのインスタンスに適用されます。これを true に設定すると、コントロール プレーンはネットワーク エンドポイントなどの関連リソースの解放を試みます。成功または失敗の表示(ある場合)については、ステータス フィールドをご覧ください。
mode 文字列 この DBCluster のモードを示します。
availability 可用性 availability には、DBCluster HA 機能の調整可能な設定を指定します
allowExternalIncomingTraffic ブール値
tls TLSSpec TLS は、クラスタに必要なサーバー証明書の構成です。このフィールドは省略可能です。デフォルトでは、このフィールドは空で、クラスタ用に新しい自己署名 CA とリーフ証明書が生成されます。このフィールドを変更すると、データベース クラスタ Pod が再起動され、指定された証明書が読み込まれます。status.certificateReference フィールドは、現在の CA 証明書の Secret と鍵を示します。
databaseVersion 文字列 databaseVersion は、クラスタに必要なデータベース バージョンです(例: 15.4.5)。このフィールドは必須です。このバージョンは、データベース クラスタのすべてのインスタンスに適用されます。新しいデータベース クラスタの場合、インスタンスは指定されたバージョンを使用して作成されます。既存のデータベース クラスタの場合、オペレーターは指定された databaseVersion へのアップグレードまたはダウングレードを試みます。status.currentDatabaseVersion フィールドは、現在のデータベース バージョンを示します。
controlPlaneAgentsVersion 文字列 controlPlaneAgentsVersion は、クラスタに必要なコントロール プレーン エージェントのバージョンです(例: 0.5.2)。このフィールドは必須です。controlPlaneAgentsVersion は、選択した databaseVersion と互換性がある必要があります。対応しているバージョンについては、{link} で利用可能なバージョンのリストをご覧ください。このバージョンは、データベース クラスタのすべてのインスタンスに適用されます。新しいデータベース クラスタの場合、インスタンスは指定されたバージョンを使用して作成されます。既存のデータベース クラスタの場合、オペレーターは指定された controlPlaneAgentsVersion へのアップグレードまたはダウングレードを試みます。status.currentControlPlaneAgentsVersion フィールドは、コントロール プレーン エージェントの現在のバージョンを示します。
databaseImage 文字列 DatabaseImage は、コンテナ レジストリ内のカスタマイズされたデータベース イメージの URI です(例: gcr.io/foo/bar/alloydbomni:15-7-2-customized)。このフィールドは省略可能です。databaseImage が指定されている場合、オペレーターは、指定された databaseVersion のデフォルトのデータベース コンテナ イメージではなく、このコンテナ イメージをデータベースに使用します。databaseImage コンテナは、選択した databaseVersion で使用されるデフォルトのデータベース イメージに基づいていることをおすすめします。
primarySpec OracleInstanceSpec

DBClusterStatus

DBClusterStatus は、DBCluster の観測された状態を定義します。

表示場所: - DBCluster

フィールド 説明
observedGeneration 整数 内部: コントローラによって観測された世代。
reconciled ブール値 Internal: リソースがコントローラによって調整されたかどうか。
criticalIncidents CriticalIncident の配列 criticalIncidents は、アクティブなすべての重大インシデントのフラットなリストです。
conditions 条件の配列 conditions は、エンティティの現在の状態について利用可能な最新の観測値を表します。
phase DBClusterPhase
primary PrimaryStatus primary には、プライマリ インスタンスのステータスが含まれます。
restoredFrom RestoredFrom
maintenanceStatus MaintenancePolicyStatus MaintenanceStatus は、今後のメンテナンスに関する情報を提供します。nullon(samwise-fleet)
upgradeScheduledAt 時間 UpgradeScheduledAt は、次のアップグレードが開始される予定の時刻を示すタイムスタンプです。nil の場合は、予定されているアップグレードがないことを意味します。nullon(samwise-fleet)
serviceAccounts オブジェクト(キー:OpType、値:ServiceAccountRef serviceAccounts には、さまざまなオペレーションで使用するためにコントロール プレーンによって作成されたサービス アカウントが含まれます。これらのサービス アカウントに権限を付与すると、データベースは Kubernetes エコシステム内の他のサービスとやり取りできるようになります。必要な権限など、詳細については、各オペレーションのドキュメントをご覧ください。
certificateReference CertificateRef certificateReference は、データベースへの接続に使用できるサーバー CA 証明書の Secret と鍵を参照します。spec.TLS が指定されている場合、この値は、指定されたサーバー証明書を使用するようにデータベースが構成された後、同じ Secret を参照する必要があります。
latestFailoverStatus FailoverStatus latestFailoverStatus は、データベース クラスタの最新のフェイルオーバーのステータスです。このステータスは、データベース クラスタの現在のフェイルオーバー オペレーションまたは最新のフェイルオーバー オペレーションのステータスのコピーです。これを使用して、現在実行中のフェイルオーバー オペレーションのステータスを簡単にモニタリングできます。
migrationStatus MigrationStatus MigrationStatus は、データベース クラスタの移行ステータスを表します。nullon(samwise-fleet)
availabilityZones AvailabilityZones AvailabilityZones は、マルチゾーン HA データベース クラスタのゾーン ステータスを表します。

エクスポート

Export は、エクスポート API のスキーマです。

表示場所: - ExportList

フィールド 説明
apiVersion 文字列 oracle.dbadmin.gdc.goog/v1
kind 文字列 Export
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec ExportSpec
status ExportStatus

ExportList

フィールド 説明
apiVersion 文字列 oracle.dbadmin.gdc.goog/v1
kind 文字列 ExportList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items エクスポート配列

ExportSpec

ExportSpec は、Export の望ましい状態を定義します。

表示場所: - エクスポート

フィールド 説明
dbclusterRef DBClusterRef dbclusterRef は、エクスポート元の同じ名前空間内の DBCluster 名です。
exportLocation StorageSpec exportLocation には、エクスポート ファイルの保存場所を指定します。ユーザーは、Operator 内からストレージ バケットへの適切な書き込みアクセス権を確保する必要があります。

ExportStatus

ExportStatus は、Export の観測された状態を定義します。

表示場所: - エクスポート

フィールド 説明
observedGeneration 整数 内部: コントローラによって観測された世代。
reconciled ブール値 Internal: リソースがコントローラによって調整されたかどうか。
criticalIncidents CriticalIncident の配列 criticalIncidents は、アクティブなすべての重大インシデントのフラットなリストです。
conditions 条件の配列 conditions は、エンティティの現在の状態について利用可能な最新の観測値を表します。
phase ExportPhase phase は、エクスポートの現在の状態の概要です。
startTime 時間 startTime は、エクスポートが開始された時刻です。
completeTime 時間 completeTime は、エクスポートが完了した時刻です。
exportSubDirectory 文字列 exportSubDirectory は、エクスポートされたファイルを保存するために exportLocation に追加されるサブディレクトリです。

インポート

Import は、import API のスキーマです。

表示場所: - ImportList

フィールド 説明
apiVersion 文字列 oracle.dbadmin.gdc.goog/v1
kind 文字列 Import
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec ImportSpec
status ImportStatus

ImportList

フィールド 説明
apiVersion 文字列 oracle.dbadmin.gdc.goog/v1
kind 文字列 ImportList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items インポートの配列

ImportSpec

ImportSpec は、Import の望ましい状態を定義します。

表示場所: - インポート

フィールド 説明
dbclusterRef DBClusterRef dbclusterRef は、インポート先の同じ Namespace 内の DBCluster 名です。
databaseName 文字列 databaseName は、インポート先のインスタンス内のデータベース リソース名です。
dumpStorage StorageSpec dumpStorage には、インポート ダンプファイルの保存場所を指定します。ユーザーは、Operator 内からストレージ バケットを読み取れる適切な権限を取得する必要があります。
logStorage StorageSpec logStorage には、インポートログをコピーするストレージのロケーションを指定します。ユーザーは、Operator 内からストレージ バケットへの適切な書き込みアクセス権を確保する必要があります。
downloadOnly ブール値 downloadOnly を true に設定すると、ダンプファイルはダウンロードされますが、DB にはインポートされません。デフォルトは false です。
tableExistAction 文字列 TableExistAction は、既存のテーブルにインポートするときのアクションです。デフォルトではスキップされます。

ImportStatus

ImportStatus は、Import の観測された状態を定義します。

表示場所: - インポート

フィールド 説明
observedGeneration 整数 内部: コントローラによって観測された世代。
reconciled ブール値 Internal: リソースがコントローラによって調整されたかどうか。
criticalIncidents CriticalIncident の配列 criticalIncidents は、アクティブなすべての重大インシデントのフラットなリストです。
conditions 条件の配列 conditions は、エンティティの現在の状態について利用可能な最新の観測値を表します。
phase ImportPhase phase は、インポートの現在の状態の概要です。
startTime 時間 startTime はインポートの開始時間です。
completeTime 時間 completeTime は、インポートが完了した時刻です。
dumpPath 文字列 dumpPath は、ダウンロードのみのインポート用にダウンロードされたダンプファイルのパスです。

OracleInstanceSpec

表示場所: - DBClusterSpec

フィールド 説明
version 文字列 データベースのバージョン。nullon(samwise-fleet,samwise-local)
images オブジェクト(キー:文字列、値:文字列) 非推奨: データベース インスタンスの置換イメージ。nullon(samwise-fleet,samwise-local)
component オブジェクト(キー:InstanceComponentName、値:InstanceComponentSpec インスタンス コンポーネントのリスト。インスタンスは dataplane コンポーネントと controlPlaneAgent コンポーネントで構成されます。nullon(samwise-fleet)
dbLoadBalancerOptions DBLoadBalancerOptions DBNetworkServiceOptions を使用すると、データベースへの接続を公開するために作成された Kubernetes Service の詳細をオーバーライドできます。
sourceCidrRanges 文字列配列 クライアントに許可される送信元 IP の CIDR 範囲。
parameters オブジェクト(キー:文字列、値:文字列) parameters を使用すると、データベース クラスタのデータベース パラメータを設定できます。このフィールドは省略可能です。parameters は、データベース エンジンで定義されているパラメータ名と値に対応する Key-Value ペアを受け取ります。
services object (keys:Service, values:boolean) services は、お客様が選択できるオプションのセミマネージド サービスのリストです。
resources リソース データベース コンテナのリソース仕様。リソース内のいずれかのフィールドが変更されると、オペレーターは新しいリソース仕様でデータベース インスタンスを再起動します。
mode InstanceMode mode は、このインスタンスがオペレーターによってどのように管理されるかを指定します。
databasePatchingTimeout 期間 データベース パッチ適用の最大しきい値。このタイムアウトは、sts パッチ適用と OPatch/datapatch 実行に個別に使用されます。nullon(samwise-fleet)
adminUser AdminUserSpec adminUser は、管理者ユーザーの仕様を表します。このフィールドは必須です。これは、コントロール プレーンが作成する最初のデータベース ユーザーです。追加のデータベース ユーザーは、エンドユーザーが直接管理します。このフィールドは、初期ユーザーのパスワードを再設定する場合にも使用できます。
isStopped ブール値 isStopped を true に設定すると、インスタンスが停止します。このフィールドは省略可能で、デフォルトは false です。停止すると、インスタンスのコンピューティング リソース(CPU、メモリ)が解放されます。ただし、インスタンスはストレージ リソースとネットワーク エンドポイントを保持するため、ダウンストリーム サービスに対して再起動が透過的になります。ステータス フィールドで、成功または失敗を確認します(ある場合)。
availabilityOptions AvailabilityOptions AvailabilityOptions には、HA 機能の調整可能な設定が含まれています
allowExternalIncomingTrafficToInstance ブール値 allowExternalIncomingTrafficToInstance は、外部 LB の作成を構成するために使用されます。
auditLogTarget AuditLogTargetSpec AuditLogTarget は、データベース監査ログのシンクを構成します
replication ReplicationSpec レプリケーションは、他の DB インスタンスへのレプリケーション接続を構成します。nullon(samwise-fleet)
tls TLSSpec TLS は、インスタンスに必要なサーバー証明書の構成です。このフィールドは省略可能です。このフィールドを変更すると、インスタンス Pod が再起動して、指定された証明書が読み込まれます。
schedulingconfig SchedulingConfig schedulingConfig には、Kubernetes ノードでインスタンスをスケジュールする方法を指定します。スケジューリング構成内のいずれかのフィールドが変更されると、構成に基づいて k8s Pod が別のノードに再スケジュールされる可能性があります。
cdbName 文字列 CDBName は、CDB 属性の目的の名前です。CDBName が元の名前(CDB の作成に使用された名前)と異なる場合、CDB の名前が変更されます。
characterSet 文字列 データベースの作成に使用される文字セット(デフォルトは AL32UTF8)。
memoryPercent 整数 MemoryPercent は、Oracle SGA に割り当てるメモリの割合を表します(デフォルトは 25%)。
EnableTLS ブール値 EnableTLS は、TLS 暗号化接続を有効にします。

復元

Restore は、restores API のスキーマです。

表示場所: - RestoreList

フィールド 説明
apiVersion 文字列 oracle.dbadmin.gdc.goog/v1
kind 文字列 Restore
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec RestoreSpec
status RestoreStatus

RestoreList

RestoreList には Restore のリストが含まれています

フィールド 説明
apiVersion 文字列 oracle.dbadmin.gdc.goog/v1
kind 文字列 RestoreList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items 復元配列

RestoreSpec

RestoreSpec は、Restore の望ましい状態を定義します。

表示場所: - 復元

フィールド 説明
sourceDBCluster DBClusterRef 復元元のソース DBCluster の名前。このフィールドは必須です。
pointInTime 時間 復元する過去の時点。このフィールドは省略可能です。指定しない場合、デフォルトで利用可能な最後の時点が復元されます。
clonedDBClusterConfig ClonedDBClusterConfig クローンを作成した DBCluster の設定。これにより、クローンを作成した DBCluster の名前を指定できます。このフィールドは省略可能です。指定しない場合、デフォルトでソース DBCluster が復元されます。

RestoreStatus

RestoreStatus は、Restore の観測された状態を定義します。

表示場所: - 復元

フィールド 説明
observedGeneration 整数 内部: コントローラによって観測された世代。
reconciled ブール値 Internal: リソースがコントローラによって調整されたかどうか。
criticalIncidents CriticalIncident の配列 criticalIncidents は、アクティブなすべての重大インシデントのフラットなリストです。
conditions 条件の配列 conditions は、エンティティの現在の状態について利用可能な最新の観測値を表します。
phase RestorePhase
createTime 時間 Restore の作成日時
completeTime 時間 復元の完了時間
restoredPointInTime 時間 この復元によってターゲット DBCluster が移行する実際の時点。spec.PointInTime で指定された値と異なる場合があります。nullon(samwise-fleet)