PG Backup API#

config.yml でenable_pg_backup_api: true を設定するか、configure中に--enable-pg-backup-api コマンドラインオプションを使用すると、barman ロールを持つインスタンスはpg-backup-apiをインストールし、クライアント証明書認証用にApacheプロキシを設定します。このApacheプロキシは、クラスター用に生成されたSSL CAを使用して、サーバーとクライアントの証明書を生成します。

cluster_vars:
  enable_pg_backup_api: true

PG Backup APIパッケージバージョン#

デフォルトでは、TPAはpg-backup-apiの利用可能な最新バージョンをインストールします。

config.yml ファイルのcluster_vars セクションの下のpg_backup_api_package_version: xxx を含めることにより、インストールされるpg-backup-apiパッケージのバージョンを指定できます。

cluster_vars:
    …
    pg_backup_api_package_version: 2.0.0-1.el8
    …

aptまたはyumが受け入れるバージョン指定子を使用できます。

バージョンが一致しない場合は、 * ワイルドカードを追加してみてください。これは、パッケージバージョンに2:... のようなエポック修飾子がある場合に必要になることがよくあります。

インストールオプション#

pg-backup-apiは、デフォルトでパッケージを介してインストールされますが、gitブランチまたはローカルディレクトリからインストールすることもできます。詳細については、 Building from source およびソースからのビルドとインストールを参照してください。

セットアップの検証#

pg-backup-apiを実行しているbarmanノードでpg-backup-api status を実行します。「OK」が返された場合、pg-backup-apiサービスが実行されています。

プロキシが動作していることをテストするには、次のコマンドを実行します。

curl --cert /etc/tpa/pg-backup-api/pg-backup-user.crt \
     --key /etc/tpa/pg-backup-api/pg-backup-user.key \
     -X GET https://{hostname}/diagnose

機能している場合は、大規模なjson出力を取得します。これをbarman diagnose の出力と比較できます。それらは正確に一致するはずです。

SSL証明書#

ルート証明書は、デフォルトで/etc/tpa/pg-backup-api/ にコピーされます。

クライアント証明書とキー pg-backup-user.crt およびpg-backup-user.key は、テストのために生成されます tpaexec test を介してまたはbarmanホストからのコマンドライン。 tpaexec test を参照してください。

Apacheプロキシサーバーの証明書とキーpg-backup-api.crt およびpg-backup-api.key も生成されます

APIを照会する必要がある各サービスは、独自のクライアント証明書を個別に生成する必要があります。たとえば、PEMエージェントロールは、--enable-pem および--enable-pg-backup-api またはconfig.yml同等の両方が使用される場合、セットアップ中にクライアント証明書を生成します。

`tpaexec upgrade` を使用したpgバックアップAPIのマイナー更新#

特定のパッケージバージョンにアップグレードしようとする場合は、 config.yml のpg_backup_api_package_version が更新されて、目的のバージョンを反映していることを確認します。

目的のバージョンを追加の引数としてtpaexec upgrade コマンドに渡すこともできます。

tpaexec upgrade <cluster_dir> -e pg_backup_api_package_version="<desired version>"
  --components=pg-backup-api

詳細については、 package version selection and upgrade のセクションを参照してください。

アップグレードのためにPG Backup APIを選択するには、 tpaexec upgrade コマンドに渡される--components フラグにpg-backup-api またはall が含まれていることを確認します

component selection for upgrade のセクションを参照してください

詳細については、

PG Backup API

目次