APIリファレンス

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

リソースタイプ

Backup

BackupはバックアップAPIのスキーマです

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

バックアップ

metadata ** Required]** [*meta/v1.ObjectMeta*

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

spec ** archive_timeout

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

status archive_timeout

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

NA

クラスター

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

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

クラスター

metadata ** Required]** [*meta/v1.ObjectMeta*

説明はありません。メタデータフィールドのフィールドについては、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

NA

ClusterImageCatalog

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

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

クラスターイメージカタログ

metadata ** Required]** [*meta/v1.ObjectMeta*

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

spec ** Required]** [*ImageCatalogSpec*

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

NA

ImageCatalog

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

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

イメージカタログ

metadata ** Required]** [*meta/v1.ObjectMeta*

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

spec ** Required]** [*ImageCatalogSpec*

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

NA

プーラー

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

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

プーラー

metadata ** Required]** [*meta/v1.ObjectMeta*

説明はありません。メタデータフィールドのフィールドについては、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

NA

ScheduledBackup

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

Field

Description

apiVersion [Required] string

postgresql.cnpg.io/v1

kind [Required] string

スケジュールされたバックアップ

metadata ** Required]** [*meta/v1.ObjectMeta*

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

spec ** archive_timeout

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

status archive_timeout

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

NA

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*

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では、すべてのクラスターのポッドに渡されるポッドアフィニティ用語を指定できます。

NA

AvailableArchitecture

利用箇所

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

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

Field

Description

goArch [Required] string

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

hash [Required] string

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

NA

AzureCredentials

利用箇所

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

AzureCredentialsは、Azure Blob Storageにファイルをアップロードするために使用される資格情報のタイプです。接続文字列には、必要なすべての情報が含まれています。接続文字列が指定されない場合、ストレージアカウント名と、次のいずれか1つだけが必要です。

  • storageKey

  • storageSasToken

  • manageFromAzureADをtrueに設定することにより、ポッド環境から資格情報を継承する

Field

Description

connectionString *SecretKeySelector*

使用する接続文字列

storageAccount *SecretKeySelector*

データをアップロードするストレージアカウント

storageKey *SecretKeySelector*

ストレージアカウント名と組み合わせて使用されるストレージアカウントキー

storageSasToken *SecretKeySelector*

ストレージアカウント名と組み合わせて使用する共有アクセス署名

inheritFromAzureAD bool

キーを明示的に提供せずにAzure ADベースの認証を使用します。

NA

BackupConfiguration

利用箇所

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

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

Field

Description

volumeSnapshot *VolumeSnapshotConfiguration*

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

barmanObjectStore *BarmanObjectStoreConfiguration*

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

retentionPolicy string

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

target archive_timeout

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

NA

BackupMethod

string のエイリアス

利用箇所

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

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

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

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

BackupPhase

string のエイリアス

利用箇所

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

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

BackupPluginConfiguration

利用箇所

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

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

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

Field

Description

name [Required] string

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

parameters map[string]string

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

NA

BackupSnapshotElementStatus

利用箇所

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

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

Field

Description

name [Required] string

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

type [Required] string

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

tablespaceName [Required] string

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

NA

BackupSnapshotStatus

利用箇所

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

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

Field

Description

elements archive_timeout

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

NA

BackupSource

利用箇所

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

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

Field

Description

LocalObjectReference *LocalObjectReference*

LocalObjectReferenceのメンバーはこの型に埋め込まれます。説明は提供されていません。

endpointCA *SecretKeySelector*

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

NA

BackupSpec

利用箇所

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

Field

Description

cluster ** Required]** [*LocalObjectReference*

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

target archive_timeout

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

method archive_timeout

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

pluginConfiguration archive_timeout

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

online bool

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

onlineConfiguration *OnlineConfiguration*

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

NA

BackupStatus

利用箇所

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

Field

Description

BarmanCredentials *BarmanCredentials*

<p>(BarmanCredentialsのメンバーはこのタイプに埋め込まれています。) </p><p>各クラウドプロバイダーの潜在的な資格情報</p>

endpointCA *SecretKeySelector*

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

endpointURL string

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

destinationPath string

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

serverName string

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

encryption string

S3 APIに必要な暗号化方法

backupId string

BarmanバックアップのID

backupName string

Barmanのバックアップの名前

phase archive_timeout

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

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 archive_timeout

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

method archive_timeout

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

online [Required] bool

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

NA

BackupTarget

string のエイリアス

利用箇所

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

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

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

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

BarmanCredentials

利用箇所

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

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

BarmanCredentials 各クラウドプロバイダーの潜在的な資格情報を含むオブジェクト

Field

Description

googleCredentials *GoogleCredentials*

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

s3Credentials *S3Credentials*

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

azureCredentials *AzureCredentials*

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

NA

BarmanObjectStoreConfiguration

利用箇所

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

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

BarmanObjectStoreConfigurationには、S3互換オブジェクトストレージに対してBarmanを使用したバックアップ構成が含まれます

Field

Description

BarmanCredentials *BarmanCredentials*

<p>(BarmanCredentialsのメンバーはこのタイプに埋め込まれています。) </p><p>各クラウドプロバイダーの潜在的な資格情報</p>

endpointURL string

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

endpointCA *SecretKeySelector*

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

destinationPath [Required] string

バックアップを保存するパスつまりs3://bucket/path/to/folder このパスは、さまざまな宛先フォルダーで、WALとデータに使用されます

serverName string

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

wal archive_timeout

WALストリームのバックアップの構成。定義されない場合、WALファイルは非圧縮で保存され、バケットのデフォルトポリシーに従って、オブジェクトストアで暗号化されない場合があります。

data archive_timeout

データファイルのバックアップに使用される構成 定義されていない場合、バケットのデフォルトポリシーに従って、ベースバックアップファイルは非圧縮で保存され、オブジェクトストアで暗号化されない場合があります。

tags map[string]string

Tagsは、 Barman --tagsオプションに渡されるキー値ペアのリストです。

historyTags map[string]string

HistoryTagsは、 Barman --history-tagsオプションに渡されるキー値ペアのリストです。

NA

BootstrapConfiguration

利用箇所

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

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

Field

Description

initdb archive_timeout

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

recovery archive_timeout

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

pg_basebackup archive_timeout

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

NA

BootstrapInitDB

利用箇所

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

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

Field

Description

database string

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

owner string

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

secret *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

walSegmentSize int

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

postInitSQL string

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

postInitApplicationSQL string

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

postInitTemplateSQL string

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

import *Import*

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

postInitApplicationSQLRefs archive_timeout

PostInitApplicationSQLRefsは、 SQLファイルを含むConfigMapsまたはSecretsへの参照をポイントします。これらの参照への一般的な実装順序は、すべてのSecretからすべてのConfigMapへであり、SecretまたはConfigMapの内部では、実装順序は各配列デフォルトでは空の順序と同じです。

NA

BootstrapPgBaseBackup

利用箇所

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

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

Field

Description

source [Required] string

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

database string

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

owner string

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

secret *LocalObjectReference*

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

NA

BootstrapRecovery

利用箇所

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

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

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

Field

Description

backup archive_timeout

リカバリ手順を開始する物理ベースバックアップを含むバックアップオブジェクト。ソースおよびボリュームスナップショットと相互排他的。

source string

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

volumeSnapshots *DataSource*

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

recoveryTarget archive_timeout

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

database string

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

owner string

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

secret *LocalObjectReference*

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

NA

CatalogImage

利用箇所

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

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

Field

Description

image [Required] string

画像参照

major [Required] int

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

NA

CertificatesConfiguration

利用箇所

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

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

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

Field

Description

serverCASecret string

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

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

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

serverAltDNSNames string

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

NA

CertificatesStatus

利用箇所

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

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

Field

Description

CertificatesConfiguration archive_timeout

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

expirations map[string]string

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

NA

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 archive_timeout

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

bootstrap archive_timeout

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

replica *ReplicaClusterConfiguration*

レプリカクラスター構成

superuserSecret *LocalObjectReference*

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

enableSuperuserAccess bool

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

certificates archive_timeout

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

imagePullSecrets *LocalObjectReference*

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

storage archive_timeout

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

serviceAccountTemplate *ServiceAccountTemplate*

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

walStorage archive_timeout

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

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インスタンスが異常であることが検出された後、フェールオーバーをトリガーするまで待機する時間秒

affinity *AffinityConfiguration*

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

topologySpreadConstraints *core/v1.TopologySpreadConstraint*

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 ** Required]** [*EphemeralVolumesSizeLimitConfiguration*

Ephemeral VolumesSizeLimitを使用すると、ユーザーは一時ボリュームの制限を設定できます

priorityClassName string

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

primaryUpdateStrategy *PrimaryUpdateStrategy*

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

primaryUpdateMethod *PrimaryUpdateMethod*

すべてのレプリカが正常に更新された後、ローリング更新手順中にプライマリサーバーをアップグレードするために従う方法。スイッチオーバーswitchoverまたはインプレースrestart-defaultを使用できます。

backup archive_timeout

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

nodeMaintenanceWindow *NodeMaintenanceWindow*

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

monitoring archive_timeout

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

externalClusters *ExternalCluster*

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

logLevel string

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

projectedVolumeTemplate *core/v1.ProjectedVolumeSource*

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

env *core/v1.EnvVar*

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

envFrom *core/v1.EnvFromSource*

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

managed *ManagedConfiguration*

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

seccompProfile *core/v1.SeccompProfile*

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

tablespaces *TablespaceConfiguration*

テーブルスペース構成

enablePDB bool

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

plugins ** Required]** [*PluginConfigurationList*

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

NA

ClusterStatus

利用箇所

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

Field

Description

instances int

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

readyInstances int

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

instancesStatus map[PodStatus][]string

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

instancesReportedState *map[PodName]InstanceReportedState*

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

managedRolesStatus *ManagedRoles*

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

tablespacesStatus archive_timeout

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

timelineID int

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

topology *Topology*

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

latestGeneratedNode int

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

currentPrimary string

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

targetPrimary string

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

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 archive_timeout

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

firstRecoverabilityPoint string

最初の復旧可能ポイント。RFC3339形式の日付として保存されます。このフィールドは、FirstRecoverabilityPointByMethodの内容から計算されます

firstRecoverabilityPointByMethod *map[BackupMethod]meta/v1.Time*

バックアップ方法タイプごとに、RFC3339形式の日付として保存される最初の復旧可能ポイント

lastSuccessfulBackup string

最後に成功したバックアップ、RFC3339形式の日付として保存されますこのフィールドは、LastSuccessfulBackupByMethodの内容から計算されます

lastSuccessfulBackupByMethod *map[BackupMethod]meta/v1.Time*

最後に成功したバックアップ、バックアップ方法タイプごとにRFC3339形式で日付として保存

lastFailedBackup string

RFC3339形式の日付として保存

cloudNativePGCommitHash string

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

currentPrimaryTimestamp string

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

currentPrimaryFailingSinceTimestamp string

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

targetPrimaryTimestamp string

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

poolerIntegrations *PoolerIntegrations*

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

cloudNativePGOperatorHash string

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

availableArchitectures archive_timeout

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

conditions *meta/v1.Condition*

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

instanceNames string

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

onlineUpdateEnabled bool

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

azurePVCUpdateEnabled bool

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

image string

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

pluginStatus ** Required]** [*PluginStatus*

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

switchReplicaClusterStatus *SwitchReplicaClusterStatus*

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

NA

CompressionType

string のエイリアス

利用箇所

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

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

CompressionTypeは、使用可能な圧縮の種類をカプセル化します

ConfigMapKeySelector

利用箇所

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

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

ConfigMapKeySelectorには、ConfigMapのキーを見つけられるように十分な情報が含まれています

Field

Description

LocalObjectReference *LocalObjectReference*

<p>LocalObjectReferenceのメンバーはこの型に埋め込まれています。 </p><p>選択するポッドの名前空間のシークレットの名前。</p>

key [Required] string

選択するキー

NA

ConfigMapResourceVersion

利用箇所

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

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

Field

Description

metrics map[string]string

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

NA

DataBackupConfiguration

利用箇所

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

DataBackupConfigurationは、データディレクトリのバックアップの構成です

Field

Description

compression *CompressionType*

バックアップファイルテーブルスペースごとのtarファイルをオブジェクトストアにストリーミングしながら圧縮します。使用可能なオプションは、空の文字列圧縮なし、デフォルト、gzip、bzip2、またはsnappyです。

encryption *EncryptionType*

ファイルの暗号化を強制する場合バケットがそのようにまだ構成されていない場合。許可されるオプションは空の文字列バケットポリシーを使用しますデフォルト、AES256、およびaws:kmsです

jobs int32

バックアップのアップロードに使用される並列ジョブの数、デフォルト2

immediateCheckpoint bool

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

additionalCommandArgs [Required] string

<p>AdditionalCommandArgsは、 'barman-cloud-backup'コマンドライン呼び出しに追加できる追加引数を表します。これらの引数は、特定の要件または構成に応じてバックアッププロセスをさらにカスタマイズする柔軟性を提供します。</p><p>例 特定のタイムアウトの設定やカスタム動作の定義など、特殊なバックアップオプションが必要なシナリオでは、ユーザーは使用できます</p><p>注 提供された引数が有効で、 'barman-cloud-backup'コマンドでサポートされていることを確認して、実行中の潜在的なエラーまたは意図しない動作を回避することが重要です。 </p>

NA

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*

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

NA

DatabaseRoleRef

利用箇所

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

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

Field

Description

name string

説明はありません。

NA

EmbeddedObjectMetadata

利用箇所

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

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

Field

Description

labels map[string]string

説明はありません。

annotations map[string]string

説明はありません。

NA

EncryptionType

string のエイリアス

利用箇所

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

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

EncryptionTypeは、使用可能な暗号化の種類をカプセル化しました

EnsureOption

string のエイリアス

利用箇所

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

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

Ephemeral VolumesSizeLimitConfiguration {#postgresql-cnpg-io-v1-Ephemeral VolumesSizeLimitConfiguration}

利用箇所

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

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

Field

Description

shm ** Required]** [*k8s.io/apimachinery/pkg/api/resource.Quantity*

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

temporaryData ** Required]** [*k8s.io/apimachinery/pkg/api/resource.Quantity*

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

NA

外部クラスター

利用箇所

  • 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クラスターからリモートPostgreSQLサーバーへの接続を確立するときに、接続文字列で自動的に参照されます。これにより、外部クラスターの安全で効率的なパスワード管理が保証されます。

barmanObjectStore *BarmanObjectStoreConfiguration*

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

NA

GoogleCredentials

利用箇所

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

GoogleCredentialsは、Google Cloud Storage資格情報のタイプです。これは、GKE環境内で実行する場合でも指定する必要があります。

Field

Description

applicationCredentials *SecretKeySelector*

資格情報を含むGoogle Cloud Storage JSONファイルを含むシークレット

gkeEnvironment bool

trueに設定されている場合、GKE環境内で実行されていると想定されます。デフォルトはfalseです。

NA

ImageCatalogRef

利用箇所

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

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

Field

Description

TypedLocalObjectReference *core/v1.TypedLocalObjectReference*

TypedLocalObjectReferenceのメンバーはこの型に埋め込まれます。説明が提供されていません。

major [Required] int

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

NA

ImageCatalogSpec

利用箇所

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

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

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

Field

Description

images ** Required]** [*CatalogImage*

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

NA

Import

利用箇所

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

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

Field

Description

source ** Required]** [*ImportSource*

輸入元

type ** Required]** [*SnapshotType*

インポートタイプ。マイクロサービスまたはモノリスにすることができます。

databases [Required] string

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

roles string

インポートするロール

postImportApplicationSQL string

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

schemaOnly bool

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

NA

ImportSource

利用箇所

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

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

Field

Description

externalCluster [Required] string

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

NA

インスタンスID

利用箇所

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

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

Field

Description

podName string

ポッド名

ContainerID string

コンテナID

NA

InstanceReportedState

利用箇所

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

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

Field

Description

isPrimary [Required] bool

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

timeLineID int

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

NA

LDAPBindAsAuth

利用箇所

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

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

Field

Description

prefix string

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

suffix string

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

NA

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

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

NA

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'がデフォルトです

NA

LDAPScheme

string のエイリアス

利用箇所

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

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

LocalObjectReference

利用箇所

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

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

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

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

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

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

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

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

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

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

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

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

LocalObjectReferenceには、同じ名前空間内の既知のタイプを持つローカルオブジェクトを見つけるための十分な情報が含まれています

Field

Description

name [Required] string

参照先の名前。

NA

ManchedConfiguration

利用箇所

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

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

Field

Description

roles *RoleConfiguration*

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

NA

ManchedRoles

利用箇所

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

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

Field

Description

byStatus map[RoleStatus][]string

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

cannotReconcile map[string][]string

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

passwordStatus *map[string]PasswordState*

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

NA

メタデータ

利用箇所

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

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

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

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

Field

Description

labels map[string]string

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

annotations map[string]string

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

NA

MonitoringConfiguration

利用箇所

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

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

Field

Description

disableDefaultQueries bool

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

customQueriesConfigMap *ConfigMapKeySelector*

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

customQueriesSecret *SecretKeySelector*

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

enablePodMonitor bool

PodMonitorを有効または無効にする

podMonitorMetricRelabelings archive_timeout

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

podMonitorRelabelings archive_timeout

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

NA

NodeMaintenanceWindow

利用箇所

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

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

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

Field

Description

reusePVC bool

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

inProgress bool

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

NA

OnlineConfiguration

利用箇所

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

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

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

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。

NA

PasswordState

利用箇所

  • ManchedRoles {postgresql-cnpg-io-v1-ManadedRoles}

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

Field

Description

transactionID int64

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

resourceVersion string

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

NA

PgBouncerIntegrationStatus

利用箇所

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

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

Field

Description

secrets string

説明はありません。

NA

PgBouncerPoolMode

string のエイリアス

利用箇所

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

PgBouncerPoolModeはPgBouncerのモードです

PgBouncerSecrets

利用箇所

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

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

Field

Description

authQuery *SecretVersion*

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

NA

PgBouncerSpec

利用箇所

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

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

Field

Description

poolMode *PgBouncerPoolMode*

プールモード。デフォルトセッション。

authQuerySecret *LocalObjectReference*

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

authQuery string

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

parameters map[string]string

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

pg_hba string

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

paused bool

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

NA

PluginStatus

利用箇所

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

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

Field

Description

name [Required] string

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

version [Required] string

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

capabilities [Required] string

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

operatorCapabilities [Required] string

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

walCapabilities [Required] string

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

backupCapabilities [Required] string

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

NA

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

NA

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*

説明はありません。

NA

PoolerMonitoringConfiguration

利用箇所

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

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

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

Field

Description

enablePodMonitor bool

PodMonitorを有効または無効にする

podMonitorMetricRelabelings archive_timeout

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

podMonitorRelabelings archive_timeout

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

NA

PoolerSecrets

利用箇所

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

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

Field

Description

serverTLS *SecretVersion*

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

serverCA *SecretVersion*

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

clientCA *SecretVersion*

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

pgBouncerSecrets *PgBouncerSecrets*

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

NA

PoolerSpec

利用箇所

  • プーラー {postgresql-cnpg-io-v1-Pooler}

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

Field

Description

cluster ** Required]** [*LocalObjectReference*

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

type *PoolerType*

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

instances int32

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

template *PodTemplateSpec*

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

pgbouncer ** Required]** [*PgBouncerSpec*

PgBouncer構成

deploymentStrategy *apps/v1.DeploymentStrategy*

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

monitoring archive_timeout

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

serviceTemplate *ServiceTemplateSpec*

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

NA

PoolerStatus

利用箇所

  • プーラー {postgresql-cnpg-io-v1-Pooler}

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

Field

Description

secrets *PoolerSecrets*

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

instances int32

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

NA

PoolerType

string のエイリアス

利用箇所

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

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

PostInitApplicationSQLRefs

利用箇所

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

PostInitApplicationSQLRefsは、 SQLファイルを含むConfigMapsまたはSecretsへの参照をポイントします。これらの参照への一般的な実装順序は、すべてのSecretからすべてのConfigMapへであり、SecretまたはConfigMapの内部では、実装順序は各配列の順序と同じです。

Field

Description

secretRefs *SecretKeySelector*

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

configMapRefs *ConfigMapKeySelector*

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

NA

PostgresConfiguration

利用箇所

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

PostgresConfigurationはPostgreSQL構成を定義します

Field

Description

parameters map[string]string

PostgreSQL構成オプションpostgresql.conf

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。

NA

PrimaryUpdateMethod

string のエイリアス

利用箇所

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

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

PrimaryUpdateStrategy

string のエイリアス

利用箇所

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

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

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になります

NA

ReplicaClusterConfiguration

利用箇所

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

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

Field

Description

source [Required] string

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

enabled [Required] bool

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

NA

ReplicationSlotsConfiguration

利用箇所

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

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

Field

Description

highAvailability archive_timeout

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

updateInterval int

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

synchronizeReplicas *SynchronizeReplicasConfiguration*

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

NA

ReplicationSlotsHAConfiguration

利用箇所

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

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

Field

Description

enabled bool

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

slotPrefix string

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

NA

RoleConfiguration

利用箇所

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

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」です

passwordSecret *LocalObjectReference*

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

connectionLimit int64

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

validUntil *meta/v1.Time*

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

inRoles string

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

inherit bool

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

disablePassword bool

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

superuser bool

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

createdb bool

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

createrole bool

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

login bool

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

replication bool

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

bypassrls bool

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

NA

S3Credentials

利用箇所

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

S3Credentialsは、S3にファイルをアップロードするために使用される資格情報のタイプです。これは、2つの代替方法で提供できます。

  • accessKeyIdとsecretAccessKeyを明示的に渡す

  • manageFromIAMRoleをtrueに設定することにより、ポッド環境からロールを継承する

Field

Description

accessKeyId *SecretKeySelector*

アクセスキーIDへの参照

secretAccessKey *SecretKeySelector*

シークレットアクセスキーへの参照

region *SecretKeySelector*

リージョン名を含むシークレットへの参照

sessionToken *SecretKeySelector*

セッションキーへの参照

inheritFromIAMRole bool

キーを明示的に提供せずにロールベースの認証を使用します。

NA

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]** [*LocalObjectReference*

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

backupOwnerReference string

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

target archive_timeout

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

method archive_timeout

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

pluginConfiguration archive_timeout

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

online bool

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

onlineConfiguration *OnlineConfiguration*

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

NA

ScheduledBackupStatus

利用箇所

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

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

Field

Description

lastCheckTime *meta/v1.Time*

最新のスケジュール

lastScheduleTime *meta/v1.Time*

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

nextScheduleTime *meta/v1.Time*

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

NA

SecretKeySelector

利用箇所

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

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

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

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

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

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

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

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

SecretKeySelectorには、シークレットのキーを見つけるための十分な情報が含まれています

Field

Description

LocalObjectReference *LocalObjectReference*

<p>LocalObjectReferenceのメンバーはこの型に埋め込まれています。 </p><p>選択するポッドの名前空間のシークレットの名前。</p>

key [Required] string

選択するキー

NA

SecretVersion

利用箇所

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

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

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

Field

Description

name string

シークレットの名前

version string

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

NA

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

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

NA

ServiceAccountTemplate

利用箇所

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

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

Field

Description

metadata ** Required]** [*Metadata*

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

NA

ServiceTemplateSpec

利用箇所

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

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

NA

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}

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

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を生成するために使用されるテンプレート

NA

SwitchReplicaClusterStatus

利用箇所

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

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

Field

Description

inProgress bool

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

NA

SyncReplicaElectionConstraints

利用箇所

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

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

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

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

Field

Description

nodeLabelsAntiAffinity string

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

enabled [Required] bool

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

NA

SynchronizeReplicasConfiguration

利用箇所

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

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

Field

Description

enabled [Required] bool

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

excludePatterns string

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

  • ** Required]** [*synchronizeReplicasCache*

説明はありません。

NA

TablespaceConfiguration

利用箇所

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

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

Field

Description

name [Required] string

テーブルスペースの名前

storage ** archive_timeout

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

owner *DatabaseRoleRef*

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

temporary bool

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

NA

TablespaceState

利用箇所

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

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

Field

Description

name [Required] string

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

owner string

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

state ** archive_timeout

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

error string

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

NA

TablespaceStatus

string のエイリアス

利用箇所

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

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

トポロジ

利用箇所

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

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

Field

Description

instances *map[PodName]PodTopologyLabels*

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

nodesUsed int32

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

successfullyExtracted bool

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

NA

VolumeSnapshotConfiguration {#postgresql-cnpg-io-v1- 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*

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

NA

WalBackupConfiguration

利用箇所

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

WalBackupConfigurationは、WALストリームのバックアップの構成です

Field

Description

compression *CompressionType*

WALファイルをオブジェクトストアに送信する前に圧縮します。使用可能なオプションは、空の文字列圧縮なし、デフォルト、gzip、bzip2、またはsnappyです。

encryption *EncryptionType*

ファイルの暗号化を強制する場合バケットがそのようにまだ構成されていない場合。許可されるオプションは空の文字列バケットポリシーを使用しますデフォルト、AES256、およびaws:kmsです

maxParallel int

並列アーカイブするPostgreSQLインスタンスがバックアップオブジェクトストアにアーカイブしている場合、または並列リストアするWALファイルの数PostgreSQLスタンバイがリカバリオブジェクトストアからWALファイルを取得している場合。指定しない場合、WALファイルは一度に1つずつ処理されます。値として正の整数を受け入れます。1が受け入れられる最小値です。

NA