API Reference

Packages

postgresql.cnpg.io/v1

パッケージv1には、postgresql v1 APIグループのAPIスキーマ定義が含まれています

Resource Types

AffinityConfiguration

AffinityConfigurationには、ポッドのアフィニティルールを作成するために必要な情報が含まれています

登場場所:

Field

Description

Required

Default

Validation

enablePodAntiAffinity _boolean_

ポッドのアンチアフィニティをアクティブにします。このフィールドが明示的にfalseに設定されていない限り、オペレーターはポッドのアンチアフィニティを定義します

topologyKey _string_

アンチアフィニティ構成に使用するトポロジキー。詳細については、k8sドキュメントを参照してください。

nodeSelector _object (keys:string, values:string)_

NodeSelectorは、ポッドを実行できるノードを定義するために使用されるキーと値ペアのマップです。　詳細 https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

nodeAffinity _ NodeAffinity _

NodeAffinityは、ポッドのノードアフィニティスケジューリングルールを説明します。　詳細 https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity

tolerations _ 許容範囲 array_

Tolerationsは、汚染されたノードで実行できるようにするために、すべてのポッドに設定する必要がある許容範囲のリストです。　詳細情報 https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/

podAntiAffinityType _string_

PodAntiAffinityTypeを使用すると、ユーザーは、クラスターインスタンス間のポッドアンチアフィニティを、スケジュール中に強い要件と見なすかどうかを決定できます。許可される値は次のとおりです。"preferred"空の場合のデフォルトまたは"required"。 「required」に設定すると、既存のすべてのノードが必要なポッドのアンチアフィニティルールと一致しない場合、新しいkubernetesノードが追加されるまでインスタンスが保留されたままになる可能性があります。　詳細情報 https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity

additionalPodAntiAffinity _ PodAntiAffinity _

AdditionalPodAntiAffinityでは、 EnablePodAntiAffinityがtrueデフォルトに設定されている場合にオペレーターによって生成された用語に追加するポッドアンチアフィニティ用語、またはfalseに設定されている場合に排他的に使用されるポッドアンチアフィニティ用語を指定できます。

additionalPodAffinity _ PodAffinity _

AdditionalPodAffinityでは、すべてのクラスターのポッドに渡されるポッドアフィニティ用語を指定できます。

AvailableArchitecture

AvailableArchitectureは、クラスターのアーキテクチャの状態を表します

登場場所:

Field

Description

Required

Default

Validation

goArch _string_

GoArchは実行可能アーキテクチャの名前です

True

hash _string_

ハッシュは実行可能ファイルのハッシュです

True

Backup

バックアップリソースは、ユーザーによるPostgreSQLバックアップの要求です。

Field

Description

Required

Default

Validation

apiVersion _string_

postgresql.cnpg.io/v1

True

kind _string_

Backup

True

metadata _ EmbeddedObjectMetadata _

`metadata`のフィールドについては、Kubernetes APIドキュメントを参照してください。

True

spec _ BackupSpec _

バックアップの目的の動作の仕様。　詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

True

status _ BackupStatus _

最近観察されたバックアップのステータス。このデータは最新でない場合があります。システムによって設定されます。読み取り専用。　詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

BackupConfiguration

BackupConfigurationは、クラスターのバックアップを取得する方法を定義します。サポートされているバックアップ方法は、BarmanObjectStoreと VolumeSnapshotです。詳細と例については、ドキュメントのバックアップとリカバリーセクションを参照してください。

登場場所:

Field

Description

Required

Default

Validation

volumeSnapshot _ VolumeSnapshotConfiguration _

VolumeSnapshotは、ボリュームスナップショットバックアップを実行するための構成を提供します。

barmanObjectStore _ BarmanObjectStoreConfiguration _

barman-cloudツールスイートの構成

retentionPolicy _string_

RetentionPolicyは、バックアップとWALつまり '60d'に使用される保持ポリシーです。保持ポリシーは、 XXu`のフォームで表現されます。ここで、 `XX`は正の整数、`u`は`[dwm] - 日、週、月です。　現在、BarmanObjectStoreメソッドを使用する場合にのみ適用されます。

Pattern: ^[1-9][0-9]*[dwm]$

target _ BackupTarget _

バックアップを実行するインスタンスを決定するポリシー。使用可能なオプションは空の文字列であり、デフォルトで`prefer-standby`ポリシー、 primary`で常にプライマリインスタンスでバックアップを実行します、 `prefer-standby 可能な場合は、できれば最新のスタンバイでバックアップを実行します。

prefer-standby

Enum: [primary prefer-standby]

BackupMethod

Underlying type: string

BackupMethodは、選択したPostgreSQLインスタンスの物理ベースのバックアップを実行する方法を定義します

登場場所:

Field

Description

volumeSnapshot

BackupMethod VolumeSnapshotとは、ボリュームスナップショットを使用することを意味します Kubernetes機能

barmanObjectStore

BackupMethodBarmanObjectStoreは、barmanを使用してPostgreSQLクラスターをバックアップすることを意味します

plugin

BackupMethodPluginは、このバックアップをプラグインで処理する必要があることを意味します

BackupPhase

Underlying type: string

BackupPhaseはバックアップのフェーズです

登場場所:

BackupPluginConfiguration

BackupPluginConfigurationには、バックアッププラグインが使用するバックアップ構成が含まれます

登場場所:

Field

Description

Required

Default

Validation

name _string_

Nameは、このバックアップを管理するプラグインの名前です

True

parameters _object (keys:string, values:string)_

パラメーターは、このバックアップのbackup プラグインに渡される構成パラメーターです。

BackupSnapshotElementStatus

BackupSnapshotElementStatusは、ボリュームスナップショット方式バックアップの一部であるボリュームスナップショットです

登場場所:

Field

Description

Required

Default

Validation

name _string_

Nameはスナップショットリソース名です

True

type _string_

タイプは、クラスター内のスナップショットのロールです。PG_DATA、PG_WAL、PG_TABLESPACEなど

True

tablespaceName _string_

TablespaceNameは、スナップショットされたテーブルスペースの名前です。タイプがPG_TABLESPACEの場合のみ設定します

BackupSnapshotStatus

BackupSnapshotStatus volumeSnapshot方法のバックアップ専用のフィールド

登場場所:

Field

Description

Required

Default

Validation

elements _ BackupSnapshotElementStatus array_

収集されたボリュームスナップショットが設定された要素リスト

BackupSource

BackupSourceには、復元する必要があるバックアップと、それを正しく復元するために必要な情報が含まれています。

登場場所:

Field

Description

Required

Default

Validation

name _string_

参照先の名前。

True

endpointCA _ SecretKeySelector _

EndpointCAは、バーマンエンドポイントのCAバンドルを保存します。　自己署名証明書を使用して、証明書発行者とbarman-cloud-wal-archiveでのエラーを回避する場合に役立ちます。

BackupSpec

BackupSpecは、バックアップの望ましい状態を定義します

登場場所:

Field

Description

Required

Default

Validation

cluster _ LocalObjectReference _

バックアップするクラスター

True

target _ BackupTarget _

このバックアップを実行するインスタンスを決定するポリシー。空の場合、デフォルトの`cluster.spec.backup.target`になります。　使用可能なオプションは、空の文字列、`primary`および`prefer-standby`です。　`primary`は常にプライマリインスタンスでバックアップを実行するようにし、 `prefer-standby`は、可能な場合は最も更新されたスタンバイでバックアップを実行します。

Enum: [primary prefer-standby]

method _ BackupMethod _

使用するバックアップ方法、可能なオプションは`barmanObjectStore`、volumeSnapshot`または`plugin`です。デフォルト`barmanObjectStore

barmanObjectStore

Enum: [barmanObjectStore volumeSnapshot plugin]

pluginConfiguration _ BackupPluginConfiguration _

このバックアップを管理するプラグインに渡される構成パラメーター

online _boolean_

ボリュームスナップショットを使用したバックアップのデフォルトのタイプが オンライン/ホット true、デフォルトかオフライン/コールド `false`かどうか クラスターフィールド '.spec.backup.volumeSnapshot.online'で指定されたデフォルト設定をオーバーライドします

onlineConfiguration _ OnlineConfiguration _

ボリュームスナップショットを使用してオンライン/ホットバックアップを制御する構成パラメーター クラスターで指定されたデフォルト設定をオーバーライドします '.backup.volumeSnapshot.onlineConfiguration'スタンザ

BackupStatus

BackupStatusは、バックアップの監視された状態を定義します

登場場所:

Field

Description

Required

Default

Validation

googleCredentials _ GoogleCredentials _

Google Cloud Storageにデータをアップロードするために使用する資格情報

s3Credentials _ S3Credentials _

S3にデータをアップロードするために使用する資格情報

azureCredentials _ AzureCredentials _

Azure Blob Storageにデータをアップロードするために使用する資格情報

majorVersion _integer_

バックアップが取られたときに実行されていたPostgreSQLメジャーバージョン。

True

endpointCA _ SecretKeySelector _

EndpointCAは、バーマンエンドポイントのCAバンドルを保存します。　自己署名証明書を使用して、証明書発行者とbarman-cloud-wal-archiveでのエラーを回避する場合に役立ちます。

endpointURL _string_

クラウドにデータをアップロードするために使用されるエンドポイント、自動エンドポイント検出をオーバーライドする

destinationPath _string_

バックアップを保存するパスつまりs3://bucket/path/to/folder このパスは、さまざまな宛先フォルダーで、WALとデータに使用されます。これは、エラーが発生した場合に入力されない場合があります。

serverName _string_

S3のサーバー名、クラスター名は、この パラメータが省略された場合に使用されます

encryption _string_

S3 APIに必要な暗号化方法

backupId _string_

BarmanバックアップのID

backupName _string_

Barmanのバックアップの名前

phase _ BackupPhase _

前回のバックアップステータス

startedAt _ バックアップからのポイント インタイム リカバリーPITR _

バックアップが開始されたとき

stoppedAt _ バックアップからのポイント インタイム リカバリーPITR _

バックアップが終了したとき

beginWal _string_

開始するWAL

endWal _string_

エンディングWAL

beginLSN _string_

スタートxlog

endLSN _string_

エンディングxlog

error _string_

検出されたエラー

commandOutput _string_

未使用。古いバージョンとの互換性のために保持されています。

commandError _string_

エラーが発生した場合のbackupコマンド出力

backupLabelFile _integer array_

オンラインホットバックアップの場合にPostgresから返されたラベルファイルのコンテンツをバックアップします

tablespaceMapFile _integer array_

オンラインホットバックアップの場合にPostgresによって返されるテーブルスペースマップファイルのコンテンツ

instanceID _ InstanceID _

バックアップが取得されたインスタンスを識別する情報

snapshotBackupStatus _ BackupSnapshotStatus _

ボリュームのステータススナップショットバックアップ

method _ BackupMethod _

使用されているバックアップ方法

online _boolean_

バックアップがオンライン/ホット true またはオフライン/コールド false

pluginMetadata _object (keys:string, values:string)_

プラグインのメタデータを含むマップ

BackupTarget

Underlying type: string

BackupTargetは、バックアップの優先ターゲットを説明します

登場場所:

BootstrapConfiguration

BootstrapConfigurationには、PostgreSQLクラスターの作成方法に関する情報が含まれています。サポートされているブートストラップ方法のうち、1つのブートストラップ方法のみを定義できます。 initdb は、指定しない場合、ブートストラップ方法として使用されます。詳細については、ドキュメントのBootstrapページを参照してください。

登場場所:

Field

Description

Required

Default

Validation

initdb _ BootstrapInitDB _

initdbを介してクラスターをブートストラップする

recovery _ BootstrapRecovery _

バックアップからクラスターをブートストラップする

pg_basebackup _ BootstrapPgBaseBackup _

別の互換性のあるPostgreSQLインスタンスの物理バックアップを取得してクラスターをブートストラップする

BootstrapInitDB

BootstrapInitDBは、initdbが使用される場合のブートストラッププロセスの構成です。詳細については、ドキュメントのBootstrapページを参照してください。

登場場所:

Field

Description

Required

Default

Validation

database _string_

アプリケーションが使用するデータベースの名前。デフォルト`app`

owner _string_

アプリケーションが使用するインスタンス内のデータベースの所有者の名前。 `database`キーの値のデフォルト。

secret _ LocalObjectReference _

ユーザーデータベースの所有者の初期資格情報を含むシークレットの名前。空の場合、新しいシークレットが最初から作成されます

options _string array_

クラスターの作成時にinitdbに渡す必要があるオプションのリスト。　非推奨これは、一貫性のない構成を引き起こす可能性があります。代わりに明示的に提供されたパラメーターを使用してください。　定義されている場合、明示的な値は無視されます。

dataChecksums _boolean_

-k`オプションをinitdbに渡し、データページのチェックサムを有効にするかどうかデフォルト`false

encoding _string_

initdbのオプション`--encoding`として渡される値デフォルト`UTF8`

localeCollate _string_

initdbのオプション`--lc-collate`として渡される値デフォルト`C`

localeCType _string_

initdbのオプション`--lc-ctype`として渡される値デフォルト`C`

locale _string_

新しいデータベースにデフォルトの照合順序と文字分類を設定します。

localeProvider _string_

このオプションは、新しいクラスターで作成されるデータベースのロケールプロバイダーを設定します。　PostgreSQL 16から利用できます。

icuLocale _string_

ICUプロバイダーを使用する場合に、ICUロケールを指定します。　このオプションでは、 `localeProvider`を`icu`に設定する必要があります。　PostgreSQL 15から利用できます。

icuRules _string_

追加の照合ルールを指定して、デフォルトの照合順序の動作をカスタマイズします。　このオプションでは、 `localeProvider`を`icu`に設定する必要があります。　PostgreSQL 16から利用できます。

builtinLocale _string_

ビルトインプロバイダーを使用する場合にロケール名を指定します。　このオプションでは、 `localeProvider`を`builtin`に設定する必要があります。　PostgreSQL 17から利用できます。

walSegmentSize _integer_

initdbの`--wal-segsize`オプションに渡されるメガバイト単位の値1〜1024デフォルト空、PostgreSQLのデフォルト16MBになります

Maximum: 1024 　Minimum: 1

postInitSQL _string array_

クラスターが作成された直後に`postgres`データベースでスーパーユーザーとして実行されるSQLクエリーのリスト - 細心の注意を払って使用しますデフォルトでは空

postInitApplicationSQL _string array_

クラスターが作成された直後にアプリケーションデータベースでスーパーユーザーとして実行されるSQLクエリーのリスト - 細心の注意を払って使用しますデフォルトでは空

postInitTemplateSQL _string array_

クラスターが作成された直後に`template1`データベースでスーパーユーザーとして実行されるSQLクエリーのリスト - 細心の注意を払って使用しますデフォルトでは空

import _ Import _

論理バックアップ `pg_dump`および`pg_restore`を使用して、既存のPostgreSQL インスタンスからデータをインポートすることにより、新しいクラスターをブートストラップします

postInitApplicationSQLRefs _ SQLRefs _

クラスターが作成された直後にアプリケーションデータベースでスーパーユーザーとして実行されるSQLファイルを含むConfigMapまたはSecretへの参照のリスト。参照は特定の順序で処理されます。最初にすべてのシークレットが処理され、次にすべてのConfigMapが処理されます。各グループ内での処理順序は、それぞれの配列で指定されたシーケンスに従います。デフォルトでは空

postInitTemplateSQLRefs _ SQLRefs _

クラスターが作成された直後に`template1`データベースでスーパーユーザーとして実行されるSQLファイルを含むConfigMapまたはSecretへの参照のリスト。参照は特定の順序で処理されます。最初にすべてのシークレットが処理され、次にすべてのConfigMapが処理されます。各グループ内での処理順序は、それぞれの配列で指定されたシーケンスに従います。デフォルトでは空

postInitSQLRefs _ SQLRefs _

クラスターが作成された直後に`postgres`データベースでスーパーユーザーとして実行されるSQLファイルを含むConfigMapまたはSecretへの参照のリスト。参照は特定の順序で処理されます。最初にすべてのシークレットが処理され、次にすべてのConfigMapが処理されます。各グループ内での処理順序は、それぞれの配列で指定されたシーケンスに従います。デフォルトでは空

BootstrapPgBaseBackup

BootstrapPgBaseBackupには、既存のPostgreSQLクラスターの物理バックアップを取得するために必要な構成が含まれています

登場場所:

Field

Description

Required

Default

Validation

source _string_

物理的バックアップを取得する必要があるサーバーの名前

True

MinLength: 1

database _string_

アプリケーションが使用するデータベースの名前。デフォルト`app`

owner _string_

アプリケーションが使用するインスタンス内のデータベースの所有者の名前。 `database`キーの値のデフォルト。

secret _ LocalObjectReference _

ユーザーデータベースの所有者の初期資格情報を含むシークレットの名前。空の場合、新しいシークレットが最初から作成されます

BootstrapRecovery

BootstrapRecoveryには、外部クラスター、ボリュームスナップショット、またはバックアップオブジェクトの3つの方法論を使用して既存のクラスターから復元するために必要な構成が含まれています。フルリカバリーとポイントインタイムリカバリーがサポートされています。この方法は、継続的リカバリーのクラスターレプリカクラスターを作成するために使用することもでき、次の場合にカスケードレプリケーションをサポートします instances >

  1. クラスターがリカバリーを終了すると、スーパーユーザーのパスワードは、提供されたシークレットを介して変更されます。詳細については、ドキュメントのBootstrapページを参照してください。

登場場所:

Field

Description

Required

Default

Validation

backup _ BackupSource _

リカバリ手順を開始する物理ベースバックアップを含むバックアップオブジェクト。　`source`および`volumeSnapshots`と相互排他的。

source _string_

バックアップを復元する外部クラスター。これは、バックアップが保存されるフォルダーの名前としても使用されるため、ソースクラスターの名前に設定する必要があります `backup`と相互排他的。

volumeSnapshots _ DataSource _

リカバリ手順を開始する静的PVCデータソース。現在、既存のPVCグループをマッピングする`VolumeSnapshot` および`PersistentVolumeClaim`リソースをサポートしており、CloudNativePGと互換性があり、フェンスされたPostgresインスタンスのコールドバックアップコピーで撮影されます制限 将来的にオンラインバックアップが実装されるときに削除されます。　`backup`と相互排他的。

recoveryTarget _ RecoveryTarget _

デフォルトでは、復旧プロセスは、アーカイブ内の使用可能なすべてのWALファイルを適用します完全なリカバリー。ただし、一貫した状態に到達するとすぐにリカバリーを終了するか、PostgreSQLで予想されるように`RecoveryTarget`オブジェクトを指定してポイントインタイムPITRにリカバリーすることもできます。つまり、タイムスタンプ、トランザクションID、LSN、.. .)。　詳細 https://www.postgresql.org/docs/current/runtime-config-wal.html#RUNTIME-CONFIG-WAL-RECOVERY-TARGET

database _string_

アプリケーションが使用するデータベースの名前。デフォルト`app`

owner _string_

アプリケーションが使用するインスタンス内のデータベースの所有者の名前。 `database`キーの値のデフォルト。

secret _ LocalObjectReference _

ユーザーデータベースの所有者の初期資格情報を含むシークレットの名前。空の場合、新しいシークレットが最初から作成されます

CatalogImage

CatalogImageはイメージとメジャーバージョンを定義します

登場場所:

Field

Description

Required

Default

Validation

image _string_

画像参照

True

major _integer_

イメージのPostgreSQLメジャーバージョン。カタログ内で一意である必要があります。

True

Minimum: 10

CertificatesConfiguration

CertificatesConfigurationには、サーバー証明書を処理するために必要な構成が含まれています。

登場場所:

Field

Description

Required

Default

Validation

serverCASecret _string_

Server CA証明書を含むシークレット。定義されていない場合、自己署名CAで新しいシークレットが作成され、TLS証明書ServerTLSSecretの生成に使用されます。　　含まれるもの - ca.crt サーバー証明書の検証に使用するCA。クライアント接続文字列で`sslrootcert`として使用されます。　- ca.key サーバーSSL証明書の生成に使用されるキー。ServerTLSSecretが提供されている場合、これは省略できます。

serverTLSSecret _string_

サーバーTLS証明書とキーを含むkubernetes.io/tlsタイプのシークレット。クライアントがpostgresに安全に接続できるように`ssl_cert_file`および`ssl_key_file`として設定されます。　定義されていない場合、ServerCASecretは`ca.key`も提供する必要があり、新しいシークレットは提供されたCAを使用して作成されます。

replicationTLSSecret _string_

`streaming_replica`ユーザーとして認証するクライアント証明書を含むkubernetes.io/tlsタイプのシークレット。　定義されていない場合、 ClientCASecretは`ca.key`も提供する必要があり、新しいシークレットは、提供されたCAを使用して作成されます。

clientCASecret _string_

クライアントCA証明書を含むシークレット。定義されていない場合、自己署名CAで新しいシークレットが作成され、すべてのクライアント証明書を生成するために使用されます。　　以下が含まれます - ca.crt クライアントを検証するために使用するCA証明書。すべてのインスタンスの`ssl_ca_file`として使用されます。　- ca.key クライアント証明書の生成に使用されるキー。ReplicationTLSSecretが提供されている場合、これは省略できます。

serverAltDNSNames _string array_

必要に応じて、生成されたサーバーTLS証明書に追加されるサーバー代替DNS名のリスト。

CertificatesStatus

CertificatesStatusには、構成証明書と関連する有効期限が含まれています。

登場場所:

Field

Description

Required

Default

Validation

serverCASecret _string_

Server CA証明書を含むシークレット。定義されていない場合、自己署名CAで新しいシークレットが作成され、TLS証明書ServerTLSSecretの生成に使用されます。　　含まれるもの - ca.crt サーバー証明書の検証に使用するCA。クライアント接続文字列で`sslrootcert`として使用されます。　- ca.key サーバーSSL証明書の生成に使用されるキー。ServerTLSSecretが提供されている場合、これは省略できます。

serverTLSSecret _string_

サーバーTLS証明書とキーを含むkubernetes.io/tlsタイプのシークレット。クライアントがpostgresに安全に接続できるように`ssl_cert_file`および`ssl_key_file`として設定されます。　定義されていない場合、ServerCASecretは`ca.key`も提供する必要があり、新しいシークレットは提供されたCAを使用して作成されます。

replicationTLSSecret _string_

`streaming_replica`ユーザーとして認証するクライアント証明書を含むkubernetes.io/tlsタイプのシークレット。　定義されていない場合、 ClientCASecretは`ca.key`も提供する必要があり、新しいシークレットは、提供されたCAを使用して作成されます。

clientCASecret _string_

クライアントCA証明書を含むシークレット。定義されていない場合、自己署名CAで新しいシークレットが作成され、すべてのクライアント証明書を生成するために使用されます。　　以下が含まれます - ca.crt クライアントを検証するために使用するCA証明書。すべてのインスタンスの`ssl_ca_file`として使用されます。　- ca.key クライアント証明書の生成に使用されるキー。ReplicationTLSSecretが提供されている場合、これは省略できます。

serverAltDNSNames _string array_

必要に応じて、生成されたサーバーTLS証明書に追加されるサーバー代替DNS名のリスト。

expirations _object (keys:string, values:string)_

すべての証明書の有効期限。

Cluster

クラスターは、CloudNativePGによって管理される高可用性のPostgreSQLデータベースクラスターのAPIスキーマを定義します。

Field

Description

Required

Default

Validation

apiVersion _string_

postgresql.cnpg.io/v1

True

kind _string_

Cluster

True

metadata _ EmbeddedObjectMetadata _

`metadata`のフィールドについては、Kubernetes APIドキュメントを参照してください。

True

spec _ ClusterSpec _

クラスターの目的の動作の仕様。　詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

True

status _ ClusterStatus _

最近観察されたクラスターのステータス。このデータは最新でない場合があります。システムによって設定されます。読み取り専用。　詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

ClusterImageCatalog

ClusterImageCatalogは、 clusterimagecatalogs APIのスキーマです

Field

Description

Required

Default

Validation

apiVersion _string_

postgresql.cnpg.io/v1

True

kind _string_

ClusterImageCatalog

True

metadata _ EmbeddedObjectMetadata _

`metadata`のフィールドについては、Kubernetes APIドキュメントを参照してください。

True

spec _ ImageCatalogSpec _

ClusterImageCatalogの目的の動作の仕様。　詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

True

ClusterMonitoringTLSConfiguration

ClusterMonitoringTLSConfigurationは、クラスターのモニタリングのTLS構成を含むタイプです

登場場所:

Field

Description

Required

Default

Validation

enabled _boolean_

監視エンドポイントのTLSを有効にします。　このオプションを変更すると、すべてのインスタンスのロールアウトが強制されます。

false

ClusterSpec

ClusterSpecは、CloudNativePGによって管理されるPostgreSQLクラスターの望ましい状態を定義します。

登場場所:

Field

Description

Required

Default

Validation

description _string_

このPostgreSQLクラスターの説明

inheritedMetadata _ EmbeddedObjectMetadata _

クラスターに関連するすべてのオブジェクトが継承するメタデータ

imageName _string_

タグ`<image>:<tag>`と決定論的で反復可能な展開のダイジェスト`<image>:<tag>@sha256:<digestValue>`の両方をサポートするコンテナイメージの名前

imageCatalogRef _ ImageCatalogRef _

イメージカタログ内で使用するPostgreSQLのメジャーバージョンを定義します

imagePullPolicy _ PullPolicy _

イメージプルポリシー。　Always、`Never`または`IfNotPresent`のいずれか。　定義されていない場合、デフォルトの`IfNotPresent`が使用されます。　更新できません。　詳細 https://kubernetes.io/docs/concepts/containers/images#updating-images

schedulerName _string_

指定した場合、ポッドは指定されたKubernetes スケジューラーによってディスパッチされます。指定しない場合、ポッドはデフォルトのスケジューラーによってディスパッチされます。詳細 https://kubernetes.io/docs/concepts/scheduling-eviction/kube-scheduler/

postgresUID _integer_

画像内の`postgres`ユーザーのUID、デフォルトは`26`

26

postgresGID _integer_

画像内の`postgres`ユーザーのGID、デフォルトは`26`

26

instances _integer_

クラスターで必要なインスタンスの数

True

1

Minimum: 1

minSyncReplicas _integer_

プライマリとの同期レプリケーションで必要なインスタンスの最小数。未定義または0では、スタンバイが使用できない場合に書き込みを完了できます。

0

Minimum: 0

maxSyncReplicas _integer_

同期レプリケーションクォーラムのターゲット値、準備ができているスタンバイの数がこれよりも低い場合、削減できます。　未定義または0は、同期レプリケーションを無効にします。

0

Minimum: 0

postgresql _ PostgresConfiguration _

PostgreSQLサーバーの構成

replicationSlots _ ReplicationSlotsConfiguration _

レプリケーションスロット管理構成

{ highAvailability:map[enabled:true] }

bootstrap _ BootstrapConfiguration _

このクラスターをブートストラップする手順

replica _ ReplicaClusterConfiguration _

レプリカクラスター構成

superuserSecret _ LocalObjectReference _

スーパーユーザーのパスワードを含むシークレット。定義されていない場合、ランダムに生成されたパスワードで新しいシークレットが作成されます

enableSuperuserAccess _boolean_

このオプションが有効になっている場合、オペレーターは`SuperuserSecret` を使用して`postgres`ユーザーパスワードを更新します。シークレットが存在しない場合、オペレーターは自動的に作成します。このオプションが無効になっている場合、オペレーターは`SuperuserSecret`コンテンツを無視し、自動的に作成されたときに削除して、 `NULL`に設定して`postgres`ユーザーのパスワードを空白にします。デフォルトでは無効になっています。

false

certificates _ CertificatesConfiguration _

CAおよび関連する証明書の構成

imagePullSecrets _ LocalObjectReference array_

イメージのプルに使用されるプルシークレットのリスト

storage _ StorageConfiguration _

インスタンスのストレージの構成

serviceAccountTemplate _ ServiceAccountTemplate _

サービスアカウントの世代を構成する

walStorage _ StorageConfiguration _

PostgreSQL WALのストレージの構成書き込み先行ログ

ephemeralVolumeSource _ EphemeralVolumeSource _

Ephemeral VolumeSourceを使用すると、ユーザーはエフェメラルボリュームのソースを構成できます。

startDelay _integer_

PostgreSQLインスタンスが正常に起動するまでの秒単位の時間デフォルト3600。　起動プローブ障害しきい値は、次の式を使用してこの値から導き出されます。ceiling(startDelay / 10)。

3600

stopDelay _integer_

PostgreSQLインスタンスが正常にシャットダウンするまでに許可される時間秒デフォルト1800

1800

smartShutdownTimeout _integer_

Postgresのスマートシャットダウンが完了するために予約された時間枠を制御する秒単位の時間。　オペレーターがPostgresの高速シャットダウンを要求するための十分な時間を予約してくださいつまり stopDelay - smartShutdownTimeout 。デフォルトは180秒です。

180

switchoverDelay _integer_

プライマリPostgreSQLインスタンスが許可される秒単位の時間。スイッチオーバー中に正常にシャットダウンします。　デフォルト値は3600秒1時間です。

3600

failoverDelay _integer_

クラスター内のプライマリPostgreSQLインスタンスが異常であることが検出された後、フェールオーバーをトリガーするまでに待機する時間秒単位

0

livenessProbeTimeout _integer_

LivenessProbeTimeoutは、PostgreSQLインスタンスが許可される時間秒単位であり、livenessプローブデフォルト30に正常に応答します。　Livenessプローブの失敗しきい値は、次の式を使用してこの値から導き出されます。ceiling(livenessProbe / 10) 。

affinity _ AffinityConfiguration _

ポッドのアフィニティ/アンチアフィニティルール

topologySpreadConstraints _ TopologySpreadConstraint array_

TopologySpreadConstraintsは、指定されたトポロジ間で一致するポッドを分散する方法を指定します。　詳細情報 https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/

resources _ ResourceRequirements _

生成されたすべてのポッドのリソース要件。詳細については、 https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

ephemeralVolumesSizeLimit _ EphemeralVolumesSizeLimitConfiguration _

Ephemeral VolumesSizeLimitを使用すると、ユーザーはエフェメラル ボリュームの制限を設定できます

priorityClassName _string_

生成されたすべてのポッドで使用される優先度クラスの名前。指定されたPriorityClass が存在しない場合、ポッドはスケジュールできません。 詳細については、https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/#priorityclass を参照してください。

primaryUpdateStrategy _ PrimaryUpdateStrategy _

すべてのレプリカが正常に更新された後、ローリング更新手順中にプライマリサーバーをアップグレードするために従う展開戦略。自動化することができます unsupervised - デフォルトまたは手動`supervised`

unsupervised

Enum: [unsupervised supervised]

primaryUpdateMethod _ PrimaryUpdateMethod _

すべてのレプリカが正常に更新された後、ローリング更新手順中にプライマリサーバーをアップグレードするために従う方法。スイッチオーバー`switchover`またはインプレース`restart`-デフォルトを使用できます。　注 `switchover`を使用する場合、オペレーターはイメージ名とPostgreSQL構成パラメーターの両方を同時に変更する更新を拒否して、スイッチオーバープロセス中の構成の不一致を回避します。

restart

Enum: [switchover restart]

backup _ BackupConfiguration _

バックアップに使用される構成

nodeMaintenanceWindow _ NodeMaintenanceWindow _

Kubernetesノードのメンテナンスウィンドウを定義する

monitoring _ MonitoringConfiguration _

このクラスターの監視インフラストラクチャの構成

externalClusters _ :ref:``externalClusters` セクション<externalClusters セクション>` array_

構成で使用される外部クラスターのリスト

logLevel _string_

インスタンスのログレベル、次の値のいずれかError、Warning、infoデフォルト、debug、trace

info

Enum: [error warning info debug trace]

projectedVolumeTemplate _ ProjectedVolumeSource _

投影ボリュームを定義するために使用されるテンプレート。投影ボリュームは`/projected`ベースフォルダーの下にマウントされます

env _ EnvVar array_

Envは、 Env形式に従って、環境変数をクラスター内に作成されたポッドに渡します

envFrom _ EnvFromSource array_

EnvFromは、 EnvFromフォーマットに従って、環境変数 ソースをEnvが使用するポッドに渡します

managed _ ManagedConfiguration _

インスタンスマネージャーによって管理されるPostgreSQLの部分で使用される構成

seccompProfile _ SeccompProfile _

すべてのポッドとコンテナに適用されるSeccompプロファイル。　デフォルト`RuntimeDefault`

podSecurityContext _ archive_timeout _

クラスターのすべてのポッドに適用されるPodSecurityContextをオーバーライドします。　これは、設定されると、クラスターのオペレーターのデフォルトのPodSecurityContextをオーバーライドします。　省略すると、演算子のデフォルトが使用されます。　SecurityContextConstraintsが存在する場合、このフィールドは効果がありません。

securityContext _ archive_timeout _

クラスターのポッド内のすべてのコンテナに適用されるSecurityContextをオーバーライドします。　これは設定されると、オペレーターのデフォルトのコンテナセキュリティコンテキストをオーバーライドします。　省略すると、演算子のデフォルトが使用されます。

tablespaces _ TablespaceConfiguration array_

テーブルスペース構成

enablePDB _boolean_

クラスター内の`PodDisruptionBudget`リソースを管理します。 `true`デフォルト設定として構成されている場合、ポッド中断バジェットは、プライマリノードが終了されないように保護します。逆に、`false`に設定すると、`PodDisruptionBudget`リソースがなくなり、PostgreSQLクラスターをホストするすべてのノードのシャットダウンが許可されます。この後者の構成は、開発/ステージングの目的で使用されるPostgreSQLクラスターにお勧めします。

true

plugins _ BackupPluginConfiguration array_

プラグイン構成。対応する構成でロードされるプラグインを含む

probes _ ProbesConfiguration _

PostgreSQLポッドに注入されるプローブの構成。

ClusterStatus

ClusterStatusは、CloudNativePGによって管理されるPostgreSQLクラスターの観察された状態を定義します。

登場場所:

Field

Description

Required

Default

Validation

instances _integer_

クラスター内で検出されたPVCグループの合計数。既存のインスタンスポッドの数とは異なる場合があります。

readyInstances _integer_

クラスター内の準備ができているインスタンスの合計数。これは、準備ができているインスタンスポッドの数と同じです。

instancesStatus _object (keys: PodStatus , values:string array)_

InstancesStatusは、インスタンスがどのステータスを示します

instancesReportedState _object (keys: PodName , values: InstanceReportedState )_

最後の調整ループ中に報告されたインスタンスの状態

managedRolesStatus _ ManagedRoles _

ManchedRolesStatusは、クラスター内の管理対象ロールの状態を報告します

tablespacesStatus _ TablespaceState array_

TablespacesStatusは、クラスター内の宣言的表領域の状態をレポートします

timelineID _integer_

Postgresクラスターのタイムライン

topology _ PodTopologyLabels _

インスタンスのトポロジ。

latestGeneratedNode _integer_

最後に生成されたノードのIDノード名の衝突を回避するために使用されます

currentPrimary _string_

現在のプライマリインスタンス

targetPrimary _string_

ターゲットプライマリインスタンス、これは以前のものとは異なります、スイッチオーバーまたはフェイルオーバー中に

lastPromotionToken _string_

LastPromotionTokenは、レプリカクラスターをプロモートするために使用された最後の検証されたプロモーショントークンです

pvcCount _integer_

このクラスターによって作成されたPVCの数

jobCount _integer_

このクラスターによって作成されたジョブの数

danglingPVC _string array_

このクラスターによって作成され、ポッドに接続されていないまだ使用可能なすべてのPVCのリスト

resizingPVC _string array_

ResizingPVC条件を持つすべてのPVCのリスト。

initializingPVC _string array_

このクラスターによって初期化されているすべてのPVCのリスト

healthyPVC _string array_

ハングリングも初期化もしていないすべてのPVCのリスト

unusablePVC _string array_

別のPVCが欠落しているため使用できないすべてのPVCのリスト

writeService _string_

現在の書き込みポッド

readService _string_

読み取りポッドの現在のリスト

phase _string_

クラスターの現在のフェーズ

phaseReason _string_

現在のフェーズの理由

secretsResourceVersion _ SecretsResourceVersion _

シークレットのリソースバージョンのリスト オペレーターが管理します。ここでのすべての変更は、インスタンスマネージャーの利益のために行われ、シークレットデータが更新されます

configMapResourceVersion _ ConfigMapResourceVersion _

configmapのリソースバージョンのリスト、オペレーターによって管理されます。ここでのすべての変更は、インスタンスマネージャーの利益のために行われ、構成マップデータが更新されます

certificates _ CertificatesStatus _

CAおよび関連する証明書の構成。デフォルトで初期化されます。

firstRecoverabilityPoint _string_

最初の復旧可能ポイント。RFC3339形式の日付として保存されます。　このフィールドは、FirstRecoverabilityPointByMethodのコンテンツから計算されます。　非推奨:フィールドはバックアッププラグインに設定されていません。

firstRecoverabilityPointByMethod _object (keys: BackupMethod , values: バックアップからのポイント インタイム リカバリーPITR )_

バックアップ方法タイプごとに、RFC3339形式の日付として保存される最初の復旧可能ポイント。　非推奨:フィールドはバックアッププラグインに設定されていません。

lastSuccessfulBackup _string_

最後に成功したバックアップ、RFC3339形式の日付として保存されます。　このフィールドは、 LastSuccessfulBackupByMethodのコンテンツから計算されます。　非推奨:フィールドはバックアッププラグインに設定されていません。

lastSuccessfulBackupByMethod _object (keys: BackupMethod , values: バックアップからのポイント インタイム リカバリーPITR )_

最後に成功したバックアップ。バックアップ方法タイプごとに、RFC3339形式の日付として保存されます。　非推奨:フィールドはバックアッププラグインに設定されていません。

lastFailedBackup _string_

最後に失敗したバックアップ、RFC3339形式の日付として保存されます。　非推奨:フィールドはバックアッププラグインに設定されていません。

cloudNativePGCommitHash _string_

このオペレーターが実行しているコミットハッシュ番号

currentPrimaryTimestamp _string_

最後にプライマリへの実際の昇格が発生したタイムスタンプ

currentPrimaryFailingSinceTimestamp _string_

プライマリが異常であることが検出されたときのタイムスタンプ このフィールドは、 `.spec.failoverDelay`が設定されたとき、またはオンラインアップグレード中に報告されます

targetPrimaryTimestamp _string_

新しいプライマリの最後の要求が発生したタイムスタンプ

poolerIntegrations _ PoolerIntegrations _

クラスターを参照するプーラーに必要な統合

cloudNativePGOperatorHash _string_

オペレーターのバイナリのハッシュ

availableArchitectures _ AvailableArchitecture array_

AvailableArchitecturesは、クラスターの使用可能なアーキテクチャをレポートします

conditions _ 条件 array_

クラスターオブジェクトの条件

instanceNames _string array_

クラスター内のインスタンス名のリスト

onlineUpdateEnabled _boolean_

OnlineUpdateEnabledは、クラスター内でオンラインアップグレードが有効になっているかどうかを示します

image _string_

イメージには、ポッドが使用するイメージ名が含まれています

pgDataImageInfo _ ImageInfo _

PGDataImageInfoには、現在のデータディレクトリで実行された最新のイメージの詳細が含まれています。

pluginStatus _ PluginStatus array_

PluginStatusは、ロードされたプラグインのステータスです

switchReplicaClusterStatus _ SwitchReplicaClusterStatus _

SwitchReplicaClusterStatusは、レプリカクラスターへのスイッチのステータスです

demotionToken _string_

DemotionTokenは、データベースシステム識別子、最新のチェックポイントのTimeLineID、最新のチェックポイントのREDO場所、最新のチェックポイントのREDO WALファイル、最新のチェックポイントの時間などのpg_controldataからの情報を含むJSONトークン

systemID _string_

SystemIDは、最後に検出されたPostgreSQLのシステムIDです

ConfigMapResourceVersion

ConfigMapResourceVersionは、オペレーターが管理するシークレットのリソースバージョンです

登場場所:

Field

Description

Required

Default

Validation

metrics _object (keys:string, values:string)_

メトリックを渡すために使用されるすべての構成マップのバージョンを含むマップ。　マップキーは構成マップ名であり、マップ値はバージョンです

DataDurabilityLevel

Underlying type: string

DataDurabilityLevelは、クラスターインスタンスが使用できないときに同期レプリケーションをどれだけ厳密に適用するかを指定します。オプションはrequired またはpreferred です。

登場場所:

Field

Description

required

DataDurabilityLevelRequiredは、データの耐久性が厳密に適用されることを意味します

preferred

DataDurabilityLevelPreferredは、正常なレプリカが利用可能な場合にのみデータの耐久性が適用されることを意味します

DataSource

データソースには、既存のストレージからPostgreSQLクラスターをブートストラップするために必要な構成が含まれています

登場場所:

Field

Description

Required

Default

Validation

storage _ TypedLocalObjectReference _

インスタンスのストレージの構成

True

walStorage _ TypedLocalObjectReference _

PostgreSQL WALのストレージの構成書き込み先行ログ

tablespaceStorage _object (keys:string, values: TypedLocalObjectReference )_

PostgreSQLテーブルスペースのストレージの構成

Database

データベースはデータベースAPIのスキーマです

Field

Description

Required

Default

Validation

apiVersion _string_

postgresql.cnpg.io/v1

True

kind _string_

Database

True

metadata _ EmbeddedObjectMetadata _

`metadata`のフィールドについては、Kubernetes APIドキュメントを参照してください。

True

spec _ DatabaseSpec _

目的のデータベースの仕様。　詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

True

status _ DatabaseStatus _

最近観察されたデータベースのステータス。このデータは最新でない場合があります。システムによって設定されます。読み取り専用。　詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

DatabaseObjectSpec

DatabaseObjectSpecには、すべてのデータベースオブジェクトに共通のフィールドが含まれています

登場場所:

Field

Description

Required

Default

Validation

name _string_

オブジェクトの名前拡張子、スキーマ、FDW、サーバー

True

ensure _ EnsureOption _

データベースにオブジェクトたとえばスキーマが存在するかどうかを指定します。 `present`に設定されている場合、オブジェクトは存在しない場合に作成されます。 `absent`に設定されている場合、拡張機能/スキーマが存在する場合は削除されます。

present

Enum: [present absent]

DatabaseObjectStatus

DatabaseObjectStatusは、管理対象データベースオブジェクトのステータスです

登場場所:

Field

Description

Required

Default

Validation

name _string_

オブジェクトの名前

True

applied _boolean_

オブジェクトのTrueはデータベースに正常にインストールされました

True

message _string_

メッセージはオブジェクトリコンシリエーションメッセージです

DatabaseReclaimPolicy

Underlying type: string

DatabaseReclaimPolicyは、データベースのサポート終了のメンテナンスのポリシーを説明します。

登場場所:

Field

Description

delete

DatabaseReclaimDeleteは、データベースがその要求から解放されると、PostgreSQLクラスターから削除されることを意味します。

retain

DatabaseReclaimRetainは、管理者による手動 再利用のためにデータベースが現在のフェーズに残されることを意味します。デフォルトのポリシーはRetainです。

DatabaseRoleRef

DatabaseRoleRefは、PostgreSQL内で使用可能なロールの参照です

登場場所:

Field

Description

Required

Default

Validation

name _string_

NA

DatabaseSpec

DatabaseSpecは、 Postgresqlデータベースの仕様であり、 PostgreSQLのCREATE DATABASE 、ALTER DATABASE 、およびDROP DATABASE SQLコマンドを中心に構築されています。

登場場所:

Field

Description

Required

Default

Validation

cluster _ LocalObjectReference _

データベースをホストするPostgreSQLクラスターの名前。

True

ensure _ EnsureOption _

PostgreSQLデータベースが`present`または`absent`であることを確認します。デフォルトは「present」です。

present

Enum: [present absent]

name _string_

PostgreSQL内に作成するデータベースの名前。この設定は変更できません。

True

owner _string_

`CREATE DATABASE`の`OWNER`パラメーターにマッピングされます。　`ALTER DATABASE`の`OWNER TO`コマンドにマッピングされます。　PostgreSQL内のデータベースを所有するユーザーのロール名。

True

template _string_

`CREATE DATABASE`の`TEMPLATE`パラメーターにマッピングされます。この設定 変更はできません。このデータベースを作成するテンプレートの名前。

encoding _string_

`CREATE DATABASE`の`ENCODING`パラメーターにマッピングされます。この設定 変更はできません。データベースで使用する文字セットエンコーディング。

locale _string_

`CREATE DATABASE`の`LOCALE`パラメーターにマッピングされます。この設定 変更はできません。新しいデータベースにデフォルトの照合順序と文字 分類を設定します。

localeProvider _string_

`CREATE DATABASE`の`LOCALE_PROVIDER`パラメーターにマッピングされます。この 設定は変更できません。このオプションは、新しいクラスターで作成されるデータベースのロケールプロバイダーを設定します。 PostgreSQL 16から利用できます。

localeCollate _string_

`CREATE DATABASE`の`LC_COLLATE`パラメーターにマッピングされます。この 設定は変更できません。

localeCType _string_

`CREATE DATABASE`の`LC_CTYPE`パラメーターにマッピングされます。この設定 変更はできません。

icuLocale _string_

`CREATE DATABASE`の`ICU_LOCALE`パラメーターにマッピングされます。この 設定は変更できません。 ICU プロバイダーを使用する場合のICUロケールを指定します。このオプションでは、 `localeProvider`を`icu`に設定する必要があります。 PostgreSQL 15から利用できます。

icuRules _string_

`CREATE DATABASE`の`ICU_RULES`パラメーターにマッピングされます。この設定 変更はできません。デフォルトの照合の動作をカスタマイズする追加の照合ルールを指定します。このオプションでは、 `localeProvider`を`icu`に設定する必要があります。 PostgreSQL 16から利用できます。

builtinLocale _string_

`CREATE DATABASE`の`BUILTIN_LOCALE`パラメーターにマッピングされます。この 設定は変更できません。ビルトインプロバイダーを使用する場合にロケール名を指定します。このオプションでは、 `localeProvider`を`builtin`に設定する必要があります。 PostgreSQL 17から利用できます。

collationVersion _string_

`CREATE DATABASE`の`COLLATION_VERSION`パラメーターにマッピングされます。この 設定は変更できません。

isTemplate _boolean_

`CREATE DATABASE`および`ALTER　DATABASE`の`IS_TEMPLATE`パラメーターにマッピングされます。 trueの場合、このデータベースはテンプレートとみなされ、 `CREATEDB`特権を持つすべてのユーザーがクローンを作成できます。

allowConnections _boolean_

`CREATE DATABASE`および`ALTER DATABASE`の`ALLOW_CONNECTIONS`パラメーターにマッピングされます。 falseの場合、誰もこのデータベースに接続できません。

connectionLimit _integer_

`CREATE DATABASE`および`ALTER DATABASE`の`CONNECTION LIMIT`句にマッピングします。このデータベースへの同時接続の数。 -1デフォルトは制限なしを意味します。

tablespace _string_

`CREATE DATABASE`の`TABLESPACE`パラメーターにマッピングされます。　`ALTER DATABASE`の`SET TABLESPACE`コマンドにマッピングされます。　新しいデータベースに関連付けられるテーブルスペースPostgreSQLの名前。このテーブルスペースは、このデータベースで作成されるオブジェクトに使用されるデフォルトのテーブルスペースになります。

databaseReclaimPolicy _ DatabaseReclaimPolicy _

このデータベースのサポートが終了したメンテナンスのポリシー。

retain

Enum: [delete retain]

schemas _ SchemaSpec array_

データベースで管理するスキーマのリスト

extensions _ ExtensionSpec array_

データベースで管理する拡張機能のリスト

fdws _ FDWSpec array_

データベースで管理する外部データラッパーのリスト

servers _ ServerSpec array_

データベースで管理する外部サーバーのリスト

DatabaseStatus

DatabaseStatusは、データベースの観察された状態を定義します

登場場所:

Field

Description

Required

Default

Validation

observedGeneration _integer_

同期された最新の望ましい状態を表すシーケンス番号

applied _boolean_

データベースが正しくリコンサイルされた場合、Appliedはtrueです

message _string_

Messageはリコンシリエーション出力メッセージです

schemas _ DatabaseObjectStatus array_

Schemasは、管理対象スキーマのステータスです

extensions _ DatabaseObjectStatus array_

Extensionsは、管理対象拡張機能のステータスです

fdws _ DatabaseObjectStatus array_

FDWsは、管理対象FDWのステータスです

servers _ DatabaseObjectStatus array_

Serversは、管理対象サーバーのステータスです

EmbeddedObjectMetadata

EmbeddedObjectMetadataには、クラスターに関連するすべてのリソースによって継承されるメタデータが含まれています

登場場所:

Field

Description

Required

Default

Validation

labels _object (keys:string, values:string)_

NA

annotations _object (keys:string, values:string)_

NA

EnsureOption

Underlying type: string

EnsureOptionは、PostgreSQLインスタンスにロールの存在または不存在を強制するかどうかを表します

登場場所:

Field

Description

present

NA

absent

NA

EphemeralVolumesSizeLimitConfiguration

Ephemeral VolumesSizeLimitConfigurationには、エフェメラルストレージの構成が含まれます

登場場所:

Field

Description

Required

Default

Validation

shm _ Quantity _

Shmは、共有メモリボリュームのサイズ制限です

temporaryData _ Quantity _

TemporaryDataは、一時データボリュームのサイズ制限です

ExtensionConfiguration

ExtensionConfigurationは、PostgreSQL拡張機能をクラスターに追加するために使用される構成です。

登場場所:

Field

Description

Required

Default

Validation

name _string_

拡張機能の名前、必須

True

MinLength: 1 　Pattern: ^ :ref:`a-z0-9 <[-a-z0-9]*[a-z0-9]> ?$`

image _ ImageVolumeSource _

拡張機能を含む画像必須

True

extension_control_path _string array_

extension_control_pathに追加するイメージ内のディレクトリのリスト。　定義されていない場合、デフォルトの「/share」になります。

dynamic_library_path _string array_

Dynamic_library_pathに追加するイメージ内のディレクトリのリスト。　定義されていない場合、デフォルトの「/lib」。

ld_library_path _string array_

ld_library_pathに追加するイメージ内のディレクトリのリスト。

ExtensionSpec

ExtensionSpecはデータベースに拡張機能を構成します

登場場所:

Field

Description

Required

Default

Validation

name _string_

オブジェクトの名前拡張子、スキーマ、FDW、サーバー

True

ensure _ EnsureOption _

データベースにオブジェクトたとえばスキーマが存在するかどうかを指定します。 `present`に設定されている場合、オブジェクトは存在しない場合に作成されます。 `absent`に設定されている場合、拡張機能/スキーマが存在する場合は削除されます。

present

Enum: [present absent]

version _string_

インストールする拡張機能のバージョン。空の場合、オペレーターはデフォルトバージョン拡張機能の制御ファイルで指定されたものをインストールします

True

schema _string_

拡張機能がコンテンツを再配置できる場合、拡張機能のオブジェクトをインストールするスキーマの名前。指定されていないデフォルトデフォルト、および拡張機能の制御ファイルがスキーマを指定しない場合、現在のデフォルトのオブジェクト作成スキーマが使用されます。

True

ExternalCluster

外部クラスターは、構成の他のセクションで使用される外部クラスターへの接続パラメーターを表します

登場場所:

Field

Description

Required

Default

Validation

name _string_

サーバー名必須

True

connectionParameters _object (keys:string, values:string)_

dbname、ホスト、ユーザー名などの接続パラメーターのリスト

sslCert _ SecretKeySelector _

この インスタンスへの接続に使用されるSSL証明書への参照

sslKey _ SecretKeySelector _

このインスタンスへの接続に使用されるSSLプライベートキーへの参照

sslRootCert _ SecretKeySelector _

このインスタンスへの接続に使用されるSSL CA公開キーへの参照

password _ SecretKeySelector _

サーバーへの接続に使用されるパスワードへの参照。　パスワードが指定された場合、CloudNativePGは`/controller/external/NAME/pass`でPostgreSQL パスファイルを作成しますここで、 "NAME"はクラスターの名前です。このパスファイルは、現在のPostgreSQL `Cluster`からリモートのPostgreSQLサーバーへの接続を確立するときに、接続文字列で自動的に参照されます。これにより、外部クラスターの安全で効率的なパスワード管理が保証されます。

barmanObjectStore _ BarmanObjectStoreConfiguration _

barman-cloudツールスイートの構成

plugin _ BackupPluginConfiguration _

この外部クラスターのWALアーカイブとバックアップを処理するプラグインの構成

True

FDWSpec

FDWSpecはデータベースに外部データラッパーを構成します

登場場所:

Field

Description

Required

Default

Validation

name _string_

オブジェクトの名前拡張子、スキーマ、FDW、サーバー

True

ensure _ EnsureOption _

データベースにオブジェクトたとえばスキーマが存在するかどうかを指定します。 `present`に設定されている場合、オブジェクトは存在しない場合に作成されます。 `absent`に設定されている場合、拡張機能/スキーマが存在する場合は削除されます。

present

Enum: [present absent]

handler _string_

ハンドラーファンクションの名前たとえば、"postgres_fdw_handler"。　ハンドラーが指定されない場合、これは空になります。その場合、デフォルトのハンドラーは、FDW拡張機能が作成されるときに登録されます。

validator _string_

バリデーターファンクションの名前たとえば、"postgres_fdw_validator"。　バリデーターが指定されない場合、これは空になります。その場合、デフォルトのバリデーターは、FDW拡張機能が作成されるときに登録されます。

owner _string_

Ownerは、外部データラッパーを所有するデータベースロールを指定します。　ロールには、ターゲットデータベースにおけるスーパーユーザー権限が必要です。

options _ OptionSpec array_

Optionsは、FDWの構成オプションを指定します。

usage _ UsageSpec array_

FDWの`USAGE`特権が付与または取り消されるロールのリスト。

FailoverQuorum

FailoverQuorumには、PGクラスターの現在のフェールオーバークォーラムステータスに関する情報が含まれています。これは、プライマリノードのインスタンスマネージャーによって更新され、オペレーターによってゼロにリセットされて更新をトリガーします。

Field

Description

Required

Default

Validation

apiVersion _string_

postgresql.cnpg.io/v1

True

kind _string_

FailoverQuorum

True

metadata _ EmbeddedObjectMetadata _

`metadata`のフィールドについては、Kubernetes APIドキュメントを参照してください。

True

status _ FailoverQuorumStatus _

最近観察されたフェールオーバークォーラムのステータス。

FailoverQuorumStatus

FailoverQuorumStatusは、PGクラスターのフェールオーバークォーラムの最新の観察されたステータスです。

登場場所:

Field

Description

Required

Default

Validation

method _string_

最新に報告されたメソッド値が含まれています。

standbyNames _string array_

StandbyNamesは、同期する可能性のあるインスタンス名のリストです。

standbyNumber _integer_

StandbyNumberは、トランザクションが応答を待機する必要がある同期スタンバイの数です。

primary _string_

Primaryは、このオブジェクトを最後に更新したプライマリインスタンスの名前です。

ImageCatalog

ImageCatalogは、imagecatalogs APIのスキーマです

Field

Description

Required

Default

Validation

apiVersion _string_

postgresql.cnpg.io/v1

True

kind _string_

ImageCatalog

True

metadata _ EmbeddedObjectMetadata _

`metadata`のフィールドについては、Kubernetes APIドキュメントを参照してください。

True

spec _ ImageCatalogSpec _

ImageCatalogの目的の動作の仕様。　詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

True

ImageCatalogRef

ImageCatalogRefは、ImageCatalog内のメジャーバージョンへの参照を定義します

登場場所:

Field

Description

Required

Default

Validation

apiGroup _string_

APIGroupは、参照されるリソースのグループです。　APIGroupが指定されない場合、指定されたKindはコアAPIグループにある必要があります。　他のサードパーティタイプの場合、APIGroupが必要です。

kind _string_

Kindは、参照されるリソースのタイプです

True

name _string_

Nameは参照されるリソースの名前です

True

major _integer_

ImageCatalogから使用するPostgreSQLのメジャーバージョン

True

ImageCatalogSpec

ImageCatalogSpecは、目的のイメージカタログを定義します

登場場所:

Field

Description

Required

Default

Validation

images _ CatalogImage array_

カタログで使用可能なカタログ画像のリスト

True

MaxItems: 8 　MinItems: 1

ImageInfo

ImageInfoには、PostgreSQLイメージに関する情報が含まれています

登場場所:

Field

Description

Required

Default

Validation

image _string_

Imageはイメージ名です

True

majorVersion _integer_

MajorVersionはイメージのメジャーバージョンです

True

Import

インポートには、外部クラスターの論理スナップショットからデータベースを初期化する構成が含まれています

登場場所:

Field

Description

Required

Default

Validation

source _ ImportSource _

輸入元

True

type _ SnapshotType _

インポートタイプ。 `microservice`または`monolith`です。

True

Enum: [microservice monolith]

databases _string array_

インポートするデータベース

True

roles _string array_

インポートするロール

postImportApplicationSQL _string array_

インポートされた直後にアプリケーションデータベースでスーパーユーザーとして実行されるSQLクエリのリスト。細心の注意を払って使用されますデフォルトでは空。マイクロサービスタイプでのみ使用できます。

schemaOnly _boolean_

trueに設定されている場合、 pg_restore`の`pre-data`および`post-data`セクションのみが呼び出され、データのインポートが回避されます。デフォルト`false

pgDumpExtraOptions _string array_

`pg_dump`コマンドに渡すカスタムオプションのリスト。　重要 使用には注意してください。オペレーターはこれらのオプションを検証せず、特定のフラグは意図された機能またはデザインを妨げる可能性があります。　あなたには、提供されたオプションが環境および目的の動作と互換性があることを確認する責任があります。

pgRestoreExtraOptions _string array_

`pg_restore`コマンドに渡すカスタムオプションのリスト。　重要 使用には注意してください。オペレーターはこれらのオプションを検証せず、特定のフラグは意図された機能またはデザインを妨げる可能性があります。　あなたには、提供されたオプションが環境および目的の動作と互換性があることを確認する責任があります。

pgRestorePredataOptions _string array_

pre-data セクション中に`pg_restore`コマンドに渡すカスタムオプション。この設定は、汎用の`pgRestoreExtraOptions`値をオーバーライドします。　重要 使用には注意してください。オペレーターはこれらのオプションを検証せず、特定のフラグは意図された機能またはデザインを妨げる可能性があります。　あなたには、提供されたオプションが環境および目的の動作と互換性があることを確認する責任があります。

pgRestoreDataOptions _string array_

data セクション中に`pg_restore`コマンドに渡すカスタムオプション。この設定は、汎用の`pgRestoreExtraOptions`値をオーバーライドします。　重要 使用には注意してください。オペレーターはこれらのオプションを検証せず、特定のフラグは意図された機能またはデザインを妨げる可能性があります。　あなたには、提供されたオプションが環境および目的の動作と互換性があることを確認する責任があります。

pgRestorePostdataOptions _string array_

post-data セクション中に`pg_restore`コマンドに渡すカスタムオプション。この設定は、汎用の`pgRestoreExtraOptions`値をオーバーライドします。　重要 使用には注意してください。オペレーターはこれらのオプションを検証せず、特定のフラグは意図された機能またはデザインを妨げる可能性があります。　あなたには、提供されたオプションが環境および目的の動作と互換性があることを確認する責任があります。

ImportSource

ImportSourceは、論理スナップショットのソースを説明します

登場場所:

Field

Description

Required

Default

Validation

externalCluster _string_

インポートに使用される外部クラスターの名前

True

InstanceID

InstanceIDには、インスタンスを識別する情報が含まれます

登場場所:

Field

Description

Required

Default

Validation

podName _string_

ポッド名

ContainerID _string_

コンテナID

InstanceReportedState

InstanceReportedStateは、調整ループ中に最後に報告されたインスタンスの状態を説明します

登場場所:

Field

Description

Required

Default

Validation

isPrimary _boolean_

インスタンスがプライマリかどうかを示します

True

timeLineID _integer_

インスタンスがどのTimelineIdにあるかを示します

ip _string_

インスタンスのIPアドレス

True

IsolationCheckConfiguration

IsolationCheckConfigurationには、livenessプローブの分離チェック機能の構成が含まれています

登場場所:

Field

Description

Required

Default

Validation

enabled _boolean_

livenessプローブのプライマリ分離チェックが有効になっているかどうか

true

requestTimeout _integer_

プライマリ分離チェック中の要求のミリ秒単位のタイムアウト

1000

connectionTimeout _integer_

プライマリ分離チェック中の接続のミリ秒単位のタイムアウト

1000

LDAPBindAsAuth

LDAPBindAsAuthは、 LDAPのバインド認証を使用するための必須フィールドを提供します

登場場所:

Field

Description

Required

Default

Validation

prefix _string_

バインド認証オプションのプレフィックス

suffix _string_

バインド認証オプションのサフィックス

LDAPBindSearchAuth

LDAPBindSearchAuthは、バインド+検索LDAP認証プロセスを使用するための必須フィールドを提供します

登場場所:

Field

Description

Required

Default

Validation

baseDN _string_

ユーザー検索を開始するルートDN

bindDN _string_

ディレクトリにバインドするユーザーのDN

bindPassword _ SecretKeySelector _

ディレクトリにバインドするユーザーのパスワードを使用したシークレット

searchAttribute _string_

ユーザー名と一致する属性

searchFilter _string_

検索+バインド認証を実行するときに使用する検索フィルター

LDAPConfig

LDAPConfigには、LDAP認証に必要なパラメーターが含まれています

登場場所:

Field

Description

Required

Default

Validation

server _string_

LDAPホスト名またはIPアドレス

port _integer_

LDAPサーバーポート

scheme _ LDAPScheme _

使用するLDAPスキーマ、使用可能なオプションは`ldap`および`ldaps`です

Enum: [ldap ldaps]

bindAsAuth _ LDAPBindAsAuth _

認証構成としてバインド

bindSearchAuth _ LDAPBindSearchAuth _

バインド+サーチ認証構成

tls _boolean_

LDAP over TLSを有効にするには、 'true'に設定します。 'false'がデフォルトです

LDAPScheme

Underlying type: string

LDAPSchemeは、 LDAPの使用可能なスキームを定義します

登場場所:

Field

Description

ldap

NA

ldaps

NA

LivenessProbe

LivenessProbeはlivenessプローブの構成です

登場場所:

Field

Description

Required

Default

Validation

initialDelaySeconds _integer_

コンテナが起動してからlivenessプローブが開始されるまでの秒数。　詳細 https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

timeoutSeconds _integer_

プローブがタイムアウトになるまでの秒数。　デフォルト1秒。最小値は1です。詳細情報 https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds _integer_

プローブを実行する頻度秒単位。　デフォルト10秒。最小値は1です。

successThreshold _integer_

失敗した後に成功したとみなされるプローブの最小連続成功数。　デフォルト1。活性およびスタートアップの場合は1である必要があります。最小値は1です。

failureThreshold _integer_

成功した後に失敗したと考えられるプローブの最小連続失敗数。　デフォルト3。最小値は1です。

terminationGracePeriodSeconds _integer_

プローブが失敗したときにポッドが正常に終了する必要がある秒単位のオプションの期間。　猶予期間は、ポッドで実行されているプロセスに終了信号が送信された後の秒単位の期間、およびプロセスがkill信号で強制的に停止される時間です。　この値を、プロセスの予想されるクリーンアップ時間よりも長く設定します。　この値がnilの場合、ポッドのterminationGracePeriodSecondsが使用されます。それ以外の場合、この値はポッド仕様で提供される値をオーバーライドします。　値は負でない整数である必要があります。値0は、killシグナルを介してすぐに停止することを示しますシャットダウンの機会なし。　これはベータフィールドであり、ProbeTerminationGracePeriod機能ゲートを有効にする必要があります。　最小値は1です。未設定の場合、spec.terminationGracePeriodSecondsが使用されます。

isolationCheck _ IsolationCheckConfiguration _

プライマリ インスタンスのlivenessプローブを拡張する機能を構成します。基本的なチェックに加えて、これは、プライマリがKubernetes APIサーバーおよびそのレプリカから分離されているかどうかを検証し、ネットワークパーティションまたはAPIの使用不可が検出された場合に安全にシャットダウンできることを保証します。デフォルトで有効になっています。

ManagedConfiguration

ManageConfigurationは、インスタンスマネージャーによって管理されるPostgreSQLの部分を表します

登場場所:

Field

Description

Required

Default

Validation

roles _ RoleConfiguration array_

`Cluster`によって管理されるデータベースロール

services _ ManagedServices _

`Cluster`によって管理されるサービスロール

ManagedRoles

ManageRolesは、クラスターの管理対象ロールのステータスを追跡します

登場場所:

Field

Description

Required

Default

Validation

byStatus _object (keys: RoleStatus , values:string array)_

ByStatusは、各状態のロールのリストを提供します

cannotReconcile _object (keys:string, values:string array)_

CannotReconcileは、PostgreSQLでリコンサイルできないロールをリストし、原因の説明を示します

passwordStatus _object (keys:string, values: PasswordState )_

PasswordStatusは、各管理対象ロールの最後のトランザクションIDとパスワードのシークレットバージョンを提供します

ManagedService

ManchedServiceは、クラスターによって管理される特定のサービスを表します。これには、サービスの種類とそれに関連するテンプレート仕様が含まれます。

登場場所:

Field

Description

Required

Default

Validation

selectorType _ ServiceSelectorType _

SelectorTypeは、サービスが持つセレクターのタイプを指定します。　有効な値は「rw」、「r」、および「ro」で、読み取り書き込み、読み取り、および読み取り専用サービスを表します。

True

Enum: [rw r ro]

updateStrategy _ ServiceUpdateStrategy _

UpdateStrategyは、サービスの違いを調整する方法を説明します

patch

Enum: [patch replace]

serviceTemplate _ ServiceTemplateSpec _

ServiceTemplateは、サービスのテンプレート仕様です。

True

ManagedServices

ManagedServicesは、クラスターによって管理されるサービスを表します。

登場場所:

Field

Description

Required

Default

Validation

disabledDefaultServices _ ServiceSelectorType array_

DisabledDefaultServicesは、デフォルトで無効になっているサービスタイプのリストです。　有効な値は「r」および「ro」で、読み取りおよび読み取り専用サービスを表します。

Enum: [rw r ro]

additional _ ManagedService array_

Additionalは、ユーザーが指定した追加の管理サービスのリストです。

Metadata

メタデータはmetav1.ObjectMetaに似た構造ですが、controller-genによって解析され、ユーザーに適切なCRDを作成できます。 PodTemplateSpecのコメントには、コアデータ型を使用しない理由の説明があります。

登場場所:

Field

Description

Required

Default

Validation

name _string_

リソースの名前。特定のタイプでのみサポートされています

labels _object (keys:string, values:string)_

オブジェクトを整理および分類するために使用できる文字列キーと値のマップスコープと選択。レプリケーションコントローラとサービスのセレクターと一致する場合があります。　詳細 http://kubernetes.io/docs/user-guide/labels

annotations _object (keys:string, values:string)_

アノテーションは、リソースとともに保存される非構造化キー値マップであり、任意のメタデータを保存および取得するように外部ツールによって設定される場合があります。これらは照会可能ではなく、オブジェクトを変更するときに保存する必要があります。　詳細 http://kubernetes.io/docs/user-guide/annotations

MonitoringConfiguration

MonitoringConfigurationは、特定のクラスターのすべての監視構成を含むタイプです

登場場所:

Field

Description

Required

Default

Validation

disableDefaultQueries _boolean_

デフォルトのクエリーを挿入するかどうか。　クラスターにデフォルトのクエリーを挿入したくない場合は、`true`に設定します。　デフォルトfalse。

false

customQueriesConfigMap _ ConfigMapKeySelector array_

カスタムクエリを含む構成マップのリスト

customQueriesSecret _ SecretKeySelector array_

カスタムクエリーを含むシークレットのリスト

enablePodMonitor _boolean_

`PodMonitor`を有効または無効にする 非推奨 この機能は、今後のリリースで削除される予定です。この機能が必要な場合は、PodMonitorを手動で作成できます。

false

tls _ ClusterMonitoringTLSConfiguration _

メトリックエンドポイントのTLS通信を構成します。　tls.enabledオプションを変更すると、すべてのインスタンスのロールアウトが強制されます。

podMonitorMetricRelabelings _ archive_timeout array_

`PodMonitor`のメトリックの再ラベル付けのリスト。摂取する前にサンプルに適用されます。　非推奨この機能は、今後のリリースで削除される予定です。この機能が必要な場合は、PodMonitorを手動で作成できます。

podMonitorRelabelings _ archive_timeout array_

`PodMonitor`の再ラベル付けのリスト。スクレイピングの前にサンプルに適用されます。　非推奨この機能は、今後のリリースで削除される予定です。この機能が必要な場合は、PodMonitorを手動で作成できます。

metricsQueriesTTL _ Duration _

クエリから計算されたメトリックが最新であると考えられる間隔。　それを超えると、新しいスクレイピングがクエリの再実行 をトリガーします。　設定されていない場合、Prometheusスクレイピングのデフォルトに合わせて、デフォルトの30秒になります。　これをゼロに設定すると、キャッシュメカニズムが無効になり、PostgreSQLサーバーに高負荷が発生する可能性があります。

NodeMaintenanceWindow

NodeMaintenanceWindowには、基になるノードのアップグレード中にオペレーターが使用する情報が含まれています。

このオプションは、選択したストレージがポッドをノード間で自由に移動できない場合にのみ役立ちます。

登場場所:

Field

Description

Required

Default

Validation

reusePVC _boolean_

既存のPVCを再利用するノードが再びアップするまで待機するかどうか他の場所で再作成します- instances >1の場合

true

inProgress _boolean_

進行中のノードのメンテナンスアクティビティはありますか?

false

OnlineConfiguration

OnlineConfigurationには、オンラインボリュームスナップショットの構成パラメーターが含まれています

登場場所:

Field

Description

Required

Default

Validation

waitForArchive _boolean_

falseの場合、ファンクションは、バックアップが完了すると、WALがアーカイブされるのを待たずに、すぐに返されます。　この動作は、WALアーカイブを個別に監視するバックアップソフトウェアでのみ役立ちます。　そうしないと、バックアップの一貫性を保つために必要なWALが欠落し、バックアップが役に立たなくなる可能性があります。　デフォルトでは、またはこのパラメータがtrueの場合、アーカイブが有効になっている場合、pg_backup_stopはWALがアーカイブされるまで待機します。　スタンバイでは、これはarchive_mode = Alwaysの場合にのみ待機することを意味します。　プライマリの書き込みアクティビティが低い場合、即時セグメントスイッチをトリガーするためにプライマリでpg_switch_walを実行すると役立つ場合があります。

true

immediateCheckpoint _boolean_

PostgreSQLサーバーの`checkpoint_completion_target`設定に従って、バックアップの初期チェックポイントのI/Oワークロードを制限するかどうかを制御します。 trueに設定されている場合、即時チェックポイントが使用されます。つまり、 PostgreSQLはできるだけ早くチェックポイントを完了します。デフォルトでは`false`。

OptionSpec

OptionSpecは、オプションの名前、値、保証フィールドを保持します

登場場所:

Field

Description

Required

Default

Validation

name _string_

オプションの名前

True

value _string_

オプションの値

True

ensure _ EnsureOption _

データベースにオプションが存在するかどうかを指定します。 `present`に設定されている場合、オプションは存在しない場合に作成されます。 `absent`に設定されている場合、オプションが存在する場合は削除されます。

present

Enum: [present absent]

PasswordState

PasswordStateは、管理対象ロール構成のパスワードの状態を表します

登場場所:

Field

Description

Required

Default

Validation

transactionID _integer_

PostgreSQLのロール定義に影響を与える最後のトランザクションID

resourceVersion _string_

パスワードシークレットのリソースバージョン

PgBouncerIntegrationStatus

PgBouncerIntegrationStatusは、クラスターを参照するpgbouncerプーラーに必要な統合をカプセル化します

登場場所:

Field

Description

Required

Default

Validation

secrets _string array_

NA

PgBouncerPoolMode

Underlying type: string

PgBouncerPoolModeはPgBouncerのモードです

検証

  • 列挙型 [セッショントランザクション]

登場場所:

PgBouncerSecrets

PgBouncerSecretsには、pgbouncerが使用するシークレットのバージョンが含まれています

登場場所:

Field

Description

Required

Default

Validation

authQuery _ SecretVersion _

認証クエリーのシークレットバージョン

PgBouncerSpec

PgBouncerSpecは、PgBouncerの構成方法を定義します

登場場所:

Field

Description

Required

Default

Validation

poolMode _ PgBouncerPoolMode _

プールモード。デフォルト`session`

session

Enum: [session transaction]

serverTLSSecret _ LocalObjectReference _

ServerTLSSecretは、TLSシークレットを指す場合、PostgreSQLに対して認証するときに使用されるpgbouncerの`server_tls_key_file`および`server_tls_cert_file`を提供します。

serverCASecret _ LocalObjectReference _

ServerCASecretは、PgBouncerのserver_tls_ca_file、PostgreSQL証明書を検証するためのルートCAを提供します

clientCASecret _ LocalObjectReference _

ClientCASecretは、PgBouncerのclient_tls_ca_file、クライアントを検証するためのルートCAを提供します証明書

clientTLSSecret _ LocalObjectReference _

ClientTLSSecretは、クライアントを受け入れるために使用されるPgBouncerのclient_tls_key_fileプライベートキーとclient_tls_cert_file証明書を提供します

authQuerySecret _ LocalObjectReference _

認証 クエリーに使用する必要があるユーザーの資格情報。指定される場合、 AuthQuery 例、 "SELECT usename, passwd FROM pg_catalog.pg_shadow WHERE usename=$1" を指定する必要があり、自動CNPGクラスター統合はトリガーされません。　非推奨。

authQuery _string_

特定のユーザーのパスワードのハッシュをダウンロードするために使用されるクエリー。デフォルト「SELECT usename, passwd FROM public.user_search($1)」。　指定される場合、AuthQuerySecretも指定する必要があり、自動CNPGクラスター統合はトリガーされません。

parameters _object (keys:string, values:string)_

PgBouncerに渡される追加パラメーター - 構成可能なオプションのリストについては、CNPGドキュメントを確認してください

pg_hba _string array_

PostgreSQLホストベースの認証ルールpg_hba.confファイルに追加する行

paused _boolean_

`true`に設定すると、PgBouncerはPostgreSQLサーバーから切断し、最初にすべてのクエリが完了するのを待機し、この値が`false`デフォルトに設定されるまで、すべての新しいクライアント接続を一時停止します。内部的には、オペレーターはPgBouncerの`PAUSE`および`RESUME`コマンドを呼び出します。

false

PluginConfiguration

PluginConfigurationは、このクラスターをリコンサイルするためにロードする必要があるプラグインを指定します

登場場所:

  • ClusterSpec

  • :ref:``externalClusters` セクション <externalClusters セクション>`

Field

Description

Required

Default

Validation

name _string_

Nameはプラグイン名です

True

enabled _boolean_

このプラグインを使用する場合、 Enabledはtrue

true

isWALArchiver _boolean_

プラグインをWALアーカイバーとしてマークします。最大で1つのプラグインをWALアーカイバーとして指定できます。 `.spec.backup.barmanObjectStore`構成が存在する場合、これは有効にできません。

false

parameters _object (keys:string, values:string)_

Parametersはプラグインの構成です

PluginStatus

PluginStatusは、ロードされたプラグインのステータスです

登場場所:

Field

Description

Required

Default

Validation

name _string_

Nameはプラグインの名前です

True

version _string_

バージョンは、最新の調整ループによってロードされたプラグインのバージョンです。

True

capabilities _string array_

Capabilitiesは、プラグインの機能のリストです。

operatorCapabilities _string array_

OperatorCapabilitiesは、リコンサイラーに関するプラグインの機能のリストです。

walCapabilities _string array_

WALCapabilitiesは、WAL管理に関するプラグインの機能のリストです。

backupCapabilities _string array_

BackupCapabilitiesは、バックアップ管理に関するプラグインの機能のリストです。

restoreJobHookCapabilities _string array_

RestoreJobHookCapabilitiesは、 RestoreJobHook管理に関するプラグインの機能のリストです。

status _string_

ステータスには、 SetStatusInClusterインターフェイスを介してプラグインによって報告されたステータスが含まれます

PodName

Underlying type: string

PodNameはポッドの名前です

登場場所:

PodStatus

Underlying type: string

PodStatusは、ポッドの考えられるステータスを表します

登場場所:

PodTemplateSpec

PodTemplateSpecは、ユーザーがPod生成のテンプレートを設定できる構造です。

残念ながら、生成されたCRDにはメタデータセクションのフィールドが含まれないため、 corev1.PodTemplateSpecタイプは使用できません。

参考 https://github.com/kubernetes-sigs/controller-tools/issues/385 https://github.com/kubernetes-sigs/controller-tools/issues/448 https://github.com/prometheus- Operator/prometheus-operator/issues/3041

登場場所:

Field

Description

Required

Default

Validation

metadata _ EmbeddedObjectMetadata _

`metadata`のフィールドについては、Kubernetes APIドキュメントを参照してください。

spec _ PodSpec _

ポッドの目的の動作の仕様。　詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

PodTopologyLabels

基になるタイプ object

PodTopologyLabelsは、ポッドのトポロジを表します。 map[labelName]labelValue

登場場所:

Pooler

Poolerは、プーラーAPIのスキーマです

Field

Description

Required

Default

Validation

apiVersion _string_

postgresql.cnpg.io/v1

True

kind _string_

Pooler

True

metadata _ EmbeddedObjectMetadata _

`metadata`のフィールドについては、Kubernetes APIドキュメントを参照してください。

True

spec _ PoolerSpec _

プーラーの目的の動作の仕様。　詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

True

status _ PoolerStatus _

プーラーの最近観察されたステータス。このデータは最新でない場合があります。システムによって設定されます。読み取り専用。　詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

PoolerIntegrations

PoolerIntegrationsは、クラスターを参照するプーラーに必要な統合をカプセル化します

登場場所:

Field

Description

Required

Default

Validation

pgBouncerIntegration _ PgBouncerIntegrationStatus _

NA

PoolerMonitoringConfiguration

PoolerMonitoringConfigurationは、特定のプーラーのすべての監視構成を含むタイプです。

クラスターのモニタリング構成をミラーしますが、今のところカスタムクエリ部分はありません。

登場場所:

Field

Description

Required

Default

Validation

enablePodMonitor _boolean_

`PodMonitor`を有効または無効にします

false

podMonitorMetricRelabelings _ archive_timeout array_

`PodMonitor`のメトリックの再ラベル付けのリスト。摂取する前にサンプルに適用されます。

podMonitorRelabelings _ archive_timeout array_

`PodMonitor`の再ラベル付けのリスト。スクレイピングの前にサンプルに適用されます。

PoolerSecrets

PoolerSecretsには、使用されるすべてのシークレットのバージョンが含まれています

登場場所:

Field

Description

Required

Default

Validation

clientTLS _ SecretVersion _

クライアントTLSシークレットバージョン

serverTLS _ SecretVersion _

サーバーTLSシークレットバージョン

serverCA _ SecretVersion _

サーバーCAシークレットバージョン

clientCA _ SecretVersion _

クライアントCAシークレットバージョン

pgBouncerSecrets _ PgBouncerSecrets _

PgBouncerが使用するシークレットのバージョン

PoolerSpec

PoolerSpecは、プーラーの目的の状態を定義します

登場場所:

Field

Description

Required

Default

Validation

cluster _ LocalObjectReference _

これは、プーラーが動作するクラスター参照です。　プール名は、同じ名前空間内のクラスター名と決して一致しないはずです。

True

type _ PoolerType _

トラフィックの転送先のサービスの種類。デフォルト`rw`

rw

Enum: [rw ro r]

instances _integer_

必要なレプリカの数。デフォルト1

1

template _ PodTemplateSpec _

作成するPodのテンプレート

pgbouncer _ PgBouncerSpec _

PgBouncer構成

True

deploymentStrategy _ DeploymentStrategy _

pgbouncerで既存のポッドを新しいポッドに置き換えるために使用する展開戦略

monitoring _ PoolerMonitoringConfiguration _

このプーラーの監視インフラストラクチャの構成。　非推奨この機能は、今後のリリースで削除される予定です。この機能が必要な場合は、PodMonitorを手動で作成できます。

serviceTemplate _ ServiceTemplateSpec _

作成するサービスのテンプレート

PoolerStatus

PoolerStatusは、プーラーの観察された状態を定義します

登場場所:

Field

Description

Required

Default

Validation

secrets _ PoolerSecrets _

configオブジェクトのリソースバージョン

instances _integer_

スケジュールしようとしているポッドの数

PoolerType

Underlying type: string

PoolerTypeは接続プールのタイプ、つまりターゲットとしているサービスを意味します。使用できる値はrw およびro です。

検証

  • 列挙型 [rw ro r]

登場場所:

PostgresConfiguration

PostgresConfigurationはPostgreSQL構成を定義します

登場場所:

Field

Description

Required

Default

Validation

parameters _object (keys:string, values:string)_

PostgreSQL構成オプションpostgresql.conf

synchronous _ SynchronousReplicaConfiguration _

PostgreSQL同期レプリケーション機能の構成

pg_hba _string array_

PostgreSQLホストベースの認証ルールpg_hba.confファイルに追加する行

pg_ident _string array_

PostgreSQLのユーザー名マップルールpg_ident.confファイルに追加する行

syncReplicaElectionConstraint _ SyncReplicaElectionConstraints _

同期レプリカが満たす要件。これは、 "synchronous_standby_names"パラメーターの設定方法に影響します。

shared_preload_libraries _string array_

デフォルトのライブラリに追加する共有プリロードライブラリのリスト

ldap _ LDAPConfig _

LDAP構成を指定するオプション

promotionTimeout _integer_

インスタンスをプライマリに昇格するときに待機する最大秒数を指定します。　デフォルト値は40000000で、秒単位で1年より大きく、無限のタイムアウトをシミュレートするのに十分な大きさです

enableAlterSystem _boolean_

このパラメータがtrueの場合、ユーザーはこのCloudNativePGクラスターで`ALTER SYSTEM` を呼び出すことができます。　これは、デバッグとトラブルシューティングの場合にのみ使用してください。　デフォルトfalse。

extensions _ ExtensionConfiguration array_

追加する拡張機能の構成

PrimaryUpdateMethod

Underlying type: string

PrimaryUpdateMethodには、ローリング更新の一部としてクラスターのプライマリサーバーをアップグレードするときに使用するメソッドが含まれています

登場場所:

Field

Description

switchover

PrimaryUpdateMethodSwitchoverは、プライマリインスタンスをアップグレードする必要がある場合に、オペレーターが別の更新されたレプリカにスイッチオーバーすることを意味します。　注この方法を使用する場合、オペレーターはイメージ名とPostgreSQL構成パラメーターの両方を同時に変更する更新を拒否して、スイッチオーバープロセス中の構成の不一致を回避します。

restart

PrimaryUpdateMethodRestartは、オペレーターがアップグレードが必要なときにプライマリインスタンスをインプレースで再起動することを意味します

PrimaryUpdateStrategy

Underlying type: string

PrimaryUpdateStrategyには、ローリング更新の一部としてクラスターのプライマリサーバーをアップグレードするときに従うべき戦略が含まれています

登場場所:

Field

Description

supervised

PrimaryUpdateStrategySupervisedは、オペレーターがプライマリサーバー`supervised`を更新する前に、ユーザーがスイッチオーバー要求を手動で発行するのを待機する必要があることを意味します

unsupervised

PrimaryUpdateStrategyUnsupervisedとは、オペレーターが選択したPrimaryUpdateメソッドを別の更新されたレプリカに続行し、プライマリサーバー`unsupervised`、デフォルトを自動的に更新することを意味します

Probe

プローブは、コンテナに対して実行されるヘルスチェックを記述して、コンテナが生きているか、トラフィックを受信する準備ができているかを判断します。

登場場所:

Field

Description

Required

Default

Validation

initialDelaySeconds _integer_

コンテナが起動してからlivenessプローブが開始されるまでの秒数。　詳細 https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

timeoutSeconds _integer_

プローブがタイムアウトになるまでの秒数。　デフォルト1秒。最小値は1です。詳細情報 https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds _integer_

プローブを実行する頻度秒単位。　デフォルト10秒。最小値は1です。

successThreshold _integer_

失敗した後に成功したとみなされるプローブの最小連続成功数。　デフォルト1。活性およびスタートアップの場合は1である必要があります。最小値は1です。

failureThreshold _integer_

成功した後に失敗したと考えられるプローブの最小連続失敗数。　デフォルト3。最小値は1です。

terminationGracePeriodSeconds _integer_

プローブが失敗したときにポッドが正常に終了する必要がある秒単位のオプションの期間。　猶予期間は、ポッドで実行されているプロセスに終了信号が送信された後の秒単位の期間、およびプロセスがkill信号で強制的に停止される時間です。　この値を、プロセスの予想されるクリーンアップ時間よりも長く設定します。　この値がnilの場合、ポッドのterminationGracePeriodSecondsが使用されます。それ以外の場合、この値はポッド仕様で提供される値をオーバーライドします。　値は負でない整数である必要があります。値0は、killシグナルを介してすぐに停止することを示しますシャットダウンの機会なし。　これはベータフィールドであり、ProbeTerminationGracePeriod機能ゲートを有効にする必要があります。　最小値は1です。未設定の場合、spec.terminationGracePeriodSecondsが使用されます。

ProbeStrategyType

Underlying type: string

ProbeStrategyTypeは、PostgreSQLインスタンスの準備ができていることを宣言するために使用されるストラテジーのタイプです

登場場所:

Field

Description

pg_isready

ProbeStrategyPgIsReadyは、 pg_isreadyツールを使用して、PostgreSQLが起動されているかどうかを判断することを意味します

streaming

ProbeStrategyStreamingは、 pg_isreadyがポジティブで、レプリカがストリーミングレプリケーションを介して現在のプライマリに接続され、遅延が指定されている場合、制限内であることを意味します。

query

ProbeStrategyQueryは、サーバーがスーパーユーザーデータベースに接続でき、「-- ping」のような単純なクエリを実行できることを意味します

ProbeWithStrategy

ProbeWithStrategyは、スタートアッププローブの構成です

登場場所:

Field

Description

Required

Default

Validation

initialDelaySeconds _integer_

コンテナが起動してからlivenessプローブが開始されるまでの秒数。　詳細 https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

timeoutSeconds _integer_

プローブがタイムアウトになるまでの秒数。　デフォルト1秒。最小値は1です。詳細情報 https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds _integer_

プローブを実行する頻度秒単位。　デフォルト10秒。最小値は1です。

successThreshold _integer_

失敗した後に成功したとみなされるプローブの最小連続成功数。　デフォルト1。活性およびスタートアップの場合は1である必要があります。最小値は1です。

failureThreshold _integer_

成功した後に失敗したと考えられるプローブの最小連続失敗数。　デフォルト3。最小値は1です。

terminationGracePeriodSeconds _integer_

プローブが失敗したときにポッドが正常に終了する必要がある秒単位のオプションの期間。　猶予期間は、ポッドで実行されているプロセスに終了信号が送信された後の秒単位の期間、およびプロセスがkill信号で強制的に停止される時間です。　この値を、プロセスの予想されるクリーンアップ時間よりも長く設定します。　この値がnilの場合、ポッドのterminationGracePeriodSecondsが使用されます。それ以外の場合、この値はポッド仕様で提供される値をオーバーライドします。　値は負でない整数である必要があります。値0は、killシグナルを介してすぐに停止することを示しますシャットダウンの機会なし。　これはベータフィールドであり、ProbeTerminationGracePeriod機能ゲートを有効にする必要があります。　最小値は1です。未設定の場合、spec.terminationGracePeriodSecondsが使用されます。

type _ ProbeStrategyType _

プローブ戦略

Enum: [pg_isready streaming query]

maximumLag _ Quantity _

遅延制限。 `streaming`ストラテジーにのみ使用されます

ProbesConfiguration

ProbesConfigurationは、PostgreSQLポッドに注入されるプローブの構成を表します

登場場所:

Field

Description

Required

Default

Validation

startup _ ProbeWithStrategy _

起動プローブ構成

True

liveness _ LivenessProbe _

livenessプローブ構成

True

readiness _ ProbeWithStrategy _

Readiness Probe構成

True

Publication

パブリケーションは、パブリケーションAPIのスキーマです

Field

Description

Required

Default

Validation

apiVersion _string_

postgresql.cnpg.io/v1

True

kind _string_

Publication

True

metadata _ EmbeddedObjectMetadata _

`metadata`のフィールドについては、Kubernetes APIドキュメントを参照してください。

True

spec _ PublicationSpec _

NA

True

status _ PublicationStatus _

NA

True

PublicationReclaimPolicy

Underlying type: string

PublicationReclaimPolicyは、パブリケーションのサポートが終了したメンテナンスのポリシーを定義します。

登場場所:

Field

Description

delete

PublicationReclaimDeleteは、パブリケーションがそのクレームからリリースされたときにKubernetesから削除されることを意味します。

retain

PublicationReclaimRetainは、管理者による手動再利用のためにパブリケーションが現在のフェーズに残されることを意味します。デフォルトのポリシーはRetainです。

PublicationSpec

PublicationSpecは、パブリケーションの望ましい状態を定義します

登場場所:

Field

Description

Required

Default

Validation

cluster _ LocalObjectReference _

「パブリッシャー」を識別するPostgreSQLクラスターの名前

True

name _string_

PostgreSQL内のパブリケーションの名前

True

dbname _string_

パブリケーションが「パブリッシャー」クラスターにインストールされるデータベースの名前

True

parameters _object (keys:string, values:string)_

PostgreSQL `CREATE PUBLICATION`コマンドで予想される`WITH`句のパブリケーションパラメーター部分

target _ PublicationTarget _

PostgreSQL `CREATE PUBLICATION`コマンドで予想されるパブリケーションのターゲット

True

publicationReclaimPolicy _ PublicationReclaimPolicy _

この出版物のサポートが終了したメンテナンスのポリシー

retain

Enum: [delete retain]

PublicationStatus

PublicationStatusは、パブリケーションの観察された状態を定義します

登場場所:

Field

Description

Required

Default

Validation

observedGeneration _integer_

同期された最新の望ましい状態を表すシーケンス番号

applied _boolean_

パブリケーションが正しくリコンサイルされた場合、Applyはtrueです

message _string_

Messageはリコンシリエーション出力メッセージです

PublicationTarget

PublicationTargetは、このパブリケーションが公開するものです

登場場所:

Field

Description

Required

Default

Validation

allTables _boolean_

データベース内のすべてのテーブル、今後作成されるテーブルを含むすべてのテーブルの変更をレプリケートするパブリケーションとしてマークします。　PostgreSQLの`FOR ALL TABLES`に対応します。

objects _ PublicationTargetObject array_

次のスキーマオブジェクトのみ

MaxItems: 100000

PublicationTargetObject

PublicationTargetObjectは、パブリッシュするオブジェクトです

登場場所:

Field

Description

Required

Default

Validation

tablesInSchema _string_

指定されたスキーマのリスト内のすべてのテーブルの変更をレプリケートするものとしてパブリケーションをマークします。将来的に作成されるテーブルを含みます。 PostgreSQLの`FOR TABLES IN SCHEMA`に対応します。

table _ PublicationTargetTable _

パブリケーションに追加するテーブルのリストを指定します。 PostgreSQLの`FOR TABLE`に対応します。

PublicationTargetTable

PublicationTargetTableは、パブリッシュするテーブルです

登場場所:

Field

Description

Required

Default

Validation

only _boolean_

テーブルのみに制限するか、そのすべての子孫を含めるか

name _string_

テーブル名

True

schema _string_

スキーマ名

columns _string array_

公開する列

RecoveryTarget

RecoveryTargetを使用すると、復旧プロセスが停止する瞬間を構成できます。 TargetTLIを除くすべてのターゲットオプションは相互排他的です。

登場場所:

Field

Description

Required

Default

Validation

backupID _string_

リカバリプロセスを開始するバックアップのID。　空の場合デフォルト場合、オペレーターは指定されている場合、targetTimeまたはtargetLSNに基づいて、バックアップを自動的に検出します。それ以外の場合は、時系列で使用可能な最新のバックアップを使用します。

targetTLI _string_

ターゲットタイムライン「latest」または正の整数

targetXID _string_

ターゲットトランザクションID

targetName _string_

ターゲット名事前に作成します `pg_create_restore_point`で

targetLSN _string_

ターゲットLSNログシーケンス番号

targetTime _string_

RFC3339標準のタイムスタンプとしてのターゲット時間

targetImmediate _boolean_

一貫した状態に到達すると、リカバリーを終了します

exclusive _boolean_

ターゲットを排他的に設定します。省略した場合、デフォルトはfalseになるため、Postgresでは、`recovery_target_inclusive`がtrueになります

ReplicaClusterConfiguration

ReplicaClusterConfigurationは、レプリカクラスターの構成をカプセル化します

登場場所:

Field

Description

Required

Default

Validation

self _string_

このクラスターの名前を自己定義します。 `primary`と比較して、これがプライマリまたはレプリカクラスターであるかどうかを判断するために使用されます

primary _string_

Primaryは、 externalClustersで指定されたトポロジに基づいて、分散PostgreSQLクラスターのプライマリとして定義されるクラスターを定義します

source _string_

レプリケーション元の外部クラスターの名前

True

MinLength: 1

enabled _boolean_

レプリカモードが有効になっている場合、このクラスターは既存のクラスターのレプリカになります。レプリカクラスターは、リカバリーオブジェクトストアから、またはpg_basebackupを介したストリーミングを介して作成できます。　詳細については、ドキュメントのレプリカクラスターページを参照してください。

promotionToken _string_

外部クラスターによって生成された降格トークンは、プロモーション要件が満たされているかどうかを確認するために使用されます。

minApplyDelay _ Duration _

レプリカモードが有効になっている場合、このパラメータにより、システム時間が少なくともコミット時間を経過して構成された時間である場合にのみ、トランザクションを再生できます。これにより、データ損失エラーを修正する機会が提供されます。このパラメーターが設定されている場合、プロモーション トークンは使用できないことに注意してください。

ReplicationSlotsConfiguration

ReplicationSlotsConfigurationは、レプリケーションスロットの構成をカプセル化します

登場場所:

Field

Description

Required

Default

Validation

highAvailability _ ReplicationSlotsHAConfiguration _

高可用性構成のレプリケーションスロット

{ enabled:true }

updateInterval _integer_

スタンバイは、ローカルレプリケーションスロットのステータスを`updateInterval`秒ごとに更新しますデフォルト30。

30

Minimum: 1

synchronizeReplicas _ SynchronizeReplicasConfiguration _

ユーザー定義の物理レプリケーションスロットの同期を構成します

ReplicationSlotsHAConfiguration

ReplicationSlotsHAConfigurationは、オペレーターが自動的に管理するレプリケーションスロットの構成をカプセル化して、高可用性HAを目的としてスタンバイインスタンスとのストリーミングレプリケーション接続を制御します。レプリケーションスロットは、PostgreSQLの機能であり、ストリーミングクライアントこの特定の場合、HAクラスターの一部であるレプリカが切断されたときに、PostgreSQLがWALファイルをプライマリに自動的に保持するようにします。

登場場所:

Field

Description

Required

Default

Validation

enabled _boolean_

有効になっているデフォルト場合、オペレーターはプライマリインスタンスのレプリケーションスロットを自動的に管理し、HAクラスターの一部であるすべてのスタンバイインスタンスとのストリーミングレプリケーション接続でそれらを使用します。無効にすると、オペレーターはレプリカとのストリーミング接続でレプリケーションスロットを利用しません。この機能は、指定されたプライマリからそのカスケードレプリカまで、レプリカクラスター内のレプリケーションスロットも制御します。

true

slotPrefix _string_

HAのオペレーターが管理するレプリケーションスロットのプレフィックス。　小文字、数字、アンダースコア文字のみを含めることができます。　これは、作成時にのみ設定できます。デフォルトでは`_cnpg_`に設定されます。

_cnpg_

Pattern: ^[0-9a-z_]*$

synchronizeLogicalDecoding _boolean_

有効にすると、オペレーターは、高可用性クラスター全体の論理 デコードレプリケーションスロットの同期を自動的に管理します。　次の条件のいずれかが必要です。- PostgreSQLバージョン17以降 - pg_failover_slots拡張機能が有効になっているPostgreSQLバージョン<17

RoleConfiguration

RoleConfigurationは、追加フィールドEnsureを備えたPostgreSQLロールのKubernetesでの表現形式であり、データベース内のロールの存在または不在を保証するかどうかを指定します

CREATE ROLEコマンドのデフォルトが適用されます 参考 https://www.postgresql.org/docs/current/sql-createrole.html

登場場所:

Field

Description

Required

Default

Validation

name _string_

ロールの名前

True

comment _string_

ロールの説明

ensure _ EnsureOption _

ロールが`present`または`absent`であることを確認します-デフォルトは「present」です

present

Enum: [present absent]

passwordSecret _ LocalObjectReference _

ロールのパスワードを含むシークレット存在する場合 nullの場合、DisablePasswordが設定されていない限りパスワードは無視されます

connectionLimit _integer_

ロールがログインできる場合、これはロールが作成できる同時接続の数を指定します。 `-1`デフォルトは制限なしを意味します。

-1

validUntil _ バックアップからのポイント インタイム リカバリーPITR _

ロールのパスワードが有効でなくなる日時。　省略すると、パスワードの有効期限はありませんデフォルト。

inRoles _string array_

このロールが新しいメンバーとしてすぐに追加される1つ以上の既存のロールのリスト。デフォルトは空。

inherit _boolean_

ロールが、そのメンバーであるロールの特権を「継承」するかどうか。　デフォルトは`true`です。

true

disablePassword _boolean_

DisablePasswordは、PostgresでロールのパスワードをNULLに設定する必要があることを示します

superuser _boolean_

ロールが`superuser`であるかどうか データベース内のすべてのアクセス制限をオーバーライドできる人 - スーパーユーザーステータスは危険で、本当に必要な場合にのみ使用する必要があります。新しいスーパーユーザーを作成するには、自分自身がスーパーユーザーである必要があります。デフォルトは`false`です。

createdb _boolean_

`true`に設定すると、定義されるロールは新しいデータベースを作成できます。 `false`デフォルトを指定すると、ロールにデータベースを作成する機能が拒否されます。

createrole _boolean_

ロールが他のロールの作成、変更、ドロップ、コメント、セキュリティラベルの変更、および他のロールのメンバーシップを付与または取り消しできるかどうか。デフォルトは`false`です。

login _boolean_

ロールにログインを許可するかどうか。 login 属性を持つロールはユーザーと考えられます。この属性のないロール データベース特権の管理に役立ちますが、通常の意味でのユーザーではありません。デフォルトは`false`です。

replication _boolean_

ロールがレプリケーションロールであるかどうか。レプリケーションモード物理または論理レプリケーションでサーバーに接続し、レプリケーションスロットを作成またはドロップできるようにするには、ロールがこの属性を持つか、スーパーユーザーである必要があります。 `replication`属性を持つロールは、非常に高い特権ロールであり、レプリケーションに実際に使用されるロールでのみ使用する必要があります。デフォルト `false`です。

bypassrls _boolean_

ロールがすべての行レベルセキュリティRLSポリシーをバイパスするかどうか。　デフォルトは`false`です。

RoleStatus

Underlying type: string

RoleStatusは、クラスター内の管理対象ロールのステータスを表します

登場場所:

Field

Description

reconciled

RoleStatusReconciledは、DBのロールが仕様と一致することを示します

not-managed

RoleStatusNotManatedは、ロールが仕様にないため、管理対象でないことを示します

pending-reconciliation

RoleStatusPendingReconciliationは、仕様のロールがDBの更新/作成が必要であることを示します

reserved

RoleStatusReservedは、これがオペレーターによって予約されたロールの1つであることを示します。例`postgres`

SQLRefs

SQLRefsは、 SQLファイルを含むConfigMapまたはSecretへの参照を保持します。参照は特定の順序で処理されます。最初にすべてのシークレットが処理され、次にすべてのConfigMapが処理されます。各グループ内での処理順序は、それぞれの配列で指定されたシーケンスに従います。

登場場所:

Field

Description

Required

Default

Validation

secretRefs _ SecretKeySelector array_

SecretRefsは、シークレットへの参照のリストを保持します

configMapRefs _ ConfigMapKeySelector array_

ConfigMapRefsは、ConfigMapsへの参照のリストを保持します

ScheduledBackup

ScheduledBackupは、スケジュールされたバックアップAPIのスキーマです

Field

Description

Required

Default

Validation

apiVersion _string_

postgresql.cnpg.io/v1

True

kind _string_

ScheduledBackup

True

metadata _ EmbeddedObjectMetadata _

`metadata`のフィールドについては、Kubernetes APIドキュメントを参照してください。

True

spec _ ScheduledBackupSpec _

ScheduledBackupの目的の動作の仕様。　詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

True

status _ ScheduledBackupStatus _

ScheduledBackupの最近観察されたステータス。このデータは最新でない場合があります。システムによって設定されます。読み取り専用。　詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

ScheduledBackupSpec

ScheduledBackupSpecは、 ScheduledBackupの目的の状態を定義します

登場場所:

Field

Description

Required

Default

Validation

suspend _boolean_

このバックアップが一時停止されているかどうか

immediate _boolean_

最初のバックアップを作成後にすぐに開始する必要があるかどうか

schedule _string_

スケジュールは、追加の秒指定子が含まれるため、KubernetesのCronジョブで使用される同じ形式に従いません。https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Formatを参照してください

True

cluster _ LocalObjectReference _

バックアップするクラスター

True

backupOwnerReference _string_

作成したバックアップリソース内にどのownerReferenceを配置するかを示します。　- none 作成されたバックアップオブジェクトの所有者参照なしフィールドが導入される前と同じ動作

none

Enum: [none self cluster]

target _ BackupTarget _

このバックアップを実行するインスタンスを決定するポリシー。空の場合、デフォルトの`cluster.spec.backup.target`になります。　使用可能なオプションは、空の文字列、`primary`および`prefer-standby`です。　`primary`は常にプライマリインスタンスでバックアップを実行するようにし、 `prefer-standby`は、可能な場合は最も更新されたスタンバイでバックアップを実行します。

Enum: [primary prefer-standby]

method _ BackupMethod _

使用するバックアップ方法、可能なオプションは`barmanObjectStore`、volumeSnapshot`または`plugin`です。デフォルト`barmanObjectStore

barmanObjectStore

Enum: [barmanObjectStore volumeSnapshot plugin]

pluginConfiguration _ BackupPluginConfiguration _

このバックアップを管理するプラグインに渡される構成パラメーター

online _boolean_

ボリュームスナップショットを使用したバックアップのデフォルトのタイプが オンライン/ホット true、デフォルトかオフライン/コールド `false`かどうか クラスターフィールド '.spec.backup.volumeSnapshot.online'で指定されたデフォルト設定をオーバーライドします

onlineConfiguration _ OnlineConfiguration _

ボリュームスナップショットを使用してオンライン/ホットバックアップを制御する構成パラメーター クラスターで指定されたデフォルト設定をオーバーライドします '.backup.volumeSnapshot.onlineConfiguration'スタンザ

ScheduledBackupStatus

ScheduledBackupStatusは、 ScheduledBackupの観察された状態を定義します

登場場所:

Field

Description

Required

Default

Validation

lastCheckTime _ バックアップからのポイント インタイム リカバリーPITR _

最新のスケジュール

lastScheduleTime _ バックアップからのポイント インタイム リカバリーPITR _

そのバックアップが最後に正常にスケジュールされたときの情報。

nextScheduleTime _ バックアップからのポイント インタイム リカバリーPITR _

次回バックアップを実行します

SchemaSpec

SchemaSpecはデータベースにスキーマを構成します

登場場所:

Field

Description

Required

Default

Validation

name _string_

オブジェクトの名前拡張子、スキーマ、FDW、サーバー

True

ensure _ EnsureOption _

データベースにオブジェクトたとえばスキーマが存在するかどうかを指定します。 `present`に設定されている場合、オブジェクトは存在しない場合に作成されます。 `absent`に設定されている場合、拡張機能/スキーマが存在する場合は削除されます。

present

Enum: [present absent]

owner _string_

PostgreSQL内のスキーマを所有するユーザーのロール名。　`CREATE SCHEMA`の`AUTHORIZATION`パラメーターと`ALTER SCHEMA`の`OWNER TO`コマンドにマッピングされます。

True

SecretVersion

SecretVersionには、シークレット名とそのリソースバージョンが含まれます

登場場所:

Field

Description

Required

Default

Validation

name _string_

シークレットの名前

version _string_

シークレットのリソースバージョン

SecretsResourceVersion

SecretsResourceVersionは、オペレーターが管理するシークレットのリソースバージョンです。

登場場所:

Field

Description

Required

Default

Validation

superuserSecretVersion _string_

"postgres"ユーザーシークレットのリソースバージョン

replicationSecretVersion _string_

「streaming_replica」ユーザーシークレットのリソースバージョン

applicationSecretVersion _string_

"app"ユーザーシークレットのリソースバージョン

managedRoleSecretVersion _object (keys:string, values:string)_

管理対象ロールシークレットのリソースバージョン

caSecretVersion _string_

未使用。古いバージョンとの互換性のために保持されています。

clientCaSecretVersion _string_

PostgreSQLのリソースバージョンクライアントサイドのCAシークレットバージョン

serverCaSecretVersion _string_

PostgreSQLのリソースバージョンサーバーサイドCAシークレットバージョン

serverSecretVersion _string_

PostgreSQLのリソースバージョンサーバーサイドシークレットバージョン

barmanEndpointCA _string_

BarmanエンドポイントCAのリソースバージョンが提供されている場合

externalClusterSecretVersion _object (keys:string, values:string)_

外部クラスターシークレットのリソースバージョン

metrics _object (keys:string, values:string)_

メトリックを渡すために使用されるすべてのシークレットのバージョンを含むマップ。　マップキーはシークレット名であり、マップ値はバージョンです

ServerSpec

ServerSpecは外部データラッパーのサーバーを構成します

登場場所:

Field

Description

Required

Default

Validation

name _string_

オブジェクトの名前拡張子、スキーマ、FDW、サーバー

True

ensure _ EnsureOption _

データベースにオブジェクトたとえばスキーマが存在するかどうかを指定します。 `present`に設定されている場合、オブジェクトは存在しない場合に作成されます。 `absent`に設定されている場合、拡張機能/スキーマが存在する場合は削除されます。

present

Enum: [present absent]

fdw _string_

外部データラッパーFDWの名前

True

options _ OptionSpec array_

Optionsはサーバーの構成オプションを指定しますキーはオプション名、valueはオプション値です。

usage _ UsageSpec array_

サーバー上の`USAGE`特権が付与または取り消されるロールのリスト。

ServiceAccountTemplate

ServiceAccountTemplateには、サービスアカウントを生成するために必要なテンプレートが含まれています

登場場所:

Field

Description

Required

Default

Validation

metadata _ EmbeddedObjectMetadata _

`metadata`のフィールドについては、Kubernetes APIドキュメントを参照してください。

True

ServiceSelectorType

Underlying type: string

ServiceSelectorTypeは、サービスセレクターを生成するための有効な値を説明します。読み取り/書き込み、読み取り、読み取り専用など、セレクターが適用されるサービスの種類を示します

検証

  • 列挙型 [rw r ro]

登場場所:

Field

Description

rw

ServiceSelectorTypeRWは、読み取り/書き込みサービスを選択します。

r

ServiceSelectorTypeRは読み取りサービスを選択します。

ro

ServiceSelectorTypeROは、読み取り専用サービスを選択します。

ServiceTemplateSpec

ServiceTemplateSpecは、ユーザーがサービス生成のテンプレートを設定できる構造です。

登場場所:

Field

Description

Required

Default

Validation

metadata _ EmbeddedObjectMetadata _

`metadata`のフィールドについては、Kubernetes APIドキュメントを参照してください。

spec _ ServiceSpec _

サービスの目的な動作の仕様。　詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

ServiceUpdateStrategy

Underlying type: string

ServiceUpdateStrategyは、管理対象サービスへの変更を処理する方法を説明します

検証

  • 列挙型 [patch replace]

登場場所:

SnapshotOwnerReference

Underlying type: string

SnapshotOwnerReferenceは、スナップショットの所有者の参照タイプを定義します。これは、処理されたリソースがどの所有者に関連するかを指定します。

登場場所:

Field

Description

none

SnapshotOwnerReferenceNoneは、スナップショットに所有者参照がないことを示します。

backup

SnapshotOwnerReferenceBackupは、スナップショットがバックアップリソースによって所有されていることを示します。

cluster

SnapshotOwnerReferenceClusterは、スナップショットがクラスターリソースによって所有されていることを示します。

SnapshotType

Underlying type: string

SnapshotTypeは許可されるインポートのタイプです

登場場所:

Field

Description

monolith

MonolithSnapshotTypeは、モノリスクローンタイポロジを実行することを示します

microservice

MicroserviceSnapshotTypeは、マイクロサービスクローンタイポロジを実行することを示します

StorageConfiguration

StorageConfigurationは、PVCの作成と調整に使用される構成であり、WALボリューム、PGDATAボリューム、またはテーブルスペースに使用できます

登場場所:

Field

Description

Required

Default

Validation

storageClass _string_

PVCに使用するStorageClass。可能な場合、PVCテンプレートを評価した後に適用されます。　指定しない場合、生成されたPVCはデフォルトのストレージクラスを使用します

size _string_

ストレージのサイズ。 PVCテンプレートでまだ指定されていない場合は必須。　このフィールドへの変更は、作成されたPVCに自動的に再適用されます。　サイズを小さくすることはできません。

resizeInUseVolumes _boolean_

既存のPVCのサイズを変更します、デフォルトはtrue

true

pvcTemplate _ PersistentVolumeClaimSpec _

Persistent Volume Claimを生成するために使用されるテンプレート

Subscription

サブスクリプションは、サブスクリプションAPIのスキーマです

Field

Description

Required

Default

Validation

apiVersion _string_

postgresql.cnpg.io/v1

True

kind _string_

Subscription

True

metadata _ EmbeddedObjectMetadata _

`metadata`のフィールドについては、Kubernetes APIドキュメントを参照してください。

True

spec _ SubscriptionSpec _

NA

True

status _ SubscriptionStatus _

NA

True

SubscriptionReclaimPolicy

Underlying type: string

SubscriptionReclaimPolicyは、サブスクリプションのサポートが終了したメンテナンスのポリシーを説明します。

登場場所:

Field

Description

delete

SubscriptionReclaimDeleteは、サブスクリプションがそのクレームからリリースされたときにKubernetesから削除されることを意味します。

retain

SubscriptionReclaimRetainは、サブスクリプションが、管理者による手動 再利用のために現在のフェーズに残されることを意味します。デフォルトのポリシーはRetainです。

SubscriptionSpec

SubscriptionSpecは、サブスクリプションの目的の状態を定義します

登場場所:

Field

Description

Required

Default

Validation

cluster _ LocalObjectReference _

「サブスクライバー」を識別するPostgreSQLクラスターの名前

True

name _string_

PostgreSQL内のサブスクリプションの名前

True

dbname _string_

パブリケーションが「サブスクライバー」クラスターにインストールされるデータベースの名前

True

parameters _object (keys:string, values:string)_

PostgreSQL `CREATE SUBSCRIPTION`コマンドの`WITH`句に含まれるサブスクリプションパラメーター。ほとんどのパラメーターは、サブスクリプションの作成後に変更できません。後で変更しても無視されます。次の文書に記載されている限定セットを除きます。 <a href="https://www.postgresql.org/docs/current/sql-altersubscription.html#SQL-ALTERSUBSCRIPTION-PARAMS-SET">https://www.postgresql.org/docs/current/sql-altersubscription.html# SQL-ALTERSUBSCRIPTION- PARAMS-SET</a>

publicationName _string_

「パブリッシャー」のPostgreSQLデータベース内のパブリケーションの名前

True

publicationDBName _string_

外部 クラスター上のパブリケーションを含むデータベースの名前。デフォルトは外部クラスター定義のものです。

externalClusterName _string_

パブリケーション「パブリッシャー」を含む外部クラスターの名前

True

subscriptionReclaimPolicy _ SubscriptionReclaimPolicy _

このサブスクリプションのサポートが終了したメンテナンスのポリシー

retain

Enum: [delete retain]

SubscriptionStatus

SubscriptionStatusは、サブスクリプションの観察された状態を定義します

登場場所:

Field

Description

Required

Default

Validation

observedGeneration _integer_

同期された最新の望ましい状態を表すシーケンス番号

applied _boolean_

サブスクリプションが正しく調整された場合、Applyはtrueです

message _string_

Messageはリコンシリエーション出力メッセージです

SwitchReplicaClusterStatus

SwitchReplicaClusterStatusには、クラスターからレプリカクラスターへのスイッチに関するすべてのステータスが含まれています

登場場所:

Field

Description

Required

Default

Validation

inProgress _boolean_

InProgressは、クラスターをレプリカクラスターに切り替える進行中の手順があるかどうかを示します。

SyncReplicaElectionConstraints

SyncReplicaElectionConstraintsには、同期レプリカ選択のコンストレインが含まれています。

アンチアフィニティパラメーターの場合、すべてのラベル値が一致する場合、2つのインスタンスは同じ場所にあるとみなされます。

将来的には、名前による同期レプリカ選択制限がサポートされる予定です。

登場場所:

Field

Description

Required

Default

Validation

nodeLabelsAntiAffinity _string array_

抽出および比較して、ポッドが同じトポロジに存在するかどうかを評価するノードラベル値のリスト

enabled _boolean_

このフラグは、同期レプリカのコンストレインを有効にします

True

SynchronizeReplicasConfiguration

SynchronizeReplicasConfigurationには、ユーザー定義の物理レプリケーションスロットの同期のための構成が含まれています

登場場所:

Field

Description

Required

Default

Validation

enabled _boolean_

trueに設定すると、プライマリにあるすべてのレプリケーションスロットが各スタンバイで同期されます

True

true

excludePatterns _string array_

除外するレプリケーションスロットの名前と一致する正規表現パターンのリストデフォルトでは空

SynchronousReplicaConfiguration

SynchronousReplicaConfigurationには、PostgreSQL同期レプリケーション機能の構成が含まれています。重要 現時点では、 .spec.minSyncReplicas および.spec.maxSyncReplicas も考慮する必要があります。

登場場所:

Field

Description

Required

Default

Validation

method _ SynchronousReplicaConfigurationMethod _

'any'クォーラムベースの同期レプリケーションまたは'first'プライオリティベースの同期レプリケーションを値として受け入れます、リストされたサーバーから同期レプリケーションスタンバイを選択する方法。

True

Enum: [any first]

number _integer_

トランザクションが応答を待機する必要がある同期スタンバイサーバーの数を指定します。

True

maxStandbyNamesFromCluster _integer_

PostgreSQLの`synchronous_standby_names`オプションに自動的に含めることができるローカルクラスターポッドの最大数を指定します。

standbyNamesPre _string array_

ローカルクラスターポッドの前に`synchronous_standby_names`に追加されるアプリケーション名のユーザー定義のリストこの順序は、優先度ベースの同期レプリケーションの場合にのみ役立ちます。

standbyNamesPost _string array_

ローカルクラスターポッドの後に synchronous_standby_names に追加されるアプリケーション名のユーザー定義のリスト 順序は、優先度ベースの同期レプリケーションの場合にのみ役立ちます。

dataDurability _ DataDurabilityLevel _

「必須」に設定されている場合、データの耐久性は厳密に適用されます。同期コミット設定`on`、remote_write、または`remote_apply`を使用した書き込み操作は、正常なレプリカが不十分な場合にブロックし、データの永続性を保証します。　「preferred」に設定されている場合、正常なレプリカが利用可能な場合、データの耐久性は維持されますが、レプリカが利用できなくなると、必要なインスタンスの数は動的に調整されます。この設定は、厳密な耐久性の適用を緩和して、操作の継続性を可能にします。この設定は、`standbyNamesPre`と`standbyNamesPost`の両方が設定されていない空の場合にのみ適用されます。

Enum: [required preferred]

failoverQuorum _boolean_

FailoverQuorumは、フェールオーバーの前にクォーラムベースのチェックを有効にし、CloudNativePG管理のPostgreSQLクラスターでのフェールオーバーイベント中のデータの耐久性と安全性を向上させます。

SynchronousReplicaConfigurationMethod

Underlying type: string

SynchronousReplicaConfigurationMethodは、クォーラムベースのレプリケーションまたは優先リストを使用するかどうかを構成します

登場場所:

TablespaceConfiguration

TablespaceConfigurationはテーブルスペースの構成であり、テーブルスペースのストレージ仕様が含まれます

登場場所:

Field

Description

Required

Default

Validation

name _string_

テーブルスペースの名前

True

storage _ StorageConfiguration _

テーブルスペースのストレージ構成

True

owner _ DatabaseRoleRef _

所有者は、テーブルスペースを所有するPostgreSQLユーザーです

temporary _boolean_

trueに設定されている場合、テーブルスペースはPostgreSQLの`temp_tablespaces` エントリとして追加され、temp データベースオブジェクト、またはその他の一時ファイルを自動的に収容するために利用できます。 temp_tablespaces GUCの詳細については、 PostgreSQL ドキュメントを参照してください。

false

TablespaceState

TablespaceStateは、クラスター内のテーブルスペースの状態を表します

登場場所:

Field

Description

Required

Default

Validation

name _string_

Nameはテーブルスペースの名前です

True

owner _string_

所有者は、テーブルスペースを所有するPostgreSQLユーザーです

state _ TablespaceStatus _

状態は最新の調整状態です

True

error _string_

Errorはリコンシリエーションエラーである場合

TablespaceStatus

Underlying type: string

TablespaceStatusは、クラスター内のテーブルスペースのステータスを表します

登場場所:

Field

Description

reconciled

TablespaceStatusReconciledは、DBのテーブルスペースが仕様と一致することを示します

pending

TablespaceStatusPendingReconciliationは、仕様のテーブルスペースがDBでの作成が必要であることを示しています

Topology

トポロジにはクラスタートポロジが含まれます

登場場所:

Field

Description

Required

Default

Validation

instances _object (keys: PodName , values: PodTopologyLabels )_

インスタンスには、インスタンスのポッドトポロジが含まれます

nodesUsed _integer_

Nodes Usedは、インスタンスを収容する個別のノードの数を表します。　値「1」は、すべてのインスタンスが単一のノードでホストされることを示し、高可用性HAが存在しないことを意味します。理想的には、この値はPostgres HAクラスターのインスタンスの数と同じである必要があり、コンピューティング側でシェアードナッシングアーキテクチャを意味します。

successfullyExtracted _boolean_

SuccessquietlyExtractedは、トポロジデータが抽出されたかどうかを示します。障害が発生した場合の同期レプリカ選択でフォールバック動作を制定すると役立ちます

UsageSpec

UsageSpecは、外部データラッパーの使用法を構成します

登場場所:

Field

Description

Required

Default

Validation

name _string_

使用の名前

True

type _ UsageSpecType _

使用の種類

grant

Enum: [grant revoke]

UsageSpecType

Underlying type: string

UsageSpecTypeは、 Database オブジェクトのusage フィールドで指定された使用のタイプを説明します。

登場場所:

Field

Description

grant

GrantUsageSpecTypeは、付与された使用権限を示します。　デフォルトの使用権限はgrantです。

revoke

RevokeUsageSpecTypeは、取り消し使用権限を示します。

VolumeSnapshotConfiguration

VolumeSnapshotConfigurationは、スナップショットバックアップを実行するための構成を表します。

登場場所:

Field

Description

Required

Default

Validation

labels _object (keys:string, values:string)_

ラベルは、 .metadata.labelsスナップショットリソースに追加されるキーと値のペアです。

annotations _object (keys:string, values:string)_

.metadata.annotationsスナップショットリソースに追加される注釈のキーと値のペア。

className _string_

ClassNameは、PG_DATA Persistent VolumeClaimに使用されるスナップショットクラスを指定します。　特定のクラスが存在しない場合、それは他のタイプのデフォルトクラスです

walClassName _string_

WalClassNameは、PG_WAL Persistent VolumeClaimに使用されるスナップショットクラスを指定します。

tablespaceClassName _object (keys:string, values:string)_

TablespaceClassNameは、テーブルスペースに使用されるスナップショットクラスを指定します。　デフォルトでPGDATAスナップショットクラスが設定されている場合

snapshotOwnerReference _ SnapshotOwnerReference _

SnapshotOwnerReferenceは、スナップショットが持つ必要がある所有者参照のタイプを示します

none

Enum: [none cluster backup]

online _boolean_

ボリュームスナップショットを使用したバックアップのデフォルトのタイプが オンライン/ホット true、default か、オフライン/コールド false かどうか

true

onlineConfiguration _ OnlineConfiguration _

ボリュームスナップショットを使用してオンライン/ホットバックアップを制御する構成パラメーター

{ immediateCheckpoint:false waitForArchive:true }