API Reference - v1.29.0

目次

API Reference - v1.29.0#

Packages#

postgresql.k8s.enterprisedb.io/v1#

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

Resource Types#

AffinityConfiguration#

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

利用箇所:

Field

Description

Required

Default

Validation

enablePodAntiAffinity boolean

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

topologyKey string

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

nodeSelector object (keys:string, values:string)

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

nodeAffinity * NodeAffinity *

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

tolerations * 許容範囲 array*

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

podAntiAffinityType string

PodAntiAffinityTypeを使用すると、ユーザーはクラスターインスタンス間のポッドアンチアフィニティを<br />スケジュール中に強い要件と見なすかどうかを決定できます。使用できる値は「preferred」空の場合のデフォルトまたは<br />「required」です。 「required」に設定すると、新しいkubernetesノードが<br />追加されるまでインスタンスが保留されたままになる可能性があります。既存のすべてのノードが必要なポッドのアンチアフィニティルールと一致しない場合。<br />詳細情報<br / ><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.k8s.enterprisedb.io/v1

True

kind string

Backup

True

metadata * EmbeddedObjectMetadata *

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

True

spec * BackupSpec *

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

True

status * BackupStatus *

最近観察されたバックアップのステータス。このデータは最新でない可能性があります<br />。システムによって設定されます。読み取り専用。<br />詳細情報 <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は、バックアップ<br />およびWALつまり '60d' に使用される保持ポリシーです。保持ポリシーは`XXu`のフォームで表現されます。ここで、 XX`は正の整数、`u`は`[dwm] -<br />日、週、月<br />現在、BarmanObjectStoreメソッドを使用する場合にのみ適用されます。

Pattern: ^[1-9][0-9]*[dwm]$ <br />

target * BackupTarget *

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

Enum: [primary prefer-standby] <br />

BackupMethod#

基になる型 string

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

利用箇所:

Field

Description

volumeSnapshot

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

barmanObjectStore

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

plugin

BackupMethodPluginは、このバックアップを<br />プラグイン<br />によって処理する必要があることを意味します

BackupPhase#

基になる型 string

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

利用箇所:

BackupPluginConfiguration#

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

利用箇所:

Field

Description

Required

Default

Validation

name string

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

True

parameters object (keys:string, values:string)

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

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

BackupSpec#

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

利用箇所:

Field

Description

Required

Default

Validation

cluster * LocalObjectReference *

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

True

target * BackupTarget *

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

Enum: [primary prefer-standby] <br />

method * BackupMethod *

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

barmanObjectStore

Enum: [barmanObjectStore volumeSnapshot plugin] <br />

pluginConfiguration * BackupPluginConfiguration *

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

online boolean

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

onlineConfiguration * OnlineConfiguration *

ボリュームスナップショットを使用してオンライン/ホットバックアップを制御する構成パラメーター<br />クラスター '.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メジャーバージョン<br />バックアップ。

True

endpointCA * SecretKeySelector *

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

endpointURL string

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

destinationPath string

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

serverName string

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

encryption string

S3 APIに必要な暗号化方法

backupId string

BarmanバックアップのID

backupName string

Barmanのバックアップの名前

phase * BackupPhase *

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

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

バックアップツールによってバックアップの実行が開始されたとき

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

バックアップツールによってバックアップの実行が終了されたとき

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

オペレーターによってバックアッププロセスが開始されたとき

reconciliationTerminatedAt * バックアップからのポイント インタイム リカバリー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#

基になる型 string

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

利用箇所:

BootstrapConfiguration#

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

利用箇所:

Field

Description

Required

Default

Validation

initdb * BootstrapInitDB *

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

recovery * BootstrapRecovery *

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

pg_basebackup * BootstrapPgBaseBackup *

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

BootstrapInitDB#

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

利用箇所:

Field

Description

Required

Default

Validation

database string

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

owner string

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

secret * LocalObjectReference *

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

redwood boolean

Redwoodの互換性を有効/無効にする必要がある場合。必要<br />EPASおよびEPASの場合 デフォルトでtrue

options string array

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

dataChecksums boolean

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

encoding string

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

localeCollate string

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

localeCType string

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

locale string

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

localeProvider string

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

icuLocale string

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

icuRules string

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

builtinLocale string

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

walSegmentSize integer

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

Maximum: 1024 <br />Minimum: 1 <br />

postInitSQL string array

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

postInitApplicationSQL string array

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

postInitTemplateSQL string array

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

import * OpenShiftの重要な概念 *

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

postInitApplicationSQLRefs * SQLRefs *

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

postInitTemplateSQLRefs * SQLRefs *

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

postInitSQLRefs * SQLRefs *

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

BootstrapPgBaseBackup#

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

利用箇所:

Field

Description

Required

Default

Validation

source string

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

True

MinLength: 1 <br />

database string

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

owner string

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

secret * LocalObjectReference *

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

BootstrapRecovery#

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

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

利用箇所:

Field

Description

Required

Default

Validation

backup * BackupSource *

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

source string

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

volumeSnapshots * DataSource *

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

recoveryTarget * RecoveryTarget *

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

database string

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

owner string

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

secret * LocalObjectReference *

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

CatalogImage#

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

利用箇所:

Field

Description

Required

Default

Validation

image string

画像参照

True

major integer

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

True

Minimum: 10 <br />

extensions * ExtensionConfiguration array*

追加する拡張機能の構成

CertificatesConfiguration#

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

利用箇所:

Field

Description

Required

Default

Validation

serverCASecret string

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

serverTLSSecret string

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

replicationTLSSecret string

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

clientCASecret string

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

serverAltDNSNames string array

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

CertificatesStatus#

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

利用箇所:

Field

Description

Required

Default

Validation

serverCASecret string

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

serverTLSSecret string

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

replicationTLSSecret string

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

clientCASecret string

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

serverAltDNSNames string array

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

expirations object (keys:string, values:string)

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

Cluster#

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

Field

Description

Required

Default

Validation

apiVersion string

postgresql.k8s.enterprisedb.io/v1

True

kind string

Cluster

True

metadata * EmbeddedObjectMetadata *

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

True

spec * ClusterSpec *

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

True

status * ClusterStatus *

最近観察されたクラスターのステータス。このデータは最新でない可能性があります<br />。システムによって設定されます。読み取り専用。<br />詳細情報 <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.k8s.enterprisedb.io/v1

True

kind string

ClusterImageCatalog

True

metadata * EmbeddedObjectMetadata *

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

True

spec * ImageCatalogSpec *

クラスターイメージカタログの目的の動作の仕様。<br />詳細情報 <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を有効にします。<br />このオプションを変更すると、すべてのインスタンスが強制的にロールアウトされます。

false

ClusterSpec#

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

利用箇所:

Field

Description

Required

Default

Validation

description string

このPostgreSQLクラスターの説明

inheritedMetadata * EmbeddedObjectMetadata *

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

imageName string

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

imageCatalogRef * ImageCatalogRef *

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

imagePullPolicy * PullPolicy *

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

schedulerName string

指定した場合、ポッドは指定されたKubernetes<br />スケジューラーによってディスパッチされます。指定しない場合、ポッドはデフォルトの<br />スケジューラーによってディスパッチされます。詳細情報<br /><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 <br />

minSyncReplicas integer

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

0

Minimum: 0 <br />

maxSyncReplicas integer

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

0

Minimum: 0 <br />

postgresql * PostgresConfiguration *

PostgreSQLサーバーの構成

podSelectorRefs * :ref:``podSelectorRefs` を使用した動的アドレス解決<podSelectorRefs を使用した動的アドレス解決>` array*

PodSelectorRefsは、アドレスフィールドで${podselector:NAME}構文を使用してpg_hbaルールで参照できる名前付けポッドラベルセレクターを定義します。<br />オペレーターは一致するポッドIPを解決し、インスタンスマネージャーは展開します。<br />それに応じてpg_hba行。クラスター自分自身の名前空間のポッドのみが考慮されます。

replicationSlots * ReplicationSlotsConfiguration *

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

bootstrap * BootstrapConfiguration *

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

replica * ReplicaClusterConfiguration *

レプリカクラスター構成

superuserSecret * LocalObjectReference *

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

enableSuperuserAccess boolean

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

certificates * CertificatesConfiguration *

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

imagePullSecrets * LocalObjectReference array*

イメージをプルするために使用されるプルシークレットのリスト。ライセンスキー<br />プルシークレットが含まれている場合、そのシークレットは自動的に含まれます。

storage * StorageConfiguration *

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

serviceAccountTemplate * ServiceAccountTemplate *

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

serviceAccountName string

クラスターに使用する同じ名前空間内の既存のサービスアカウントの名前。指定されると、オペレーターは新しいサービスアカウントを作成しません<br />提供されたものを使用します。これは、複数のクラスター全体で単一の<br />サービスアカウントを共有する場合に役立ちますクラウドIAM構成の場合。<br />指定しない場合、サービスアカウントはクラスター名で作成されます。<br />ServiceAccountTemplateと相互排他的。

MaxLength: 253 <br />Pattern: ^ :ref:`a-z0-9 <[-a-z0-9]*[a-z0-9]> ?$` <br />

walStorage * StorageConfiguration *

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

ephemeralVolumeSource * EphemeralVolumeSource *

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

startDelay integer

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

3600

stopDelay integer

PostgreSQLインスタンスが<br />正常にシャットダウンできる秒単位の時間デフォルト1800

1800

smartStopDelay integer

非推奨:代わりにSmartShutdownTimeoutを使用してください

smartShutdownTimeout integer

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

180

switchoverDelay integer

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

3600

failoverDelay integer

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

0

livenessProbeTimeout integer

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

affinity * AffinityConfiguration *

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

topologySpreadConstraints * TopologySpreadConstraint array*

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

resources * ResourceRequirements *

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

ephemeralVolumesSizeLimit * EphemeralVolumesSizeLimitConfiguration *

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

priorityClassName string

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

primaryUpdateStrategy * PrimaryUpdateStrategy *

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

unsupervised

Enum: [unsupervised supervised] <br />

primaryUpdateMethod * PrimaryUpdateMethod *

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

Enum: [switchover restart] <br />

backup * BackupConfiguration *

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

nodeMaintenanceWindow * NodeMaintenanceWindow *

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

licenseKey string

クラスターのライセンスキー。空の場合、クラスターは<br />トライアルモードで動作し、有効期限デフォルト30日後、オペレーターは<br />調整試行を停止します。詳細については、オペレーターに付属するライセンス契約を参照してください。

licenseKeySecret * SecretKeySelector *

ライセンスキーへの参照。これが設定されている場合、LicenseKeyよりも優先されます。

monitoring * MonitoringConfiguration *

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

externalClusters * ExternalCluster array*

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

logLevel string

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

info

Enum: [error warning info debug trace] <br />

projectedVolumeTemplate * ProjectedVolumeSource *

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

env * ExtensionEnvVar array*

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

envFrom * EnvFromSource array*

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

managed * ManagedConfiguration *

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

seccompProfile * SeccompProfile *

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

podSecurityContext * archive_timeout *

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

securityContext * archive_timeout *

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

tablespaces * TablespaceConfiguration array*

テーブルスペース構成

enablePDB boolean

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

true

plugins * BackupPluginConfiguration array*

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

probes * ProbesConfiguration *

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

ClusterStatus#

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

利用箇所:

Field

Description

Required

Default

Validation

instances integer

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

readyInstances integer

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

instancesStatus object (keys: :ref:`PodStatus<PodStatus>` , values:string array)

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

instancesReportedState object (keys: :ref:`PodName<PodName>` , values: :ref:`InstanceReportedState<InstanceReportedState>` )

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

managedRolesStatus * ManagedRoles *

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

tablespacesStatus * TablespaceState array*

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

podSelectorRefs * PodSelectorRefStatus array*

PodSelectorRefsには、spec.podSelectorRefsで定義された各名前付けセレクター<br />の解決されたポッドIPが含まれています。

timelineID integer

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

topology * トポロジスプレッドコンストレイン *

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

latestGeneratedNode integer

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

currentPrimary string

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

targetPrimary string

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

lastPromotionToken string

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

pvcCount integer

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

jobCount integer

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

danglingPVC string array

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

resizingPVC string array

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

initializingPVC string array

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

healthyPVC string array

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

unusablePVC string array

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

licenseStatus Status

ライセンスのステータス

writeService string

現在の書き込みポッド

readService string

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

phase string

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

phaseReason string

現在のフェーズの理由

secretsResourceVersion * SecretsResourceVersion *

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

configMapResourceVersion * ConfigMapResourceVersion *

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

certificates * CertificatesStatus *

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

firstRecoverabilityPoint string

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

firstRecoverabilityPointByMethod object (keys: :ref:`BackupMethod<BackupMethod>` , values: :ref:`バックアップからのポイント インタイム リカバリーPITR<バックアップからのポイント インタイム リカバリーPITR>` )

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

lastSuccessfulBackup string

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

lastSuccessfulBackupByMethod object (keys: :ref:`BackupMethod<BackupMethod>` , values: :ref:`バックアップからのポイント インタイム リカバリーPITR<バックアップからのポイント インタイム リカバリーPITR>` )

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

lastFailedBackup string

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

cloudNativePostgresqlCommitHash string

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

currentPrimaryTimestamp string

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

currentPrimaryFailingSinceTimestamp string

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

targetPrimaryTimestamp string

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

poolerIntegrations * PoolerIntegrations *

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

cloudNativePostgresqlOperatorHash 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は、 pg_controldataからの情報を含むJSONトークンであり、 データベースシステム識別子、最新のチェックポイントの<br />タイムラインID、最新のチェックポイントのREDO場所、最新のチェックポイントのREDO<br />WALファイル、最新のチェックポイントの時間

systemID string

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

ConfigMapResourceVersion#

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

利用箇所:

Field

Description

Required

Default

Validation

metrics object (keys:string, values:string)

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

DataDurabilityLevel#

基になる型 string

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

利用箇所:

Field

Description

required

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

preferred

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

DataSource#

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

利用箇所:

Field

Description

Required

Default

Validation

storage * TypedLocalObjectReference *

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

True

walStorage * TypedLocalObjectReference *

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

tablespaceStorage object (keys:string, values: `TypedLocalObjectReference <https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#typedlocalobjectreference-v1-core>`__ )

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

Database#

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

Field

Description

Required

Default

Validation

apiVersion string

postgresql.k8s.enterprisedb.io/v1

True

kind string

Database

True

metadata * EmbeddedObjectMetadata *

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

True

spec * DatabaseSpec *

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

True

status * DatabaseStatus *

最近観察されたデータベースのステータス。このデータは最新でない可能性があります<br />。システムによって設定されます。読み取り専用。<br />詳細情報 <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 *

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

present

Enum: [present absent] <br />

DatabaseObjectStatus#

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

利用箇所:

Field

Description

Required

Default

Validation

name string

オブジェクトの名前

True

applied boolean

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

True

message string

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

DatabaseReclaimPolicy#

基になる型 string

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

利用箇所:

Field

Description

delete

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

retain

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

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] <br />

name string

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

True

owner string

`CREATE DATABASE`の`OWNER`パラメーターにマップします。<br />`ALTER DATABASE`の`OWNER TO`コマンドにマップします。<br />PostgreSQL内のデータベースを所有するユーザーのロール名。

True

template string

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

encoding string

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

locale string

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

localeProvider string

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

localeCollate string

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

localeCType string

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

icuLocale string

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

icuRules string

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

builtinLocale string

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

collationVersion string

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

isTemplate boolean

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

allowConnections boolean

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

connectionLimit integer

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

tablespace string

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

databaseReclaimPolicy * DatabaseReclaimPolicy *

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

retain

Enum: [delete retain] <br />

schemas * SchemaSpec array*

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

extensions * ExtensionSpec array*

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

fdws * FDWSpec array*

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

servers * ServerSpec array*

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

DatabaseStatus#

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

利用箇所:

Field

Description

Required

Default

Validation

observedGeneration integer

同期された最新の<br />目的の状態を表すシーケンス番号

applied boolean

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

message string

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

schemas * DatabaseObjectStatus array*

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

extensions * DatabaseObjectStatus array*

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

fdws * DatabaseObjectStatus array*

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

servers * DatabaseObjectStatus array*

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

EPASConfiguration#

EPASConfigurationには、 EDB Postgres Advanced Server固有の構成が含まれています

利用箇所:

Field

Description

Required

Default

Validation

audit boolean

trueの場合 edb_auditロギングを有効にします

tde * TDEConfiguration *

TDE構成

EmbeddedObjectMetadata#

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

利用箇所:

Field

Description

Required

Default

Validation

labels object (keys:string, values:string)

NA

annotations object (keys:string, values:string)

NA

EnsureOption#

基になる型 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 <br />Pattern: ^ :ref:`a-z0-9 <[-a-z0-9_]*[a-z0-9]> ?$` <br />

image * ImageVolumeSource *

拡張機能を含む画像。

extension_control_path string array

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

dynamic_library_path string array

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

ld_library_path string array

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

bin_path string array

PostgreSQLプロセスの`PATH`環境変数に追加するイメージ内のディレクトリのリスト。

env * ExtensionEnvVar array*

Envは、この拡張機能の<br />PostgreSQLプロセスで設定されるカスタム環境変数のリストです。変数が特定の拡張機能に対して正しいことを確認するのは<br />クラスタ管理者の責任です。これらの変数の変更を有効にするには、手動でクラスターを再起動する必要があることに注意してください。

ExtensionEnvVar#

ExtensionEnvVarは、特定の拡張イメージボリュームの環境変数を定義します。

利用箇所:

Field

Description

Required

Default

Validation

name string

PostgreSQLプロセスに注入される環境変数の名前。

True

MinLength: 1 <br />Pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$ <br />

value string

環境変数の値。 CloudNativePG™クラスターのEDB Postgres® AIは、プレースホルダー展開のサポートを使用して、この値の直接<br />置換を実行します。<br />${image_root}プレースホルダーは、拡張機能のボリュームの絶対マウントパス<br />に解決します。 `/extensions/my-extension`など。これは<br />アプリケーションまたはライブラリが<br />マウントされたイメージ内の特定のディレクトリを見つけられるようにする場合に特に役立ちます。<br />認識されないプレースホルダーは拒否されます。値にリテラル${...}<br />を含めるには、$${...}としてエスケープします。

True

MinLength: 1 <br />

ExtensionSpec#

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

利用箇所:

Field

Description

Required

Default

Validation

name string

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

True

ensure * EnsureOption *

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

present

Enum: [present absent] <br />

version string

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

True

schema string

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

True

ExternalCluster#

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

利用箇所:

Field

Description

Required

Default

Validation

name string

サーバー名必須

True

connectionParameters object (keys:string, values:string)

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

sslCert * SecretKeySelector *

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

sslKey * SecretKeySelector *

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

sslRootCert * SecretKeySelector *

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

password * SecretKeySelector *

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

barmanObjectStore * BarmanObjectStoreConfiguration *

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

plugin * BackupPluginConfiguration *

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

True

FDWSpec#

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

利用箇所:

Field

Description

Required

Default

Validation

name string

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

True

ensure * EnsureOption *

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

present

Enum: [present absent] <br />

handler string

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

validator string

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

owner string

所有者は、外部データラッパーを所有するデータベースロールを指定します。<br />ロールには、ターゲットデータベースのスーパーユーザー権限が必要です。

options * OptionSpec array*

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

usage * UsageSpec array*

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

FailoverQuorum#

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

Field

Description

Required

Default

Validation

apiVersion string

postgresql.k8s.enterprisedb.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は、同期する可能性のある<br />インスタンス名のリストです。

standbyNumber integer

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

primary string

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

ImageCatalog#

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

Field

Description

Required

Default

Validation

apiVersion string

postgresql.k8s.enterprisedb.io/v1

True

kind string

ImageCatalog

True

metadata * EmbeddedObjectMetadata *

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

True

spec * ImageCatalogSpec *

ImageCatalogの目的の動作の仕様。<br />詳細情報 <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は、参照されるリソースのグループです。<br />APIGroupが指定されない場合、指定されたKindはコアAPIグループにある必要があります。<br />他のサードパーティタイプの場合、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 <br />MinItems: 1 <br />

ImageInfo#

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

利用箇所:

Field

Description

Required

Default

Validation

image string

Imageはイメージ名です

True

majorVersion integer

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

True

extensions * ExtensionConfiguration array*

Extensionsには、現在のイメージで使用可能なコンテナイメージ拡張機能が含まれています

Import#

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

利用箇所:

Field

Description

Required

Default

Validation

source * ImportSource *

輸入元

True

type * SnapshotType *

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

True

Enum: [microservice monolith] <br />

databases string array

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

True

roles string array

インポートするロール

postImportApplicationSQL string array

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

schemaOnly boolean

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

pgDumpExtraOptions string array

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

pgRestoreExtraOptions string array

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

pgRestorePredataOptions string array

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

pgRestoreDataOptions string array

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

pgRestorePostdataOptions string array

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

ImportSource#

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

利用箇所:

Field

Description

Required

Default

Validation

externalCluster string

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

True

InstanceID#

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

利用箇所:

Field

Description

Required

Default

Validation

podName string

ポッド名

ContainerID string

コンテナID

sessionID string

インスタンスマネージャーのセッションID。これは、インスタンスマネージャーの<br />起動時に生成され、再起動のたびに変更されますコンテナのリブートを含む。バックアップのような長時間実行オペレーション中にインスタンスマネージャーが再起動されたかどうかを検出するために使用されます。これにより、実行中のバックアッププロセスが終了します。

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] <br />

bindAsAuth * LDAPBindAsAuth *

認証構成としてバインド

bindSearchAuth * LDAPBindSearchAuth *

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

tls boolean

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

LDAPScheme#

基になる型 string

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

利用箇所:

Field

Description

ldap

NA

ldaps

NA

LivenessProbe#

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

利用箇所:

Field

Description

Required

Default

Validation

initialDelaySeconds integer

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

timeoutSeconds integer

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

periodSeconds integer

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

successThreshold integer

失敗した後に成功したと見なされるプローブの最小連続成功。<br />デフォルト1。 livenessおよびstartupの場合は1である必要があります。最小値は1です。

failureThreshold integer

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

terminationGracePeriodSeconds integer

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

isolationCheck * IsolationCheckConfiguration *

プライマリ<br />インスタンスのlivenessプローブを拡張する機能を構成します。基本的なチェックに加えて、これは<br />プライマリがKubernetes APIサーバーおよびその<br />レプリカから分離されているかどうかを検証し、ネットワーク<br />パーティションまたは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: :ref:`RoleStatus<RoleStatus>` , values:string array)

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

cannotReconcile object (keys:string, values:string array)

CannotReconcileは、PostgreSQLでリコンサイルできないロールをリストし<br />原因の説明

passwordStatus object (keys:string, values: :ref:`PasswordState<PasswordState>` )

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

ManagedService#

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

利用箇所:

Field

Description

Required

Default

Validation

selectorType * ServiceSelectorType *

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

True

Enum: [rw r ro] <br />

updateStrategy * ServiceUpdateStrategy *

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

patch

Enum: [patch replace] <br />

serviceTemplate * ServiceTemplateSpec *

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

True

ManagedServices#

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

利用箇所:

Field

Description

Required

Default

Validation

disabledDefaultServices * ServiceSelectorType array*

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

Enum: [rw r ro] <br />

additional * ManagedService array*

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

Metadata#

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

利用箇所:

Field

Description

Required

Default

Validation

name string

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

labels object (keys:string, values:string)

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

annotations object (keys:string, values:string)

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

MonitoringConfiguration#

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

利用箇所:

Field

Description

Required

Default

Validation

disableDefaultQueries boolean

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

false

customQueriesConfigMap * ConfigMapKeySelector array*

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

customQueriesSecret * SecretKeySelector array*

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

enablePodMonitor boolean

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

false

tls * ClusterMonitoringTLSConfiguration *

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

podMonitorMetricRelabelings * archive_timeout array*

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

podMonitorRelabelings * archive_timeout array*

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

metricsQueriesTTL * Duration *

クエリから計算されたメトリックが最新であると考えられる間隔。<br />それを超えると、新しいスクレイプがクエリの再実行をトリガーします。<br />設定されていない場合、デフォルトの30秒に<br />これをゼロに設定すると、キャッシュメカニズムが無効になり、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がアーカイブされるのを待たずに。<br />この動作は、WALアーカイブを独立して監視するバックアップソフトウェアでのみ役立ちます。それ以外の場合、バックアップの一貫性を保つために必要なWALが欠落しており、バックアップを役に立たない可能性があります。<br />デフォルトまたはこのパラメータがtrueの場合、 pg_backup_stopは、アーカイブが<br />有効になっているときにWALがアーカイブされるまで待機します。<br / >スタンバイでは、これはarchive_mode = Alwaysの場合にのみ待機することを意味します。<br />プライマリの書き込みアクティビティが低い場合、プライマリでpg_switch_walを実行して即時実行をトリガーします。<br />セグメントスイッチ。

true

immediateCheckpoint boolean

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

OptionSpec#

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

利用箇所:

Field

Description

Required

Default

Validation

name string

オプションの名前

True

value string

オプションの値

True

ensure * EnsureOption *

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

present

Enum: [present absent] <br />

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#

基になる型 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] <br />

serverTLSSecret * LocalObjectReference *

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

serverCASecret * LocalObjectReference *

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

clientCASecret * LocalObjectReference *

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

clientTLSSecret * LocalObjectReference *

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

authQuerySecret * LocalObjectReference *

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

authQuery string

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

parameters object (keys:string, values:string)

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

pg_hba string array

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

paused boolean

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

false

PluginConfiguration#

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

利用箇所:

Field

Description

Required

Default

Validation

name string

Nameはプラグイン名です

True

enabled boolean

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

true

isWALArchiver boolean

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

false

parameters object (keys:string, values:string)

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

PluginStatus#

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

利用箇所:

Field

Description

Required

Default

Validation

name string

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

True

version string

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

True

capabilities string array

機能は<br />プラグインの機能のリストです。

operatorCapabilities string array

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

walCapabilities string array

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

backupCapabilities string array

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

restoreJobHookCapabilities string array

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

status string

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

PodName#

基になる型 string

PodNameはポッドの名前です

利用箇所:

PodSelectorRef#

PodSelectorRefは、 pg_hbaルールで使用する名前付けポッドラベルセレクターを定義します。クラスターの名前空間のセレクターと一致するポッドのIPは解決され、 ${podselector:NAME} 構文を介したpg_hbaアドレス拡張で利用できるようになります。

利用箇所:

Field

Description

Required

Default

Validation

name string

Nameは、pg_hbaルールでこのセレクターを参照するために使用される識別子<br />アドレスフィールドの${podselector:NAME}構文を介して。

True

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

selector * LabelSelector *

Selectorは、IPを解決する必要があるポッドを識別するラベルセレクターであり<br />ます。クラスターの名前空間内のポッドのみが考慮されます。

True

PodSelectorRefStatus#

PodSelectorRefStatusには、名前付けセレクターの解決されたポッドIPが含まれています。

利用箇所:

Field

Description

Required

Default

Validation

name string

Nameは、仕様のPodSelectorRefの名前に対応します。

True

ips string array

IPsは、セレクターに一致するポッドIPのリストです。各IPは単一のアドレスCIDR表記なし。

PodStatus#

基になる型 string

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

利用箇所:

PodTemplateSpec#

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

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

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

利用箇所:

Field

Description

Required

Default

Validation

metadata * EmbeddedObjectMetadata *

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

spec * PodSpec *

ポッドの目的の動作の仕様。<br />詳細情報 <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.k8s.enterprisedb.io/v1

True

kind string

Pooler

True

metadata * EmbeddedObjectMetadata *

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

True

spec * PoolerSpec *

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

True

status * PoolerStatus *

プーラーの最近観察されたステータス。このデータは最新でない可能性があります<br />。システムによって設定されます。読み取り専用。<br />詳細情報 <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 *

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

True

type * PoolerType *

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

rw

Enum: [rw ro r] <br />

instances integer

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

1

template * PodTemplateSpec *

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

pgbouncer * PgBouncerSpec *

PgBouncer構成

True

deploymentStrategy * DeploymentStrategy *

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

monitoring * PoolerMonitoringConfiguration *

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

serviceTemplate * ServiceTemplateSpec *

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

serviceAccountName string

プーラーに使用する同じ名前空間内の既存のサービスアカウントの名前。<br />指定されると、オペレーターは新しいサービスアカウントを作成しません<br />提供されたものを使用します。これは、複数のプーラー間で単一の<br />サービスアカウントを共有する場合に役立ちますクラウドIAM構成など。<br />指定しない場合、プーラー名でサービスアカウントが作成されます。

MaxLength: 253 <br />Pattern: ^ :ref:`a-z0-9 <[-a-z0-9]*[a-z0-9]> ?$` <br />

PoolerStatus#

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

利用箇所:

Field

Description

Required

Default

Validation

secrets * PoolerSecrets *

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

instances integer

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

PoolerType#

基になる型 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ファイルに追加する行<br />。<br />${podselector:NAME}構文を使用して、ポッドセレクターを参照します。<br />ルールが展開されますそのセレクターと一致する各Pod IPごとに。

pg_ident string array

PostgreSQLのユーザー名マップルール pg_ident.confファイルに追加される行<br />

epas * EPASConfiguration *

EDB Postgres Advanced Server固有の構成

syncReplicaElectionConstraint * SyncReplicaElectionConstraints *

同期レプリカが満たす要件。これは、「synchronous_standby_names」パラメーターの<br />設定に影響します。

shared_preload_libraries string array

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

ldap * LDAPConfig *

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

promotionTimeout integer

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

enableAlterSystem boolean

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

extensions * ExtensionConfiguration array*

追加する拡張機能の構成

PrimaryUpdateMethod#

基になる型 string

PrimaryUpdateMethodは、ローリング更新の一部としてクラスターのプライマリインスタンスをアップグレードするときに使用する方法を定義します。デフォルトの方法は「restart」です

利用箇所:

Field

Description

switchover

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

restart

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

PrimaryUpdateStrategy#

基になる型 string

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

利用箇所:

Field

Description

supervised

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

unsupervised

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

Probe#

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

利用箇所:

Field

Description

Required

Default

Validation

initialDelaySeconds integer

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

timeoutSeconds integer

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

periodSeconds integer

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

successThreshold integer

失敗した後に成功したと見なされるプローブの最小連続成功。<br />デフォルト1。 livenessおよびstartupの場合は1である必要があります。最小値は1です。

failureThreshold integer

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

terminationGracePeriodSeconds integer

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

ProbeStrategyType#

基になる型 string

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

利用箇所:

Field

Description

pg_isready

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

streaming

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

query

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

ProbeWithStrategy#

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

利用箇所:

Field

Description

Required

Default

Validation

initialDelaySeconds integer

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

timeoutSeconds integer

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

periodSeconds integer

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

successThreshold integer

失敗した後に成功したと見なされるプローブの最小連続成功。<br />デフォルト1。 livenessおよびstartupの場合は1である必要があります。最小値は1です。

failureThreshold integer

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

terminationGracePeriodSeconds integer

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

type * ProbeStrategyType *

プローブ戦略

Enum: [pg_isready streaming query] <br />

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.k8s.enterprisedb.io/v1

True

kind string

Publication

True

metadata * EmbeddedObjectMetadata *

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

True

spec * PublicationSpec *

NA

True

status * PublicationStatus *

NA

True

PublicationReclaimPolicy#

基になる型 string

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

利用箇所:

Field

Description

delete

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

retain

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

PublicationSpec#

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

利用箇所:

Field

Description

Required

Default

Validation

cluster * LocalObjectReference *

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

True

name string

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

True

dbname string

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

True

parameters object (keys:string, values:string)

`WITH`句のパブリケーションパラメーター一部<br />PostgreSQL `CREATE PUBLICATION`コマンド

target * PublicationTarget *

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

True

publicationReclaimPolicy * PublicationReclaimPolicy *

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

retain

Enum: [delete retain] <br />

PublicationStatus#

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

利用箇所:

Field

Description

Required

Default

Validation

observedGeneration integer

同期された最新の<br />目的の状態を表すシーケンス番号

applied boolean

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

message string

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

PublicationTarget#

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

利用箇所:

Field

Description

Required

Default

Validation

allTables boolean

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

objects * PublicationTargetObject array*

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

MaxItems: 100000 <br />

PublicationTargetObject#

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

利用箇所:

Field

Description

Required

Default

Validation

tablesInSchema string

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

table * PublicationTargetTable *

パブリケーションに追加するテーブルのリストを指定します。 PostgreSQLの`FOR TABLE`に<br />相当します。

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。<br />空のデフォルト場合、オペレーターは指定されている場合、targetTimeまたはtargetLSNに基づいて、バックアップを自動的に検出します。それ以外の場合は、<br />使用可能な最新のバックアップを時系列で使用します。

targetTLI string

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

targetXID string

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

targetName string

ターゲット名以前に作成します<br />`pg_create_restore_point`で

targetLSN string

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

targetTime string

RFC3339形式またはPostgreSQLタイムスタンプ形式のタイムスタンプとしてのターゲット時間。<br />明示的なタイムゾーンのないタイムスタンプはUTCとして解釈されます。

targetImmediate boolean

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

exclusive boolean

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

ReplicaClusterConfiguration#

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

利用箇所:

Field

Description

Required

Default

Validation

self string

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

primary string

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

source string

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

True

MinLength: 1 <br />

enabled boolean

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

promotionToken string

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

minApplyDelay * Duration *

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

ReplicationSlotsConfiguration#

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

利用箇所:

Field

Description

Required

Default

Validation

highAvailability * ReplicationSlotsHAConfiguration *

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

updateInterval integer

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

Minimum: 1 <br />

synchronizeReplicas * SynchronizeReplicasConfiguration *

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

ReplicationSlotsHAConfiguration#

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

利用箇所:

Field

Description

Required

Default

Validation

enabled boolean

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

slotPrefix string

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

Pattern: ^[0-9a-z_]*$ <br />

synchronizeLogicalDecoding boolean

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

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] <br />

passwordSecret * LocalObjectReference *

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

connectionLimit integer

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

-1

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

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

inRoles string array

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

inherit boolean

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

true

disablePassword boolean

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

superuser boolean

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

createdb boolean

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

createrole boolean

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

login boolean

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

replication boolean

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

bypassrls boolean

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

RoleStatus#

基になる型 string

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

利用箇所:

Field

Description

reconciled

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

not-managed

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

pending-reconciliation

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

reserved

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

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.k8s.enterprisedb.io/v1

True

kind string

ScheduledBackup

True

metadata * EmbeddedObjectMetadata *

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

True

spec * ScheduledBackupSpec *

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

True

status * ScheduledBackupStatus *

ScheduledBackupの最近観察されたステータス。このデータは最新でない可能性があります<br />。システムによって設定されます。読み取り専用。<br />詳細情報 <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ジョブで使用される形式に従いません。追加の秒指定子が含まれるため、<br /><https://pkg.go.dev/github.com/robfig/cron#hdr-を参照してください。 CRON_Expression_Format>

True

cluster * LocalObjectReference *

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

True

backupOwnerReference string

作成したバックアップリソース内にどのownerReferenceを配置するかを示します。<br />- none 作成したバックアップオブジェクトの所有者リファレンスなしフィールドが導入される前と同じ動作<br />- self スケジュールされたバックアップオブジェクトを所有者として設定しますバックアップの<br />-クラスター クラスターをバックアップの所有者として設定します<br />

none

Enum: [none self cluster] <br />

target * BackupTarget *

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

Enum: [primary prefer-standby] <br />

method * BackupMethod *

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

barmanObjectStore

Enum: [barmanObjectStore volumeSnapshot plugin] <br />

pluginConfiguration * BackupPluginConfiguration *

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

online boolean

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

onlineConfiguration * OnlineConfiguration *

ボリュームスナップショットを使用してオンライン/ホットバックアップを制御する構成パラメーター<br />クラスター '.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 *

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

present

Enum: [present absent] <br />

owner string

PostgreSQL内のスキーマを所有するユーザーのロール名。<br />これは、`CREATE SCHEMA`の`AUTHORIZATION`パラメーターと`ALTER SCHEMA`の<br />`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)

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

ServerSpec#

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

利用箇所:

Field

Description

Required

Default

Validation

name string

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

True

ensure * EnsureOption *

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

present

Enum: [present absent] <br />

fdw string

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

True

options * OptionSpec array*

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

usage * UsageSpec array*

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

ServiceAccountTemplate#

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

利用箇所:

Field

Description

Required

Default

Validation

metadata * EmbeddedObjectMetadata *

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

True

ServiceSelectorType#

基になる型 string

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

検証

  • 列挙型 [rw r ro]

利用箇所:

Field

Description

rw

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

r

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

ro

ServiceSelectorTypeROは読み取り専用サービスを選択します。<br />

ServiceTemplateSpec#

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

利用箇所:

Field

Description

Required

Default

Validation

metadata * EmbeddedObjectMetadata *

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

spec * ServiceSpec *

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

ServiceUpdateStrategy#

基になる型 string

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

検証

  • 列挙型 [patch replace]

利用箇所:

SnapshotOwnerReference#

基になる型 string

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

利用箇所:

Field

Description

none

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

backup

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

cluster

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

SnapshotType#

基になる型 string

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

利用箇所:

Field

Description

monolith

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

microservice

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

StorageConfiguration#

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

利用箇所:

Field

Description

Required

Default

Validation

storageClass string

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

size string

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

resizeInUseVolumes boolean

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

true

pvcTemplate * PersistentVolumeClaimSpec *

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

Subscription#

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

Field

Description

Required

Default

Validation

apiVersion string

postgresql.k8s.enterprisedb.io/v1

True

kind string

Subscription

True

metadata * EmbeddedObjectMetadata *

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

True

spec * SubscriptionSpec *

NA

True

status * SubscriptionStatus *

NA

True

SubscriptionReclaimPolicy#

基になる型 string

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

利用箇所:

Field

Description

delete

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

retain

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

SubscriptionSpec#

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

利用箇所:

Field

Description

Required

Default

Validation

cluster * LocalObjectReference *

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

True

name string

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

True

dbname string

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

True

parameters object (keys:string, values:string)

PostgreSQLの`WITH`句に含まれるサブスクリプションパラメーター<br />`CREATE SUBSCRIPTION`コマンド。ほとんどのパラメーターはサブスクリプションの作成後<br />変更できません。後で変更しても無視されます。ただし、次の場所に文書化されている限定セットを除きます。<br />< <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データベース内のパブリケーションの名前<br />「パブリッシャー」

True

publicationDBName string

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

externalClusterName string

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

True

subscriptionReclaimPolicy * SubscriptionReclaimPolicy *

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

retain

Enum: [delete retain] <br />

SubscriptionStatus#

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

利用箇所:

Field

Description

Required

Default

Validation

observedGeneration integer

同期された最新の<br />目的の状態を表すシーケンス番号

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

excludePatterns string array

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

SynchronousReplicaConfiguration#

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

利用箇所:

Field

Description

Required

Default

Validation

method * SynchronousReplicaConfigurationMethod *

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

True

Enum: [any first] <br />

number integer

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

True

maxStandbyNamesFromCluster integer

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

standbyNamesPre string array

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

standbyNamesPost string array

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

dataDurability * DataDurabilityLevel *

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

Enum: [required preferred] <br />

failoverQuorum boolean

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

SynchronousReplicaConfigurationMethod#

基になる型 string

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

利用箇所:

TDEConfiguration#

TDEConfigurationには、透過的データ暗号化構成が含まれています

利用箇所:

Field

Description

Required

Default

Validation

enabled boolean

TDEを有効にする場合はTrue

secretKeyRef * SecretKeySelector *

暗号化キーを含むシークレットへの参照

wrapCommand * SecretKeySelector *

WrapCommandは、ユーザーが提供するencryptコマンドです

unwrapCommand * SecretKeySelector *

UnwrapCommandは、ユーザーが提供する復号コマンドです

passphraseCommand * SecretKeySelector *

PassphraseCommandは、暗号化と復号化のためにOpenSSLコマンドに渡されます<br />パスフレーズを取得するために実行されるコマンド

TablespaceConfiguration#

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

利用箇所:

Field

Description

Required

Default

Validation

name string

テーブルスペースの名前

True

storage * StorageConfiguration *

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

True

owner * DatabaseRoleRef *

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

temporary boolean

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

false

TablespaceState#

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

利用箇所:

Field

Description

Required

Default

Validation

name string

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

True

owner string

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

state * TablespaceStatus *

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

True

error string

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

TablespaceStatus#

基になる型 string

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

利用箇所:

Field

Description

reconciled

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

pending

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

Topology#

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

利用箇所:

Field

Description

Required

Default

Validation

instances object (keys: :ref:`PodName<PodName>` , values: :ref:`PodTopologyLabels<PodTopologyLabels>` )

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

nodesUsed integer

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

successfullyExtracted boolean

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

UsageSpec#

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

利用箇所:

Field

Description

Required

Default

Validation

name string

使用の名前

True

type * UsageSpecType *

使用の種類

grant

Enum: [grant revoke] <br />

UsageSpecType#

基になる型 string

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

利用箇所:

Field

Description

grant

GrantUsageSpecTypeは、使用権限の付与を示します。<br />デフォルトの使用権限はgrantです。<br />

revoke

RevokeUsageSpecTypeは、使用権限の取り消しを示します。<br />

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に使用されるスナップショットクラスを指定します。<br />これは、特定のクラスが存在しない場合、他のタイプのデフォルトクラスです。

walClassName string

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

tablespaceClassName object (keys:string, values:string)

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

snapshotOwnerReference * SnapshotOwnerReference *

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

none

Enum: [none cluster backup] <br />

online boolean

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

true

onlineConfiguration * OnlineConfiguration *

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

{ immediateCheckpoint:false waitForArchive:true }
目次