CloudNativePG Plugin¶

CloudNativePGは、Kubernetesでクラスターを管理するための kubectl のプラグインを提供します。

インストール¶

以下を使用して、システムにプラグインをインストールできます。

curl -sSfL \
  https://github.com/cloudnative-pg/cloudnative-pg/raw/main/hack/install-cnpg-plugin.sh | \
  sudo sh -s -- -b /usr/local/bin

サポートされているアーキテクチャ¶

CloudNativePGプラグインは現在、次のオペレーティングシステムとアーキテクチャ向けに構築されています。

Linux
amd64 *アーム5/6/7
arm64
s390x
ppc64le
macOS
amd64
arm64
Windows
386
amd64 *アーム5/6/7
arm64

使用¶

プラグインをインストールしてデプロイしたら、次のように使用をスタートできます。

kubectl cnpg <command> <args...>

ステータス¶

status コマンドは、以下を含むクラスターの現在のステータスの概要を提供します。

一般情報 ：クラスターの名前、PostgreSQLのシステムID、インスタンス、現在のタイムラインおよびWAL内の位置
バックアップ ：リカバリ可能ポイント、およびによって返されるWALアーカイビングステータスプライマリからのプライマリビュー-またはレプリカクラスターの場合
ストリーミングレプリケーション ： pg_stat_replication から直接取得した情報プライマリインスタンスのビュー
instances ：各Postgresインスタンスに関する情報。インスタンスマネージャ;スタンバイの場合、 Current LSN フィールドは対応しますリカバリ中に再生された最新のログ先行書き込みの場所（リプレイLSN）。

重要

上記のステータス情報は、異なる時間および異なる場所で取得されるため、戻り値がわずかに矛盾します。例、メインヘッダーの Current Write LSN の場所は、2つの異なる時間間隔で取得されるため、インスタンスステータスの Current LSN フィールドと異なる場合があります。

kubectl cnpg status sandbox

Cluster in healthy state
Name:               sandbox
Namespace:          default
System ID:          7039966298120953877
PostgreSQL Image:   ghcr.io/cloudnative-pg/postgresql:14.2
Primary instance:   sandbox-2
Instances:          3
Ready instances:    3
Current Write LSN:  3AF/EAFA6168 (Timeline: 8 - WAL File: 00000008000003AF00000075)

Continuous Backup status
First Point of Recoverability:  Not Available
Working WAL archiving:          OK
Last Archived WAL:              00000008000003AE00000079   @   2021-12-14T10:16:29.340047Z
Last Failed WAL: -

Certificates Status
Certificate Name             Expiration Date                Days Left Until Expiration
- ---------------             ---------------                --------------------------
cluster-example-ca           2022-05-05 15:02:42 +0000 UTC  87.23
cluster-example-replication  2022-05-05 15:02:42 +0000 UTC  87.23
cluster-example-server       2022-05-05 15:02:42 +0000 UTC  87.23

Streaming Replication status
Name       Sent LSN      Write LSN     Flush LSN     Replay LSN    Write Lag        Flush Lag        Replay Lag       State      Sync State  Sync Priority
- ---       --------      ---------     ---------     ----------    ---------        ---------        ----------       -----      ----------  -------------
sandbox-1  3AF/EB0524F0  3AF/EB011760  3AF/EAFEDE50  3AF/EAFEDE50  00:00:00.004461  00:00:00.007901  00:00:00.007901  streaming  quorum      1
sandbox-3  3AF/EB0524F0  3AF/EB030B00  3AF/EB030B00  3AF/EB011760  00:00:00.000977  00:00:00.004194  00:00:00.008252  streaming  quorum      1

Instances status
Name       Database Size  Current LSN   Replication role  Status  QoS         Manager Version
- ---       -------------  -----------   ----------------  ------  ---         ---------------
sandbox-1  302 GB         3AF/E9FFFFE0  Standby (sync)    OK      Guaranteed  1.11.0
sandbox-2  302 GB         3AF/EAFA6168  Primary           OK      Guaranteed  1.11.0
sandbox-3  302 GB         3AF/EBAD5D18  Standby (sync)    OK      Guaranteed  1.11.0

また、 --verbose または単に -v を追加することで、より詳細なバージョンのステータスを取得することもできます

kubectl cnpg status sandbox --verbose

Cluster in healthy state
Name:               sandbox
Namespace:          default
System ID:          7039966298120953877
PostgreSQL Image:   ghcr.io/cloudnative-pg/postgresql:14.2
Primary instance:   sandbox-2
Instances:          3
Ready instances:    3
Current Write LSN:  3B1/61DE3158 (Timeline: 8 - WAL File: 00000008000003B100000030)

PostgreSQL Configuration
archive_command = /controller/manager wal-archive --log-destination /controller/log/postgres.json %p
archive_mode = on
archive_timeout = 5min
checkpoint_completion_target = 0.9
checkpoint_timeout = 900s
cluster_name = sandbox
dynamic_shared_memory_type = sysv
full_page_writes = on
hot_standby = true
jit = on
listen_addresses = *
log_autovacuum_min_duration = 1s
log_checkpoints = on
log_destination = csvlog
log_directory = /controller/log
log_filename = postgres
log_lock_waits = on
log_min_duration_statement = 1000
log_rotation_age = 0
log_rotation_size = 0
log_statement = ddl
log_temp_files = 1024
log_truncate_on_rotation = false
logging_collector = on
maintenance_work_mem = 2GB
max_connections = 1000
max_parallel_workers = 32
max_replication_slots = 32
max_wal_size = 15GB
max_worker_processes = 32
pg_stat_statements.max = 10000
pg_stat_statements.track = all
port = 5432
shared_buffers = 16GB
shared_memory_type = sysv
shared_preload_libraries = pg_stat_statements
ssl = on
ssl_ca_file = /controller/certificates/client-ca.crt
ssl_cert_file = /controller/certificates/server.crt
ssl_key_file = /controller/certificates/server.key
synchronous_standby_names = ANY 1 ("sandbox-1","sandbox-3")
unix_socket_directories = /controller/run
wal_keep_size = 512MB
wal_level = logical
wal_log_hints = on
cnpg.config_sha256 = 3cfa683e23fe513afaee7c97b50ce0628e0cc634bca8b096517538a9a4428efc

PostgreSQL HBA Rules

#  Grant local access
local all all peer map=local

#  Require client certificate authentication for the streaming_replica user
hostssl postgres streaming_replica all cert
hostssl replication streaming_replica all cert
hostssl all cnpg_pooler_pgbouncer all cert

#  Otherwise use the default authentication method
host all all all scram-sha-256

Continuous Backup status
First Point of Recoverability:  Not Available
Working WAL archiving:          OK
Last Archived WAL:              00000008000003B00000001D   @   2021-12-14T10:20:42.272815Z
Last Failed WAL: -

Streaming Replication status
Name       Sent LSN      Write LSN     Flush LSN     Replay LSN    Write Lag        Flush Lag        Replay Lag       State      Sync State  Sync Priority
- ---       --------      ---------     ---------     ----------    ---------        ---------        ----------       -----      ----------  -------------
sandbox-1  3B1/61E26448  3B1/61DF82F0  3B1/61DF82F0  3B1/61DF82F0  00:00:00.000333  00:00:00.000333  00:00:00.005484  streaming  quorum      1
sandbox-3  3B1/61E26448  3B1/61E26448  3B1/61DF82F0  3B1/61DF82F0  00:00:00.000756  00:00:00.000756  00:00:00.000756  streaming  quorum      1

Instances status
Name       Database Size  Current LSN   Replication role  Status  QoS         Manager Version
- ---       -------------  -----------   ----------------  ------  ---         ---------------
sandbox-1                 3B1/610204B8  Standby (sync)    OK      Guaranteed  1.11.0
sandbox-2                 3B1/61DE3158  Primary           OK      Guaranteed  1.11.0
sandbox-3                 3B1/62618470  Standby (sync)    OK      Guaranteed  1.11.0

このコマンドは、 yaml および json フォーマットの出力もサポートしています。

プロモート¶

このコマンドの意味は、クラスター内のポッドをプライマリに promote することです。したがって、メンテナンス作業をスタートしたり、クラスターのスイッチオーバシチュエーションをテストしたりできます。

kubectl cnpg promote cluster-example cluster-example-2

または、インスタンスノード番号を使用してプロモートさせることができます

kubectl cnpg promote cluster-example 2

証明書¶

CloudNativePG演算子を使用して作成されたクラスターは、CAと連携してTLS認証証明書に署名します。

証明書を取得するには、資格情報を保存するシークレットの名前、クラスター名前、およびこの証明書のユーザを指定する必要があります

kubectl cnpg certificate cluster-cert --cnpg-cluster cluster-example --cnpg-user appuser

Secreteが作成されたら、 kubectl を使用して取得できます

kubectl get secret cluster-cert

また、次のコマンドを使用したプレインテキストでの同じコンテンツ：

kubectl get secret cluster-cert -o json | jq -r .data | map(@base64d) | .[]

再起動¶

kubectl cnpg restart コマンドは、次の2つの場合に使用できます。

演算子にロールアウトのリスタートを調整するよう要求する特定のクラスターに対して。これは適用するのに便利です ConfigMapなどのクラスター依存オブジェクトの構成変更カスタムモニタリングクエリを含む。
単一インスタンスのリスタートを要求します。インスタンスがクラスターのプライマリまたはポッドの削除と再作成それはレプリカです。

#  this command will restart a whole cluster in a rollout fashion
kubectl cnpg restart [clusterName]

#  this command will restart a single instance, according to the policy above
kubectl cnpg restart [clusterName] [pod]

インプレースリスタートが要求されているが、スイッチオーバーなしでは変更を適用できない場合、スイッチオーバーはインプレースリスタートよりも優先されます。これの一般的なケースは、 PostgreSQLイメージのマイナーアップグレードです。

注釈

ConfigMapsとSecretsをインスタンスによって**自動的に**リロードする場合、 cnpg.io/reload キーを持つlabelを追加できます。

リロード¶

kubectl cnpg reload コマンドは、特定のクラスターの調整ループをトリガーするよう演算子に要求します。これは、カスタムモニタリングクエリを含むConfigMapなど、クラスターに依存するオブジェクトに構成の変更を適用するのに役立ちます。

次のコマンドは、特定のクラスターのすべての構成をリロードします。

kubectl cnpg reload [cluster_name]

メンテナンス¶

kubectl cnpg maintenance コマンドは、ネームスペース全体で1つ以上のクラスターを変更し、メンテナンスウィンドウの値を設定するのに役立ちます。次のフィールドが変更されます。

.spec.nodeMaintenanceWindow.inProgress
.spec.nodeMaintenanceWindow.reusePVC

これを引数 set および unset として受け入れ、 set の場合は inProgress を true に、 unset の場合は false に設定します。

デフォルトでは、 --reusePVC フラグが渡されない限り、 reusePVC は常に false に設定されます。

プラグインは、変更するクラスターのリストとそれらの新しい値の確認を求めます。これが受け入れられると、このアクションはリスト内のすべてのクラスターに適用されます。

Kubernetesクラスター内のすべてのPostgreSQLをメンテナンスで設定する場合は、次のコマンドを記述する必要があります。

kubectl cnpg maintenance set --all-namespaces

そして、更新するすべてのクラスターのリストがあります

The following are the new values for the clusters
Namespace  Cluster Name     Maintenance  reusePVC
- --------  ------------     -----------  --------
default    cluster-example  true         false
default    pg-backup        true         false
test       cluster-example  true         false
Do you want to proceed? [y/n]: y

レポート¶

kubectl cnpg report コマンドは、さまざまな情報をZIPファイルにバンドルします。稼動環境のクラスターの問題をデバッグするために必要なコンテキストを提供することを目的としています。

operator と cluster の2つのサブコマンドがあります。

レポート演算子¶

operator サブコマンドは、演算子のデプロイメント、構成、およびイベントに関する情報を提供するよう演算子に要求します。

重要

SecretsおよびConfigMapsのすべての機密情報は編集済みです。データマップには** keys **が表示されますが、値は空になります。フラグ -S / --stopRedaction は、リダクションを無効にし、値を表示します。ご自身のリスクでのみ使用してください。これはプライベートデータを共有します。

注釈

デフォルトでは、演算子ログは収集されませんが、 --logs フラグを使用して演算子ログ収集を有効にできます

デプロイメント情報 ：演算子のデプロイメントと演算子のポッド
構成：演算子名前空間のSecretsおよびConfigMaps
イベント ：演算子名前空間のイベント
webhook設定 ：webhook設定の変更と検証
webhookサービス ：webhookサービス
logs ：演算子Pod（オプショナル、デフォルトではoff）のJSON行フォーマットのログ

このコマンドは、YAMLフォーマットのさまざまなマニフェストを含むZIPファイルを生成します（デフォルトでは、ただし -o フラグを使用してJSONに設定可能）。 -f フラグを使用して、結果ファイルに明示的に名前を付けます。 -f フラグを使用しない場合、デフォルトのタイムスタンプ付きファイル名がzipファイル用に作成されます。

kubectl cnpg report operator

結果として

Successfully written report to "report_operator_<TIMESTAMP>.zip" (format: "yaml")

-f フラグセットている場合：

kubectl cnpg report operator -f reportRedacted.zip

ファイルを解凍すると、タイムスタンプ付きの最上位フォルダーが作成され、ディレクトリが整理されます。

unzip reportRedacted.zip

結果として：

Archive:  reportRedacted.zip
   creating: report_operator_<TIMESTAMP>/
   creating: report_operator_<TIMESTAMP>/manifests/
  inflating: report_operator_<TIMESTAMP>/manifests/deployment.yaml
  inflating: report_operator_<TIMESTAMP>/manifests/operator-pod.yaml
  inflating: report_operator_<TIMESTAMP>/manifests/events.yaml
  inflating: report_operator_<TIMESTAMP>/manifests/validating-webhook-configuration.yaml
  inflating: report_operator_<TIMESTAMP>/manifests/mutating-webhook-configuration.yaml
  inflating: report_operator_<TIMESTAMP>/manifests/webhook-service.yaml
  inflating: report_operator_<TIMESTAMP>/manifests/cnpg-ca-secret.yaml
  inflating: report_operator_<TIMESTAMP>/manifests/cnpg-webhook-cert.yaml

機密情報が編集されていることを確認できます。

cd report_operator_<TIMESTAMP>/manifests/
head cnpg-ca-secret.yaml

data:
  ca.crt: ""
  ca.key: ""
metadata:
  creationTimestamp: "2022-03-22T10:42:28Z"
  managedFields:
  - apiVersion: v1
    fieldsType: FieldsV1
    fieldsV1:

-S （ --stopRedaction ）オプションをアクティブにすると、秘密が表示されます：

kubectl cnpg report operator -f reportNonRedacted.zip -S

機密情報をビューしようとしていることを通知します。

WARNING: secret Redaction is OFF. Use it with caution
Successfully written report to "reportNonRedacted.zip" (format: "yaml")

unzip reportNonRedacted.zip
head cnpg-ca-secret.yaml

data:
  ca.crt: LS0tLS1CRUdJTiBD…
  ca.key: LS0tLS1CRUdJTiBF…
metadata:
  creationTimestamp: "2022-03-22T10:42:28Z"
  managedFields:
  - apiVersion: v1
    fieldsType: FieldsV1

レポートクラスター¶

cluster サブコマンドは次を収集します。

クラスターリソース ： kubectl get cluster -o yaml と同じクラスター情報
クラスターポッド ：クラスター名にマッチングするクラスター名前空間のポッド
クラスタージョブ ：存在する場合、クラスター名にマッチングするクラスター名前空間にジョブ
イベント ：クラスター名前空間のイベント
podlogs ： JSON-linesフォーマットのクラスターポッド（オプショナル、デフォルトではオフ）のログ
ジョブブログ ：ジョブによって作成されたPodのログ（オプショナル、デフォルトではoff） JSON行フォーマット

cluster サブコマンドは、 operator が行うように、 -f および -o フラグを受け入れます。 -f フラグを使用しない場合、デフォルトのタイムスタンプ付きレポート名前が使用されます。無効です。

注釈

デフォルトでは、クラスターログは収集されませんが、 --logs フラグを使用してクラスターログの収集を有効にできます

使用法：

kubectl cnpg report cluster <clusterName> [flags]

operator サブコマンドとは異なり、 cluster サブコマンドでは、クラスターがデフォルトの名前にない限り、クラスター名前と名前空間を指定する必要があることに注意してください。

kubectl cnpg report cluster example -f report.zip -n example_namespace

そして：

unzip report.zip

Archive:  report.zip
   creating: report_cluster_example_<TIMESTAMP>/
   creating: report_cluster_example_<TIMESTAMP>/manifests/
  inflating: report_cluster_example_<TIMESTAMP>/manifests/cluster.yaml
  inflating: report_cluster_example_<TIMESTAMP>/manifests/cluster-pods.yaml
  inflating: report_cluster_example_<TIMESTAMP>/manifests/cluster-jobs.yaml
  inflating: report_cluster_example_<TIMESTAMP>/manifests/events.yaml

--logs フラグを使用して、ポッドとジョブのログをZIPに追加できることに注意してください。

kubectl cnpg report cluster example -n example_namespace --logs