APIリファレンス

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

Resource Types

Backup

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

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

Backup

metadata [Required] _meta/v1.ObjectMeta_

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

spec [Required] _BackupSpec_

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

status _BackupStatus_

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

Cluster

クラスターはPostgreSQL APIのスキーマです

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

Cluster

metadata [Required] _meta/v1.ObjectMeta_

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

spec [Required] _ClusterSpec_

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

status _ClusterStatus_

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

ClusterImageCatalog

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

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

ClusterImageCatalog

metadata [Required] _meta/v1.ObjectMeta_

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

spec [Required] _ImageCatalogSpec_

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

Database

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

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

Database

metadata [Required] _meta/v1.ObjectMeta_

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

spec [Required] _DatabaseSpec_

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

status _DatabaseStatus_

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

FailoverQuorum

利用箇所

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

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

FailoverQuorum

metadata [Required] _meta/v1.ObjectMeta_

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

status _FailoverQuorumStatus_

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

ImageCatalog

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

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

ImageCatalog

metadata [Required] _meta/v1.ObjectMeta_

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

spec [Required] _ImageCatalogSpec_

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

Pooler

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

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

Pooler

metadata [Required] _meta/v1.ObjectMeta_

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

spec [Required] _PoolerSpec_

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

status _PoolerStatus_

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

Publication

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

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

Publication

metadata [Required] _meta/v1.ObjectMeta_

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

spec [Required] _PublicationSpec_

説明はありません。

status [Required] _PublicationStatus_

説明はありません。

ScheduledBackup

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

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

ScheduledBackup

metadata [Required] _meta/v1.ObjectMeta_

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

spec [Required] _ScheduledBackupSpec_

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

status _ScheduledBackupStatus_

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

Subscription

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

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

Subscription

metadata [Required] _meta/v1.ObjectMeta_

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

spec [Required] _SubscriptionSpec_

説明はありません。

status [Required] _SubscriptionStatus_

説明はありません。

AffinityConfiguration

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

enablePodAntiAffinity _bool_

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

topologyKey _string_

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

nodeSelector _map[string]string_

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

nodeAffinity _core/v1.NodeAffinity_

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

tolerations [_[]core/v1.Toleration_](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#toleration-v1-core)

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 _core/v1.PodAntiAffinity_

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

additionalPodAffinity _core/v1.PodAffinity_

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

AvailableArchitecture

利用箇所

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

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

Field

Description

goArch [Required] _string_

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

hash [Required] _string_

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

BackupConfiguration

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

volumeSnapshot _VolumeSnapshotConfiguration_

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

barmanObjectStore _github.com/cloudnative-pg/barman-cloud/pkg/api.BarmanObjectStoreConfiguration_

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

retentionPolicy _string_

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

target _BackupTarget_

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

BackupMethod

string のエイリアス

利用箇所

  • BackupSpec {postgresql-cnpg-io-v1-BackupSpec}

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

BackupPhase

string のエイリアス

利用箇所

  • BackupStatus {postgresql-cnpg-io-v1-BackupStatus}

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

BackupPluginConfiguration

利用箇所

  • BackupSpec {postgresql-cnpg-io-v1-BackupSpec}

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

Field

Description

name [Required] _string_

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

parameters _map[string]string_

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

BackupSnapshotElementStatus

利用箇所

  • BackupSnapshotStatus {postgresql-cnpg-io-v1-BackupSnapshotStatus}

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

Field

Description

name [Required] _string_

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

type [Required] _string_

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

tablespaceName _string_

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

BackupSnapshotStatus

利用箇所

  • BackupStatus {postgresql-cnpg-io-v1-BackupStatus}

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

Field

Description

elements [_[]BackupSnapshotElementStatus_](BackupSnapshotElementStatus)

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

BackupSource

利用箇所

  • BootstrapRecovery {postgresql-cnpg-io-v1-BootstrapRecovery}

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

Field

Description

LocalObjectReference _github.com/cloudnative-pg/machinery/pkg/api.LocalObjectReference_

`LocalObjectReference`のメンバーはこのタイプに埋め込まれます。説明はありません。

endpointCA _github.com/cloudnative-pg/machinery/pkg/api.SecretKeySelector_

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

BackupSpec

利用箇所

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

Field

Description

cluster [Required] _github.com/cloudnative-pg/machinery/pkg/api.LocalObjectReference_

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

target _BackupTarget_

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

method _BackupMethod_

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

pluginConfiguration _BackupPluginConfiguration_

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

online _bool_

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

onlineConfiguration _OnlineConfiguration_

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

BackupStatus

利用箇所

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

Field

Description

BarmanCredentials _github.com/cloudnative-pg/barman-cloud/pkg/api.BarmanCredentials_

`BarmanCredentials`のメンバーはこのタイプに埋め込まれます。各クラウドプロバイダーの潜在的な資格情報

endpointCA _github.com/cloudnative-pg/machinery/pkg/api.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 _meta/v1.Time_

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

stoppedAt _meta/v1.Time_

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

beginWal _string_

開始するWAL

endWal _string_

エンディングWAL

beginLSN _string_

スタートxlog

endLSN _string_

エンディングxlog

error _string_

検出されたエラー

commandOutput _string_

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

commandError _string_

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

backupLabelFile _[]byte_

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

tablespaceMapFile _[]byte_

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

instanceID _InstanceID_

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

snapshotBackupStatus _BackupSnapshotStatus_

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

method _BackupMethod_

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

online _bool_

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

pluginMetadata _map[string]string_

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

BackupTarget

string のエイリアス

利用箇所

  • BackupConfiguration {postgresql-cnpg-io-v1-BackupConfiguration}

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

BootstrapConfiguration

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

initdb _BootstrapInitDB_

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

recovery _BootstrapRecovery_

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

pg_basebackup _BootstrapPgBaseBackup_

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

BootstrapInitDB

利用箇所

  • BootstrapConfiguration {postgresql-cnpg-io-v1-BootstrapConfiguration}

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

Field

Description

database _string_

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

owner _string_

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

secret _github.com/cloudnative-pg/machinery/pkg/api.LocalObjectReference_

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

options _[]string_

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

dataChecksums _bool_

-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 _int_

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

postInitSQL _[]string_

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

postInitApplicationSQL _[]string_

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

postInitTemplateSQL _[]string_

クラスターが作成された直後に`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

利用箇所

  • BootstrapConfiguration {postgresql-cnpg-io-v1-BootstrapConfiguration}

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

Field

Description

source [Required] _string_

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

database _string_

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

owner _string_

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

secret _github.com/cloudnative-pg/machinery/pkg/api.LocalObjectReference_

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

BootstrapRecovery

利用箇所

  • BootstrapConfiguration {postgresql-cnpg-io-v1-BootstrapConfiguration}

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

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

Field

Description

backup _BackupSource_

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

source _string_

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

volumeSnapshots _DataSource_

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

recoveryTarget _RecoveryTarget_ by specifying a RecoveryTarget object, as expected by PostgreSQL (i.e., timestamp, transaction Id, LSN, ...). More info: https://www.postgresql.org/docs/current/runtime-config-wal.html#RUNTIME-CONFIG-WAL-RECOVERY-TARGET

NA

database _string_

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

owner _string_

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

secret _github.com/cloudnative-pg/machinery/pkg/api.LocalObjectReference_

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

CatalogImage

利用箇所

  • ImageCatalogSpec {postgresql-cnpg-io-v1-ImageCatalogSpec}

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

Field

Description

image [Required] _string_

画像参照

major [Required] _int_

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

CertificatesConfiguration

利用箇所

  • CertificatesStatus {postgresql-cnpg-io-v1-CertificatesStatus}

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

Field

Description

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_

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

CertificatesStatus

利用箇所

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

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

Field

Description

CertificatesConfiguration _CertificatesConfiguration_

`CertificatesConfiguration`のメンバーはこのタイプに埋め込まれています。サーバー証明書を処理するために必要な構成、必要に応じてデフォルト値で初期化されます。

expirations _map[string]string_

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

ClusterMonitoringTLSConfiguration

利用箇所

  • MonitoringConfiguration {postgresql-cnpg-io-v1-MonitoringConfiguration}

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

Field

Description

enabled _bool_

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

ClusterSpec

利用箇所

ClusterSpecは、クラスターの望ましい状態を定義します

Field

Description

description _string_

このPostgreSQLクラスターの説明

inheritedMetadata _EmbeddedObjectMetadata_

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

imageName _string_

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

imageCatalogRef _ImageCatalogRef_

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

imagePullPolicy _core/v1.PullPolicy_

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

schedulerName _string_

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

postgresUID _int64_

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

postgresGID _int64_

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

instances [Required] _int_

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

minSyncReplicas _int_

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

maxSyncReplicas _int_

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

postgresql _PostgresConfiguration_

PostgreSQLサーバーの構成

replicationSlots _ReplicationSlotsConfiguration_

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

bootstrap _BootstrapConfiguration_

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

replica _ReplicaClusterConfiguration_

レプリカクラスター構成

superuserSecret _github.com/cloudnative-pg/machinery/pkg/api.LocalObjectReference_

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

enableSuperuserAccess _bool_

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

certificates _CertificatesConfiguration_

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

imagePullSecrets [_[]github.com/cloudnative-pg/machinery/pkg/api.LocalObjectReference_](https://pkg.go.dev/github.com/cloudnative-pg/machinery/pkg/api/#LocalObjectReference)

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

storage _StorageConfiguration_

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

serviceAccountTemplate _ServiceAccountTemplate_

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

walStorage _StorageConfiguration_

NA

ephemeralVolumeSource _core/v1.EphemeralVolumeSource_

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

startDelay _int32_

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

stopDelay _int32_

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

smartShutdownTimeout _int32_

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

switchoverDelay _int32_

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

failoverDelay _int32_

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

livenessProbeTimeout _int32_

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

affinity _AffinityConfiguration_

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

topologySpreadConstraints [_[]core/v1.TopologySpreadConstraint_](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#topologyspreadconstraint-v1-core)

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

resources _core/v1.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_ or manual (supervised)

NA

primaryUpdateMethod _PrimaryUpdateMethod_

NA

backup _BackupConfiguration_

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

nodeMaintenanceWindow _NodeMaintenanceWindow_

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

monitoring _MonitoringConfiguration_

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

externalClusters [_[]ExternalCluster_](ExternalCluster)

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

logLevel _string_

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

projectedVolumeTemplate _core/v1.ProjectedVolumeSource_

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

env [_[]core/v1.EnvVar_](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core)

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

envFrom [_[]core/v1.EnvFromSource_](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core)

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

managed _ManagedConfiguration_

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

seccompProfile _core/v1.SeccompProfile_

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

tablespaces [_[]TablespaceConfiguration_](TablespaceConfiguration)

テーブルスペース構成

enablePDB _bool_

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

plugins [_[]PluginConfiguration_](PluginConfiguration)

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

probes _ProbesConfiguration_

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

ClusterStatus

利用箇所

ClusterStatusは、クラスターの観察された状態を定義します

Field

Description

instances _int_

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

readyInstances _int_

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

instancesStatus _map[PodStatus][]string_

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

instancesReportedState [_map[PodName]InstanceReportedState_](InstanceReportedState)

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

managedRolesStatus _ManagedRoles_

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

tablespacesStatus [_[]TablespaceState_](TablespaceState)

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

timelineID _int_

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

topology _Topology_

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

latestGeneratedNode _int_

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

currentPrimary _string_

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

targetPrimary _string_

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

lastPromotionToken _string_

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

pvcCount _int32_

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

jobCount _int32_

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

danglingPVC _[]string_

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

resizingPVC _[]string_

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

initializingPVC _[]string_

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

healthyPVC _[]string_

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

unusablePVC _[]string_

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

writeService _string_

現在の書き込みポッド

readService _string_

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

phase _string_

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

phaseReason _string_

現在のフェーズの理由

secretsResourceVersion _SecretsResourceVersion_

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

configMapResourceVersion _ConfigMapResourceVersion_

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

certificates _CertificatesStatus_

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

firstRecoverabilityPoint _string_

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

firstRecoverabilityPointByMethod [_map[BackupMethod]meta/v1.Time_](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)

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

lastSuccessfulBackup _string_

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

lastSuccessfulBackupByMethod [_map[BackupMethod]meta/v1.Time_](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)

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

lastFailedBackup _string_

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

cloudNativePGCommitHash _string_

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

currentPrimaryTimestamp _string_

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

currentPrimaryFailingSinceTimestamp _string_

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

targetPrimaryTimestamp _string_

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

poolerIntegrations _PoolerIntegrations_

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

cloudNativePGOperatorHash _string_

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

availableArchitectures [_[]AvailableArchitecture_](AvailableArchitecture)

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

conditions [_[]meta/v1.Condition_](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta)

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

instanceNames _[]string_

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

onlineUpdateEnabled _bool_

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

image _string_

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

pgDataImageInfo _ImageInfo_

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

pluginStatus [_[]PluginStatus_](PluginStatus)

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

switchReplicaClusterStatus _SwitchReplicaClusterStatus_

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

demotionToken _string_

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

systemID _string_

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

ConfigMapResourceVersion

利用箇所

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

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

Field

Description

metrics _map[string]string_

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

DataDurabilityLevel

string のエイリアス

利用箇所

  • SynchronousReplicaConfiguration {postgresql-cnpg-io-v1-SynchronousReplicaConfiguration}

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

DataSource

利用箇所

  • BootstrapRecovery {postgresql-cnpg-io-v1-BootstrapRecovery}

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

Field

Description

storage [Required] _core/v1.TypedLocalObjectReference_

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

walStorage _core/v1.TypedLocalObjectReference_

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

tablespaceStorage [_map[string]core/v1.TypedLocalObjectReference_](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#typedlocalobjectreference-v1-core)

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

DatabaseObjectSpec

利用箇所

  • ExtensionSpec {postgresql-cnpg-io-v1-ExtensionSpec}

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

Field

Description

name [Required] _string_

拡張機能/スキーマの名前

ensure _EnsureOption_

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

DatabaseObjectStatus

利用箇所

  • DatabaseStatus {postgresql-cnpg-io-v1-DatabaseStatus}

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

Field

Description

name [Required] _string_

オブジェクトの名前

applied [Required] _bool_

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

message _string_

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

DatabaseReclaimPolicy

string のエイリアス

利用箇所

  • DatabaseSpec {postgresql-cnpg-io-v1-DatabaseSpec}

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

DatabaseRoleRef

利用箇所

  • TablespaceConfiguration {postgresql-cnpg-io-v1-TablespaceConfiguration}

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

Field

Description

name _string_

説明はありません。

DatabaseSpec

利用箇所

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

Field

Description

cluster [Required] _core/v1.LocalObjectReference_

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

ensure _EnsureOption_

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

name [Required] _string_

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

owner [Required] _string_

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

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 _bool_

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

allowConnections _bool_

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

connectionLimit _int_

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

tablespace _string_

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

databaseReclaimPolicy _DatabaseReclaimPolicy_

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

schemas [_[]SchemaSpec_](SchemaSpec)

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

extensions [_[]ExtensionSpec_](ExtensionSpec)

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

fdws [_[]FDWSpec_](FDWSpec)

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

DatabaseStatus

利用箇所

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

Field

Description

observedGeneration _int64_

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

applied _bool_

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

message _string_

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

schemas [_[]DatabaseObjectStatus_](DatabaseObjectStatus)

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

extensions [_[]DatabaseObjectStatus_](DatabaseObjectStatus)

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

fdws [_[]DatabaseObjectStatus_](DatabaseObjectStatus)

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

EmbeddedObjectMetadata

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

labels _map[string]string_

説明はありません。

annotations _map[string]string_

説明はありません。

EnsureOption

string のエイリアス

利用箇所

  • DatabaseObjectSpec {postgresql-cnpg-io-v1-DatabaseObjectSpec}

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

EphemeralVolumesSizeLimitConfiguration

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

shm _k8s.io/apimachinery/pkg/api/resource.Quantity_

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

temporaryData _k8s.io/apimachinery/pkg/api/resource.Quantity_

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

ExtensionConfiguration

利用箇所

  • PostgresConfiguration {postgresql-cnpg-io-v1-PostgresConfiguration}

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

Field

Description

name [Required] _string_

拡張機能の名前、必須

image [Required] _core/v1.ImageVolumeSource_

拡張機能を含む画像必須

extension_control_path _[]string_

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

dynamic_library_path _[]string_

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

ld_library_path _[]string_

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

ExtensionSpec

利用箇所

  • DatabaseSpec {postgresql-cnpg-io-v1-DatabaseSpec}

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

Field

Description

DatabaseObjectSpec _DatabaseObjectSpec_

`DatabaseObjectSpec`のメンバーはこのタイプに埋め込まれます。共通フィールド

version [Required] _string_

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

schema [Required] _string_

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

ExternalCluster

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

name [Required] _string_

サーバー名必須

connectionParameters _map[string]string_

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

sslCert _core/v1.SecretKeySelector_

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

sslKey _core/v1.SecretKeySelector_

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

sslRootCert _core/v1.SecretKeySelector_

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

password _core/v1.SecretKeySelector_

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

barmanObjectStore _github.com/cloudnative-pg/barman-cloud/pkg/api.BarmanObjectStoreConfiguration_

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

plugin [Required] _PluginConfiguration_

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

FDWSpec

利用箇所

  • DatabaseSpec {postgresql-cnpg-io-v1-DatabaseSpec}

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

Field

Description

DatabaseObjectSpec _DatabaseObjectSpec_

`DatabaseObjectSpec`のメンバーはこのタイプに埋め込まれます。共通フィールド

handler _string_

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

validator _string_

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

owner _string_

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

options [_[]OptionSpec_](OptionSpec)

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

usage [_[]UsageSpec_](UsageSpec)

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

FailoverQuorumStatus

利用箇所

  • FailoverQuorum {postgresql-cnpg-io-v1-FailoverQuorum}

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

Field

Description

method _string_

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

standbyNames _[]string_

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

standbyNumber _int_

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

primary _string_

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

ImageCatalogRef

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

TypedLocalObjectReference _core/v1.TypedLocalObjectReference_

`TypedLocalObjectReference`のメンバーはこのタイプに埋め込まれます。説明はありません。

major [Required] _int_

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

ImageCatalogSpec

利用箇所

  • ClusterImageCatalog {postgresql-cnpg-io-v1-ClusterImageCatalog}

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

Field

Description

images [Required] [_[]CatalogImage_](CatalogImage)

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

ImageInfo

利用箇所

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

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

Field

Description

image [Required] _string_

Imageはイメージ名です

majorVersion [Required] _int_

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

Import

利用箇所

  • BootstrapInitDB {postgresql-cnpg-io-v1-BootstrapInitDB}

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

Field

Description

source [Required] _ImportSource_

輸入元

type [Required] _SnapshotType_

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

databases [Required] _[]string_

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

roles _[]string_

インポートするロール

postImportApplicationSQL _[]string_

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

schemaOnly _bool_

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

pgDumpExtraOptions _[]string_

`pg_dump`コマンドに渡すカスタムオプションのリスト。重要 オペレーターはコンテンツを検証していないため、これらのオプションは自分自身の責任で注意して使用します。特定のオプションは、オペレーターの意図した機能またはデザインと競合する場合があることに注意してください。

pgRestoreExtraOptions _[]string_

`pg_restore`コマンドに渡すカスタムオプションのリスト。重要 オペレーターはコンテンツを検証していないため、これらのオプションは自分自身の責任で注意して使用します。特定のオプションは、オペレーターの意図した機能またはデザインと競合する場合があることに注意してください。

ImportSource

利用箇所

  • Import {postgresql-cnpg-io-v1-Import}

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

Field

Description

externalCluster [Required] _string_

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

InstanceID

利用箇所

  • BackupStatus {postgresql-cnpg-io-v1-BackupStatus}

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

Field

Description

podName _string_

ポッド名

ContainerID _string_

コンテナID

InstanceReportedState

利用箇所

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

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

Field

Description

isPrimary [Required] _bool_

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

timeLineID _int_

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

ip [Required] _string_

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

IsolationCheckConfiguration

利用箇所

  • LivenessProbe {postgresql-cnpg-io-v1-LivenessProbe}

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

Field

Description

enabled _bool_

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

requestTimeout _int_

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

connectionTimeout _int_

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

LDAPBindAsAuth

利用箇所

  • LDAPConfig {postgresql-cnpg-io-v1-LDAPConfig}

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

Field

Description

prefix _string_

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

suffix _string_

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

LDAPBindSearchAuth

利用箇所

  • LDAPConfig {postgresql-cnpg-io-v1-LDAPConfig}

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

Field

Description

baseDN _string_

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

bindDN _string_

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

bindPassword _core/v1.SecretKeySelector_

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

searchAttribute _string_

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

searchFilter _string_

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

LDAPConfig

利用箇所

  • PostgresConfiguration {postgresql-cnpg-io-v1-PostgresConfiguration}

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

Field

Description

server _string_

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

port _int_

LDAPサーバーポート

scheme _LDAPScheme_

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

bindAsAuth _LDAPBindAsAuth_

認証構成としてバインド

bindSearchAuth _LDAPBindSearchAuth_

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

tls _bool_

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

LDAPScheme

string のエイリアス

利用箇所

  • LDAPConfig {postgresql-cnpg-io-v1-LDAPConfig}

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

LivenessProbe

利用箇所

  • ProbesConfiguration {postgresql-cnpg-io-v1-ProbesConfiguration}

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

Field

Description

Probe _Probe_

`Probe`のメンバーはこのタイプに埋め込まれています。プローブは標準のプローブ構成です

isolationCheck _IsolationCheckConfiguration_

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

ManagedConfiguration

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

roles [_[]RoleConfiguration_](RoleConfiguration)

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

services _ManagedServices_

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

ManagedRoles

利用箇所

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

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

Field

Description

byStatus _map[RoleStatus][]string_

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

cannotReconcile _map[string][]string_

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

passwordStatus [_map[string]PasswordState_](PasswordState)

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

ManagedService

利用箇所

  • ManagedServices {postgresql-cnpg-io-v1-ManagedServices}

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

Field

Description

selectorType [Required] _ServiceSelectorType_

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

updateStrategy _ServiceUpdateStrategy_

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

serviceTemplate [Required] _ServiceTemplateSpec_

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

ManagedServices

利用箇所

  • ManagedConfiguration {postgresql-cnpg-io-v1-ManagedConfiguration}

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

Field

Description

disabledDefaultServices [_[]ServiceSelectorType_](ServiceSelectorType)

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

additional [_[]ManagedService_](ManagedService)

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

Metadata

利用箇所

  • PodTemplateSpec {postgresql-cnpg-io-v1-PodTemplateSpec}

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

Field

Description

name _string_

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

labels _map[string]string_

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

annotations _map[string]string_

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

MonitoringConfiguration

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

disableDefaultQueries _bool_

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

customQueriesConfigMap [_[]github.com/cloudnative-pg/machinery/pkg/api.ConfigMapKeySelector_](https://pkg.go.dev/github.com/cloudnative-pg/machinery/pkg/api/#ConfigMapKeySelector)

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

customQueriesSecret [_[]github.com/cloudnative-pg/machinery/pkg/api.SecretKeySelector_](https://pkg.go.dev/github.com/cloudnative-pg/machinery/pkg/api/#SecretKeySelector)

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

enablePodMonitor _bool_

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

tls _ClusterMonitoringTLSConfiguration_

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

podMonitorMetricRelabelings [_[]github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1.RelabelConfig_](https://pkg.go.dev/github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1#RelabelConfig)

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

podMonitorRelabelings [_[]github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1.RelabelConfig_](https://pkg.go.dev/github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1#RelabelConfig)

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

NodeMaintenanceWindow

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

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

Field

Description

reusePVC _bool_

既存のPVCを再利用するノードが再び起動するまで待機するか、他の場所で再作成します- instances >1の場合

inProgress _bool_

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

OnlineConfiguration

利用箇所

  • BackupSpec {postgresql-cnpg-io-v1-BackupSpec}

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

Field

Description

waitForArchive _bool_

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

immediateCheckpoint _bool_

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

OptionSpec

利用箇所

  • FDWSpec {postgresql-cnpg-io-v1-FDWSpec}

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

Field

Description

name [Required] _string_

オプションの名前

OptionSpecValue _OptionSpecValue_

`OptionSpecValue`のメンバーはこのタイプに埋め込まれます。

OptionSpecValue

利用箇所

  • OptionSpec {postgresql-cnpg-io-v1-OptionSpec}

OptionSpecValueは、オプションの値とensureフィールドを保持します

Field

Description

value [Required] _string_

オプションの値

ensure _EnsureOption_

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

PasswordState

利用箇所

  • ManagedRoles {postgresql-cnpg-io-v1-ManagedRoles}

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

Field

Description

transactionID _int64_

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

resourceVersion _string_

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

PgBouncerIntegrationStatus

利用箇所

  • PoolerIntegrations {postgresql-cnpg-io-v1-PoolerIntegrations}

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

Field

Description

secrets _[]string_

説明はありません。

PgBouncerPoolMode

string のエイリアス

利用箇所

  • PgBouncerSpec {postgresql-cnpg-io-v1-PgBouncerSpec}

PgBouncerPoolModeはPgBouncerのモードです

PgBouncerSecrets

利用箇所

  • PoolerSecrets {postgresql-cnpg-io-v1-PoolerSecrets}

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

Field

Description

authQuery _SecretVersion_

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

PgBouncerSpec

利用箇所

  • PoolerSpec {postgresql-cnpg-io-v1-PoolerSpec}

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

Field

Description

poolMode _PgBouncerPoolMode_

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

authQuerySecret _github.com/cloudnative-pg/machinery/pkg/api.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 _map[string]string_

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

pg_hba _[]string_

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

paused _bool_

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

PluginConfiguration

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

name [Required] _string_

Nameはプラグイン名です

enabled _bool_

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

isWALArchiver _bool_

WALArchiverとして宣言できるプラグインは1つだけです。 ".spec.backup.barmanObjectStore"構成が存在する場合、アクティブにできません。

parameters _map[string]string_

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

PluginStatus

利用箇所

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

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

Field

Description

name [Required] _string_

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

version [Required] _string_

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

capabilities _[]string_

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

operatorCapabilities _[]string_

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

walCapabilities _[]string_

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

backupCapabilities _[]string_

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

restoreJobHookCapabilities _[]string_

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

status _string_

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

PodTemplateSpec

利用箇所

  • PoolerSpec {postgresql-cnpg-io-v1-PoolerSpec}

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

metadata _Metadata_

標準オブジェクトのメタデータ。詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec _core/v1.PodSpec_

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

PodTopologyLabels

(`map[string]string` のエイリアス)

利用箇所

  • PodTopologyLabels {postgresql-cnpg-io-v1-PodTopologyLabels}

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

PoolerIntegrations

利用箇所

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

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

Field

Description

pgBouncerIntegration _PgBouncerIntegrationStatus_

説明はありません。

PoolerMonitoringConfiguration

利用箇所

  • PoolerSpec {postgresql-cnpg-io-v1-PoolerSpec}

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

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

Field

Description

enablePodMonitor _bool_

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

podMonitorMetricRelabelings [_[]github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1.RelabelConfig_](https://pkg.go.dev/github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1#RelabelConfig)

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

podMonitorRelabelings [_[]github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1.RelabelConfig_](https://pkg.go.dev/github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1#RelabelConfig)

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

PoolerSecrets

利用箇所

  • PoolerStatus {postgresql-cnpg-io-v1-PoolerStatus}

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

Field

Description

serverTLS _SecretVersion_

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

serverCA _SecretVersion_

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

clientCA _SecretVersion_

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

pgBouncerSecrets _PgBouncerSecrets_

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

PoolerSpec

利用箇所

  • Pooler {postgresql-cnpg-io-v1-Pooler}

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

Field

Description

cluster [Required] _github.com/cloudnative-pg/machinery/pkg/api.LocalObjectReference_

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

type _PoolerType_

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

instances _int32_

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

template _PodTemplateSpec_

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

pgbouncer [Required] _PgBouncerSpec_

PgBouncer構成

deploymentStrategy _apps/v1.DeploymentStrategy_

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

monitoring _PoolerMonitoringConfiguration_

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

serviceTemplate _ServiceTemplateSpec_

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

PoolerStatus

利用箇所

  • Pooler {postgresql-cnpg-io-v1-Pooler}

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

Field

Description

secrets _PoolerSecrets_

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

instances _int32_

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

PoolerType

string のエイリアス

利用箇所

  • PoolerSpec {postgresql-cnpg-io-v1-PoolerSpec}

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

PostgresConfiguration

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

PostgresConfigurationはPostgreSQL構成を定義します

Field

Description

parameters _map[string]string_

PostgreSQL構成オプションpostgresql.conf

synchronous _SynchronousReplicaConfiguration_

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

pg_hba _[]string_

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

pg_ident _[]string_

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

syncReplicaElectionConstraint _SyncReplicaElectionConstraints_

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

shared_preload_libraries _[]string_

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

ldap _LDAPConfig_

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

promotionTimeout _int32_

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

enableAlterSystem _bool_

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

extensions [_[]ExtensionConfiguration_](ExtensionConfiguration)

追加する拡張機能の構成

PrimaryUpdateMethod

string のエイリアス

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

PrimaryUpdateStrategy

string のエイリアス

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Probe

利用箇所

  • LivenessProbe {postgresql-cnpg-io-v1-LivenessProbe}

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

Field

Description

initialDelaySeconds _int32_

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

timeoutSeconds _int32_

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

periodSeconds _int32_

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

successThreshold _int32_

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

failureThreshold _int32_

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

terminationGracePeriodSeconds _int64_

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

ProbeStrategyType

string のエイリアス

利用箇所

  • ProbeWithStrategy {postgresql-cnpg-io-v1-ProbeWithStrategy}

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

ProbeWithStrategy

利用箇所

  • ProbesConfiguration {postgresql-cnpg-io-v1-ProbesConfiguration}

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

Field

Description

Probe _Probe_

`Probe`のメンバーはこのタイプに埋め込まれています。プローブは標準のプローブ構成です

type _ProbeStrategyType_

プローブ戦略

maximumLag _k8s.io/apimachinery/pkg/api/resource.Quantity_

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

ProbesConfiguration

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

startup [Required] _ProbeWithStrategy_

起動プローブ構成

liveness [Required] _LivenessProbe_

livenessプローブ構成

readiness [Required] _ProbeWithStrategy_

Readiness Probe構成

PublicationReclaimPolicy

string のエイリアス

利用箇所

  • PublicationSpec {postgresql-cnpg-io-v1-PublicationSpec}

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

PublicationSpec

利用箇所

  • Publication {postgresql-cnpg-io-v1-Publication}

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

Field

Description

cluster [Required] _core/v1.LocalObjectReference_

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

name [Required] _string_

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

dbname [Required] _string_

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

parameters _map[string]string_

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

target [Required] _PublicationTarget_

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

publicationReclaimPolicy _PublicationReclaimPolicy_

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

PublicationStatus

利用箇所

  • Publication {postgresql-cnpg-io-v1-Publication}

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

Field

Description

observedGeneration _int64_

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

applied _bool_

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

message _string_

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

PublicationTarget

利用箇所

  • PublicationSpec {postgresql-cnpg-io-v1-PublicationSpec}

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

Field

Description

allTables _bool_

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

objects [_[]PublicationTargetObject_](PublicationTargetObject)

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

PublicationTargetObject

利用箇所

  • PublicationTarget {postgresql-cnpg-io-v1-PublicationTarget}

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

Field

Description

tablesInSchema _string_

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

table _PublicationTargetTable_

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

PublicationTargetTable

利用箇所

  • PublicationTargetObject {postgresql-cnpg-io-v1-PublicationTargetObject}

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

Field

Description

only _bool_

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

name [Required] _string_

テーブル名

schema _string_

スキーマ名

columns _[]string_

公開する列

RecoveryTarget

利用箇所

  • BootstrapRecovery {postgresql-cnpg-io-v1-BootstrapRecovery}

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

Field

Description

backupID _string_

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

targetTLI _string_

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

targetXID _string_

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

targetName _string_

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

targetLSN _string_

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

targetTime _string_

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

targetImmediate _bool_

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

exclusive _bool_

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

ReplicaClusterConfiguration

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

self _string_

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

primary _string_

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

source [Required] _string_

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

enabled _bool_

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

promotionToken _string_

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

minApplyDelay _meta/v1.Duration_

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

ReplicationSlotsConfiguration

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

highAvailability _ReplicationSlotsHAConfiguration_

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

updateInterval _int_

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

synchronizeReplicas _SynchronizeReplicasConfiguration_

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

ReplicationSlotsHAConfiguration

利用箇所

  • ReplicationSlotsConfiguration {postgresql-cnpg-io-v1-ReplicationSlotsConfiguration}

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

Field

Description

enabled _bool_

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

slotPrefix _string_

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

synchronizeLogicalDecoding _bool_

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

RoleConfiguration

利用箇所

  • ManagedConfiguration {postgresql-cnpg-io-v1-ManagedConfiguration}

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

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

Field

Description

name [Required] _string_

ロールの名前

comment _string_

ロールの説明

ensure _EnsureOption_

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

passwordSecret _github.com/cloudnative-pg/machinery/pkg/api.LocalObjectReference_

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

connectionLimit _int64_

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

validUntil _meta/v1.Time_

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

inRoles _[]string_

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

inherit _bool_

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

disablePassword _bool_

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

superuser _bool_

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

createdb _bool_

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

createrole _bool_

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

login _bool_

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

replication _bool_

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

bypassrls _bool_

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

SQLRefs

利用箇所

  • BootstrapInitDB {postgresql-cnpg-io-v1-BootstrapInitDB}

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

Field

Description

secretRefs [_[]github.com/cloudnative-pg/machinery/pkg/api.SecretKeySelector_](https://pkg.go.dev/github.com/cloudnative-pg/machinery/pkg/api/#SecretKeySelector)

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

configMapRefs [_[]github.com/cloudnative-pg/machinery/pkg/api.ConfigMapKeySelector_](https://pkg.go.dev/github.com/cloudnative-pg/machinery/pkg/api/#ConfigMapKeySelector)

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

ScheduledBackupSpec

利用箇所

  • ScheduledBackup {postgresql-cnpg-io-v1-ScheduledBackup}

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

Field

Description

suspend _bool_

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

immediate _bool_

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

schedule [Required] _string_

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

cluster [Required] _github.com/cloudnative-pg/machinery/pkg/api.LocalObjectReference_

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

backupOwnerReference _string_

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

target _BackupTarget_

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

method _BackupMethod_

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

pluginConfiguration _BackupPluginConfiguration_

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

online _bool_

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

onlineConfiguration _OnlineConfiguration_

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

ScheduledBackupStatus

利用箇所

  • ScheduledBackup {postgresql-cnpg-io-v1-ScheduledBackup}

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

Field

Description

lastCheckTime _meta/v1.Time_

最新のスケジュール

lastScheduleTime _meta/v1.Time_

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

nextScheduleTime _meta/v1.Time_

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

SchemaSpec

利用箇所

  • DatabaseSpec {postgresql-cnpg-io-v1-DatabaseSpec}

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

Field

Description

DatabaseObjectSpec _DatabaseObjectSpec_

`DatabaseObjectSpec`のメンバーはこのタイプに埋め込まれます。共通フィールド

owner [Required] _string_

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

SecretVersion

利用箇所

  • PgBouncerSecrets {postgresql-cnpg-io-v1-PgBouncerSecrets}

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

Field

Description

name _string_

シークレットの名前

version _string_

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

SecretsResourceVersion

利用箇所

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

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

Field

Description

superuserSecretVersion _string_

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

replicationSecretVersion _string_

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

applicationSecretVersion _string_

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

managedRoleSecretVersion _map[string]string_

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

caSecretVersion _string_

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

clientCaSecretVersion _string_

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

serverCaSecretVersion _string_

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

serverSecretVersion _string_

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

barmanEndpointCA _string_

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

externalClusterSecretVersion _map[string]string_

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

metrics _map[string]string_

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

ServiceAccountTemplate

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

metadata [Required] _Metadata_

Metadataは、生成されたサービスアカウントに使用されるメタデータです

ServiceSelectorType

string のエイリアス

利用箇所

  • ManagedService {postgresql-cnpg-io-v1-ManagedService}

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

ServiceTemplateSpec

利用箇所

  • ManagedService {postgresql-cnpg-io-v1-ManagedService}

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

Field

Description

metadata _Metadata_

標準オブジェクトのメタデータ。詳細情報 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec _core/v1.ServiceSpec_

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

ServiceUpdateStrategy

string のエイリアス

利用箇所

  • ManagedService {postgresql-cnpg-io-v1-ManagedService}

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

SnapshotOwnerReference

string のエイリアス

利用箇所

  • VolumeSnapshotConfiguration {postgresql-cnpg-io-v1-VolumeSnapshotConfiguration}

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

SnapshotType

string のエイリアス

利用箇所

  • Import {postgresql-cnpg-io-v1-Import}

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

StorageConfiguration

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

storageClass _string_

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

size _string_

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

resizeInUseVolumes _bool_

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

pvcTemplate _core/v1.PersistentVolumeClaimSpec_

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

SubscriptionReclaimPolicy

string のエイリアス

利用箇所

  • SubscriptionSpec {postgresql-cnpg-io-v1-SubscriptionSpec}

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

SubscriptionSpec

利用箇所

  • Subscription {postgresql-cnpg-io-v1-Subscription}

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

Field

Description

cluster [Required] _core/v1.LocalObjectReference_

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

name [Required] _string_

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

dbname [Required] _string_

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

parameters _map[string]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 [Required] _string_

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

publicationDBName _string_

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

externalClusterName [Required] _string_

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

subscriptionReclaimPolicy _SubscriptionReclaimPolicy_

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

SubscriptionStatus

利用箇所

  • Subscription {postgresql-cnpg-io-v1-Subscription}

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

Field

Description

observedGeneration _int64_

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

applied _bool_

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

message _string_

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

SwitchReplicaClusterStatus

利用箇所

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

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

Field

Description

inProgress _bool_

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

SyncReplicaElectionConstraints

利用箇所

  • PostgresConfiguration {postgresql-cnpg-io-v1-PostgresConfiguration}

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

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

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

Field

Description

nodeLabelsAntiAffinity _[]string_

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

enabled [Required] _bool_

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

SynchronizeReplicasConfiguration

利用箇所

  • ReplicationSlotsConfiguration {postgresql-cnpg-io-v1-ReplicationSlotsConfiguration}

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

Field

Description

enabled [Required] _bool_

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

excludePatterns _[]string_

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

SynchronousReplicaConfiguration

利用箇所

  • PostgresConfiguration {postgresql-cnpg-io-v1-PostgresConfiguration}

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

Field

Description

method [Required] archive_timeout as values.

NA

number [Required] _int_

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

maxStandbyNamesFromCluster _int_

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

standbyNamesPre _[]string_

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

standbyNamesPost _[]string_

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

dataDurability _DataDurabilityLevel_

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

SynchronousReplicaConfigurationMethod

string のエイリアス

利用箇所

  • SynchronousReplicaConfiguration {postgresql-cnpg-io-v1-SynchronousReplicaConfiguration}

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

TablespaceConfiguration

利用箇所

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

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

Field

Description

name [Required] _string_

テーブルスペースの名前

storage [Required] _StorageConfiguration_

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

owner _DatabaseRoleRef_

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

temporary _bool_

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

TablespaceState

利用箇所

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

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

Field

Description

name [Required] _string_

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

owner _string_

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

state [Required] _TablespaceStatus_

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

error _string_

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

TablespaceStatus

string のエイリアス

利用箇所

  • TablespaceState {postgresql-cnpg-io-v1-TablespaceState}

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

Topology

利用箇所

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

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

Field

Description

instances [_map[PodName]PodTopologyLabels_](PodTopologyLabels)

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

nodesUsed _int32_

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

successfullyExtracted _bool_

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

UsageSpec

利用箇所

  • FDWSpec {postgresql-cnpg-io-v1-FDWSpec}

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

Field

Description

name [Required] _string_

使用の名前

type _string_

使用の種類

VolumeSnapshotConfiguration

利用箇所

  • BackupConfiguration {postgresql-cnpg-io-v1-BackupConfiguration}

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

Field

Description

labels _map[string]string_

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

annotations _map[string]string_

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

className _string_

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

walClassName _string_

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

tablespaceClassName _map[string]string_

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

snapshotOwnerReference _SnapshotOwnerReference_

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

online _bool_

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

onlineConfiguration _OnlineConfiguration_

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