クラウドのBarman#

Barmanは、Postgresサーバーをクラウドにバックアップする2つの主な方法を提供しています。

Creating disk volume snapshots as base backups.

これは、2つの異なるアプローチで実現できます。
1. バックアップはクラウドにディスクボリュームのスナップショットとして作成されますが、バックアップメタデータとWALファイルを保存するようにBarmanサーバーをセットアップします。これはBarmanの統合機能です。このアプローチを選択する場合、詳細については cloud snapshots backups セクションを参照してください。
2. Barmanサーバーを必要とせず、barmanクラウドクライアントパッケージが提供するコマンドラインユーティリティと直接対話してバックアップを管理します。バックアップメタデータとWALファイルはクラウドオブジェクトストレージに保存されますが、ベースバックアップはクラウドにディスクボリュームのスナップショットとして作成されます。
Creating and transferring base backups to a cloud object storage.

これは、2つの異なるアプローチを通じて達成することもできます。
1. Barmanサーバーを使用せず、Postgresホストのbarmanクラウドクライアントパッケージが提供するユーティリティを使用します。ベースバックアップとWALは両方ともローカルホストPostgresホストから読み取られ、バックアップメタデータとともにクラウドオブジェクトストレージに保存されます。
2. ベースバックアップを取得し、バックアップメタデータとWALファイルを保存するようにBarmanサーバーを設定し、barmanクラウドクライアントパッケージがフックスクリプトとして提供するユーティリティを使用して、クラウドオブジェクトストレージにコピーします。このアプローチを選択する場合、詳細については barmanでフックとして barman-cloud-* スクリプトを使用するセクションを参照してください。

ドキュメントのこのセクションでは、専用のbarmanサーバーを必要とせずにバックアップを管理および対話するために使用できる barman-cloud-* コマンドに焦点を当てています。それで作業を開始するには、Postgresサーバーと同じマシンにbarmanクラウドクライアントパッケージをインストールする必要があります。

これらのオプションを理解することは、クラウドのバックアップとリカバリーのニーズに適切なアプローチを選択し、Barmanの可能性を最大限に活用するのに役立ちます。

Barmanクラウドクライアントパッケージ#

barmanクラウドクライアントパッケージは、 Barmanサーバーを必要とせずに、オブジェクトストレージとディスクボリュームのスナップショットの両方でクラウドバックアップを管理するためのコマンドを提供します。

このユーティリティを使用すると、次のことができます。

スナップショットバックアップを直接作成および管理します。
バックアップを作成してクラウドオブジェクトストレージに転送します。

クラウドストレージとディスクボリュームのバックアップを個別に処理するための追加機能を提供しますが、Barmanのネイティブ機能を完全に拡張するものではありません。 Barmanの統合機能と比較して制限があり、一部の操作が異なる場合があります。

注釈

Barmanは、AWS S3およびS3互換オブジェクトストア、Azure Blob Storage、およびGoogle Cloud Storageをサポートしています。

注釈

一部のS3サードパーティプロバイダーは、 boto3>=1.36 でデフォルトで提供される新しいデータ完全性保護チェックと互換性がありません。プロバイダーがこのグループに該当する場合、AWS S3との非互換性を克服するのに役立つ回避策があります。

この場合、 barman-cloud ツールが動作するためには、 when_required を以下に示す2つの環境変数に設定する必要があります。動作する保証はありませんが、これらを設定すると、そのような環境で barman-cloud が動作することが確認されています。

AWS_REQUEST_CHECKSUM_CALCULATION=when_required
AWS_RESPONSE_CHECKSUM_VALIDATION=when_required

重要

AWS boto3 1.36から、 Data Integrity Protection checks の動作が変更されました。 Barmanが使用する一部のメソッドは、 Content-MD5 ヘッダーを必要としません。

これは、新しいboto3バージョンで使用した場合の S3-compatible storage providers that have not updated their server-side code may fail を意味します。たとえば、MinIOは、boto3 1.36発表の直後にこの変更に対応しました。

MinIOを使用している場合、最新リリースまたは少なくとも RELEASE.2025-02-03T21-03-04Z 以降に must upgrade して、互換性を保証し、バックアップを削除するときやkeepアノテーションをリリースする際の障害を回避します。

インストール#

Postgresサーバーをクラウドプロバイダーに直接バックアップするには、これらのサーバーに`barmanクラウドクライアントパッケージ`をインストールする必要があります。インストールプロセスは、使用しているディストリビューションによって異なることに注意してください。

インストールプロセスについては installation セクションを参照し、各ディストリビューションの重要な情報を必ずメモしてください。

オブジェクトロックのサポート#

Barmanクラウドは、クラウドオブジェクトストレージに保存されているバックアップのWrite-Once-Read-ManyWORM保護を提供するオブジェクトロックメカニズムと連携できます。オブジェクトロックは、データ保持要件へのコンプライアンスを保証し、バックアップファイルの誤ってまたは悪意のある削除を防止し、重要なバックアップデータをランサムウェア攻撃または不正な削除から保護します。

オブジェクトロックは、一定の期間保持期間または無期限にリーガルホールドでオブジェクトが削除または上書きされるのを防ぎます。これは、規制コンプライアンス要件の場合に特に役立ちます。

注釈

オブジェクトロック検証は、現在AWS S3およびS3互換ストレージプロバイダーでのみサポートされています。

重要

Barmanは、オブジェクトロックを作成または管理しません。適切な保持ポリシーを使用してクラウドストレージバケットを構成するのはユーザーの責任です。 Barmanは、削除操作中にこれらのロックを検証および尊重して、構成されたポリシーへのコンプライアンスを保証できます。

S3オブジェクトロック#

Barmanは、AWS S3オブジェクトロックと連携して、バックアップの不変性を維持できます。この機能を使用するには、必要なオブジェクトロック設定でS3バケットを構成する必要があります。

Object versioning enabled ファンクションへのオブジェクトロックに必要です。
Default retention policy バケット内の新しいオブジェクトのデフォルトの保持ポリシーを構成します。このポリシーは、 Barmanによってではなく、AWS S3内で完全に管理されます。

これらの設定がS3バケットで構成されている場合、AWSは barman-cloud-backup および barman-cloud-wal-archive を介してアップロードされたオブジェクトに保持ポリシーを自動的に適用します。オブジェクトは、バケットの保持構成に従って保護され、保持期間が終了するまで削除または変更することはできません。

barman-cloud-backup-delete でバックアップとWALを削除する場合、 --check-object-lock オプションを使用して、削除を試行する前にオブジェクトがオブジェクトロックで保護されているかどうかを確認できます。このフラグは、バックアップファイルのロックステータスを確認し、構成された保持ポリシーを尊重するようにBarmanに指示し、削除の失敗を防ぎ、データ保持要件へのコンプライアンスを保証します。

AWS S3オブジェクトロックの詳細については、 AWS S3 Object Lock documentation を参照してください。

削除プロセスやパフォーマンスの考慮事項に関する情報を含む、 --check-object-lock オプションの動作の詳細については、 barman-cloud-backup-delete コマンドリファレンスを参照してください。

コマンドリファレンス#

このユーティリティを使用して、クラウドでバックアップとリカバリーを管理するために使用できるコマンドがいくつかあります。これらの終了ステータスは、 SUCCESS (0)、 FAILURE (1)、 FAILED CONNECTION (2)、および INPUT_ERROR (3)です。その他のゼロ以外の値は FAILURE です。

注釈

Barmanクラウドコマンドを実行するときに、バックアップIDの代わりにバックアップ shortcuts を指定できます。クラウドコマンドは、次のショートカットをサポートしています。 first / oldest 、 last / latest および last-failed 。

`barman-cloud-backup`#

Synopsis

barman-cloud-backup
                [ { -V | --version } ]
                [ --help ]
                [ { { -v | --verbose } | { -q | --quiet } } ]
                [ { -t | --test } ]
                [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ]
                [ { { -z | --gzip } | { -j | --bzip2 } | --snappy } ]
                [ { -h | --host } HOST ]
                [ { -p | --port } PORT ]
                [ { -U | --user } USER ]
                [ { -d | --dbname } DBNAME ]
                [ { -n | --name } BACKUP_NAME ]
                [ { -J | --jobs } JOBS ]
                [ { -S | --max-archive-size } MAX_ARCHIVE_SIZE ]
                [ --immediate-checkpoint ]
                [ --min-chunk-size MIN_CHUNK_SIZE ]
                [ --max-bandwidth MAX_BANDWIDTH ]
                [ --snapshot-instance SNAPSHOT_INSTANCE ]
                [ --snapshot-disk NAME [ --snapshot-disk NAME ... ] ]
                [ --snapshot-zone GCP_ZONE ]
                [ -snapshot-gcp-project GCP_PROJECT ]
                [ --tag KEY,VALUE [ --tag KEY,VALUE ... ] ]
                [ --endpoint-url ENDPOINT_URL ]
                [ { -P | --aws-profile } AWS_PROFILE ]
                [ --profile AWS_PROFILE ]
                [ --read-timeout READ_TIMEOUT ]
                [ { -e | --encryption } { AES256 | aws:kms } ]
                [ --sse-kms-key-id SSE_KMS_KEY_ID ]
                [ --aws-region AWS_REGION ]
                [ --aws-await-snapshots-timeout AWS_AWAIT_SNAPSHOTS_TIMEOUT ]
                [ --aws-snapshot-lock-mode { compliance | governance } ]
                [ --aws-snapshot-lock-duration DAYS ]
                [ --aws-snapshot-lock-cool-off-period HOURS ]
                [ --aws-snapshot-lock-expiration-date DATETIME ]
                [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ]
                [ --encryption-scope ENCRYPTION_SCOPE ]
                [ --azure-subscription-id AZURE_SUBSCRIPTION_ID ]
                [ --azure-resource-group AZURE_RESOURCE_GROUP ]
                [ --gcp-project GCP_PROJECT ]
                [ --kms-key-name KMS_KEY_NAME ]
                [ --gcp-zone GCP_ZONE ]
                DESTINATION_URL SERVER_NAME

Description

barman-cloud-backup スクリプトは、Postgresサーバーのローカルバックアップを作成し、 Barmanサーバーをバイパスして、サポートされているクラウドプロバイダーに転送するために使用されます。また、 BarmanサーバーからサポートされているクラウドのいずれかにBarmanバックアップをコピーするためのフックスクリプトpost_backup_retry_scriptとして利用することもできます。

このスクリプトには、 PGDATAおよびテーブルスペースへの読み取りアクセスが必要で、通常はpostgresユーザーとして実行されます。 Barmanサーバーで使用する場合、 Barmanバックアップが保存されているディレクトリへの読み取りアクセスが必要です。 --snapshot- 引数が使用され、選択したクラウドプロバイダーでスナップショットがサポートされている場合、バックアップは指定されたディスク --snapshot-disk のスナップショットを使用して実行されます。バックアップラベルとメタデータもクラウドにアップロードされます。

注釈

GCPの場合、 GOOGLE_APPLICATION_CREDENTIALS envでの認証のみがサポートされています。

重要

設定された --max-archive-size より大きいファイルがデータディレクトリまたはテーブルスペースに存在する場合、クラウドのアップロードは失敗する場合があります。ただし、 1GB までのPostgresファイルは、 --max-archive-size 設定に関係なく、常に許可されます。

Parameters

SERVER_NAME

バックアップするサーバーの名前。

DESTINATION_URL

AWS S3のバケットなどのクラウド宛先のURL。例 s3://bucket/path/to/folder 。

-V / --version

バージョンを表示して終了します。

--help

このヘルプメッセージを表示して終了します。

-v / --verbose

出力の詳細度を増やしますたとえば、 -vv は -v より大きいです。

-q / --quiet

出力の詳細度を減らしますたとえば、 -qq は -q より小さいです。

-t / --test

クラウドの接続をテストして終了します。

--cloud-provider

ストレージバックエンドとして使用するクラウドプロバイダー。

許可されるオプション

aws-s3 。
azure-blob-storage 。
google-cloud-storage 。

-z / --gzip

クラウドへのアップロード中にバックアップをgzip圧縮しますPython < 3.2では使用しないでください。

-j / --bzip2

クラウドへのアップロード中にバックアップをbzip2圧縮しますPython < 3.3では使用しないでください。

--snappy

クラウドへのアップロード中にバックアップをsnappy-圧縮しますオプションの python-snappy ライブラリが必要です。

-h / --host

Postgres接続用のホストまたはUnixソケットデフォルトlibpq設定。

-p / --port

Postgres接続用のポートデフォルトlibpq設定。

-U / --user

Postgres接続のユーザー名デフォルトlibpq設定。

-d / --dbname

Postgres接続のデータベース名またはconninfo文字列デフォルト/"postgres/" 。

-n / --name

barman-cloud-restore や barman-cloud-backup-delete などのコマンドでこのバックアップを参照するために使用できる名前。

-J / --jobs

クラウドストレージにデータをアップロードするサブプロセスの数デフォルト 2 。

-S / --max-archive-size

クラウドストレージにアップロードする際のアーカイブの最大サイズデフォルト 100GB 。

--immediate-checkpoint

初期チェックポイントをできるだけ早く実行するように強制します。

--min-chunk-size

クラウドストレージにアップロードする際の個々のチャンクの最小サイズデフォルト aws-s3 の場合は 5MB 、 azure-blob-storage の場合は 64KB 、 google-cloud-storage には適用されません。

--max-bandwidth

オブジェクトストレージにバックアップするときに1秒ごとにアップロードされるデータの最大量デフォルト 0 -制限なし。

--snapshot-instance

スナップショットとしてバックアップされるディスクが接続されているインスタンス。

--snapshot-disk

スナップショットを取得するディスクの名前。

--tag

クラウドストレージにアップロードされたすべてのファイル、および/またはスナップショットを使用する場合は作成されたスナップショットに追加されるタグ。

--tags

注釈

位置引数の前に --tags を使用している場合、その後に -- を挿入してオプショナル引数の終了を示す必要があります。これは、 -- 以降のすべてを位置引数として扱うようにパーサーに指示します。 -- がないと、 Barmanは位置引数を最後のオプションの値と誤って解釈する可能性があります。

バージョン 3.15 で非推奨: --tags は非推奨です。代わりに --tag を使用してください。

Extra options for the AWS cloud provider

--endpoint-url

デフォルトのS3エンドポイントURLを指定されたものでオーバーライドします。

-P / --aws-profile

プロファイル名AWS資格情報ファイルの INI セクションなど。

--profile 非推奨

プロファイル名AWS資格情報ファイルの INI セクションなど --aws-profile に置き換えられます。

--read-timeout

接続からの読み取りを待機しているときにタイムアウトが発生するまでの秒単位の時間デフォルト 60 秒。

-e / --encryption

アップロードされたデータをS3に保存するときに使用される暗号化アルゴリズム。

許可されるオプション

AES256 。
aws:kms 。

--sse-kms-key-id

S3にアップロードされたデータの暗号化に使用するAWS KMSキーID。独自のキーIDを使用して、またはキーの完全なARNを使用して指定できます。 -e / --encryption が aws:kms に設定されている場合にのみ許可されます。

--aws-region

EC2 VMと、 --snapshot-instance および --snapshot-disk 引数で定義されたストレージボリュームを含むAWSリージョンの名前。

--aws-await-snapshots-timeout

タイムアウトになるまでにAWSでスナップショットが作成されるのを待機する秒単位の時間デフォルト3600秒。

--aws-snapshot-lock-mode

スナップショットのロックモード。これは、 --snapshot-instance および --snapshot-disk が設定されている場合にのみ有効です。

許可されるオプション

compliance 。
governance 。

--aws-snapshot-lock-duration

ロック期間は、スナップショットがロックされた期間日単位であり、1〜36,500の範囲です。ロック期間または有効期限のいずれかを設定します両方ではありません。

--aws-snapshot-lock-cool-off-period

クーリングオフ期間は、 compliance モードでスナップショットをロックするときに指定できるオプションの時間時間単位で、1〜72の範囲で指定します。

--aws-snapshot-lock-expiration-date

ロックの期間は、将来の有効期限によって決まります。 YYYY-MM-DDTHH:MM:SS.sssZ 形式を使用して、スナップショット作成日時から少なくとも1日後である必要があります。ロック期間または有効期限のいずれかを設定します両方ではありません。

Extra options for the Azure cloud provider

--azure-credential / --credential

オプションで、Azureで認証するときに使用する資格情報の種類を指定します。省略すると、Azure Blob Storageの資格情報が環境から取得され、デフォルトのAzure認証フローが他のすべてのAzureサービスでの認証に使用されます。環境で資格情報が見つからない場合、デフォルトのAzure認証フローはAzure Blob Storageにも使用されます。

許可されるオプション

azure-cli 。
managed-identity 。
default 。

--encryption-scope

Azureのデータの暗号化に使用されるAzure Blob Storageサービスで定義された暗号化スコープの名前。

--azure-subscription-id

--snapshot-instance および --snapshot-disk 引数で定義されたインスタンスとストレージボリュームを所有するAzureサブスクリプションのID。

--azure-resource-group

--snapshot-instance および --snapshot-disk 引数で定義されたコンピューティングインスタンスとディスクが属するAzureリソースグループの名前。

Extra options for GCP cloud provider

--gcp-project: ディスクスナップショットを保存するGCPプロジェクト。
--snapshot-gcp-project 非推奨: ディスクスナップショットを保存するGCPプロジェクト --gcp-project に置き換えられます。
--kms-key-name: GCSでアップロードされたデータの暗号化に使用するGCP KMSキーの名前。
--gcp-zone: スナップショットを取得するディスクのゾーン。
--snapshot-zone 非推奨: スナップショットを取得するディスクのゾーン- --gcp-zone に置き換えられます。

`barman-cloud-backup-delete`#

Synopsis

barman-cloud-backup-delete
                [ { -V | --version } ]
                [ --help ]
                [ { { -v | --verbose } | { -q | --quiet } } ]
                [ { -t | --test } ]
                [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ]
                [ --endpoint-url ENDPOINT_URL ]
                [ { -r | --retention-policy } RETENTION_POLICY ]
                [ { -m | --minimum-redundancy } MINIMUM_REDUNDANCY ]
                [ { -b | --backup-id } BACKUP_ID]
                [ --dry-run ]
                [ --check-object-lock ]
                [ { -P | --aws-profile } AWS_PROFILE ]
                [ --profile AWS_PROFILE ]
                [ --read-timeout READ_TIMEOUT ]
                [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ]
                [--batch-size DELETE_BATCH_SIZE]
                SOURCE_URL SERVER_NAME

Description

barman-cloud-backup-delete スクリプトは、 barman-cloud-backup コマンドで作成した1つ以上のバックアップをクラウドストレージから削除し、関連するWALファイルを削除するために使用されます。

バックアップは、バックアップID barman-cloud-backup-list から取得または保持ポリシーによって指定できます。保持ポリシーはBarmanサーバーで使用されるものをミラーリングし、指定されたポリシーを満たすために必要でないすべてのバックアップを削除します。バックアップが削除されると、そのバックアップに関連付けられている未使用のWALファイルも削除されます。

WALは、次の場合に未使用とみなされます。

WALは、残っている最も古いバックアップのbegin_wal値よりも古いです。
WALは、クラウドに保存されるアーカイブバックアップには必要ありません。

注釈

GCPの場合、 GOOGLE_APPLICATION_CREDENTIALS envでの認証のみがサポートされています。

重要

各バックアップの削除には、クラウドプロバイダーへの3つの個別の要求が含まれます。1つはバックアップファイル用、もう1つは backup.info ファイル用、もう1つは関連するWAL用です。大量のバックアップがクラウドストレージに蓄積されている場合、保持ポリシーによって削除すると、大量の削除要求が発生する場合があります。

重要

MinIOを使用している場合、最新リリースまたは少なくとも RELEASE.2025-02-03T21-03-04Z 以降に must upgrade して、互換性を確保し、障害を回避します。

Parameters

SERVER_NAME

削除するバックアップを保持するサーバーの名前。

SOURCE_URL

AWS S3のバケットなどのクラウドソースのURL。例 s3://bucket/path/to/folder 。

-V / --version

バージョンを表示して終了します。

--help

このヘルプメッセージを表示して終了します。

-v / --verbose

出力の詳細度を増やしますたとえば、 -vv は -v より大きいです。

-q / --quiet

出力の詳細度を減らしますたとえば、 -qq は -q より小さいです。

-t / --test

クラウドの接続をテストして終了します。

--cloud-provider

ストレージバックエンドとして使用するクラウドプロバイダー。

許可されるオプションは次のとおりです。

aws-s3 。
azure-blob-storage 。
google-cloud-storage 。

-b / --backup-id

削除するバックアップのID。バックアップIDの代わりにショートカットを使用できます。

-m / --minimum-redundancy

常に使用可能なバックアップの最小数。

-r / --retention-policy

指定した場合、提供された保持ポリシーに従って、削除の対象となるすべてのバックアップを削除します。

構文 REDUNDANCY value | RECOVERY WINDOW OF value { DAYS | WEEKS | MONTHS }

--batch-size

クラウドプロバイダーへの1回の要求で削除されるオブジェクトの最大数。設定されていない場合、指定されたクラウドプロバイダーの最大許可バッチサイズが使用されますaws-s3の場合は 1000 、azure-blob-storageの場合は 256 、およびgoogle-cloud-storageの場合は 100 。

--dry-run

削除する必要があるオブジェクトを見つけますが、削除しません。

Extra options for the AWS cloud provider

--check-object-lock

削除する前に、バックアップファイルがS3オブジェクトロックで保護されているかどうかを確認します。 S3バケットにオブジェクトロックが構成されており、削除操作がオブジェクトレベルの保持ポリシーを尊重したい場合に、これを有効にします。ベースバックアップファイルがアクティブな保持期間またはリーガルホールドによってロックされている場合、削除はエラーで中止されます。

パフォーマンス上の理由から、ロックチェックはベースバックアップファイルに対してのみ実行されます。ベースバックアップが削除されると、対応するWALファイルは使用できなくなるためです。このチェックでは、ロックステータスを確認するためにファイルごとに1つの要求が必要であるため、多くのファイルを含むバックアップの削除時間が増加する場合があることに注意してください。この機能はAWS S3互換オブジェクトストアでのみ利用でき、 s3:GetObjectRetention および s3:GetObjectLegalHold IAM権限も必要です。

--endpoint-url

デフォルトのS3エンドポイントURLを指定されたものでオーバーライドします。

-P / --aws-profile

プロファイル名AWS資格情報ファイルの INI セクションなど。

--profile 非推奨

プロファイル名AWS資格情報ファイルの INI セクションなど --aws-profile に置き換えられます。

--read-timeout

接続からの読み取りを待機しているときにタイムアウトが発生するまでの秒単位の時間デフォルト 60 秒。

Extra options for the Azure cloud provider

--azure-credential / --credential

許可されるオプションは次のとおりです。

azure-cli 。
managed-identity 。
default 。

`barman-cloud-backup-show`#

Synopsis

barman-cloud-backup-show
                [ { -V | --version } ]
                [ --help ]
                [ { { -v | --verbose } | { -q | --quiet } } ]
                [ { -t | --test } ]
                [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ]
                [ --endpoint-url ENDPOINT_URL ]
                [ { -P | --aws-profile } AWS_PROFILE ]
                [ --profile AWS_PROFILE ]
                [ --read-timeout READ_TIMEOUT ]
                [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ]
                [ --format FORMAT ]
                SOURCE_URL SERVER_NAME BACKUP_ID

Description

このスクリプトは、 barman-cloud-backup コマンドで作成された特定のバックアップに関する詳細情報を表示します。出力は、 barman-cloud-backup コマンドリファレンスの barman show-backup に似ていますが、情報が少ないです。

注釈

GCPの場合、 GOOGLE_APPLICATION_CREDENTIALS envでの認証のみがサポートされています。

Parameters

BACKUP_ID

バックアップのID。バックアップIDの代わりにショートカットを使用できます。

SERVER_NAME

表示するバックアップを保持するサーバーの名前。

SOURCE_URL

AWS S3のバケットなどのクラウドソースのURL。例 s3://bucket/path/to/folder 。

-V / --version

バージョンを表示して終了します。

--help

このヘルプメッセージを表示して終了します。

-v / --verbose

出力の詳細度を増やしますたとえば、 -vv は -v より大きいです。

-q / --quiet

出力の詳細度を減らしますたとえば、 -qq は -q より小さいです。

-t / --test

クラウドの接続をテストして終了します。

--cloud-provider

ストレージバックエンドとして使用するクラウドプロバイダー。

許可されるオプションは次のとおりです。

aws-s3 。
azure-blob-storage 。
google-cloud-storage 。

--format

出力フォーマット console または json 。デフォルト console 。

Extra options for the AWS cloud provider

--endpoint-url: デフォルトのS3エンドポイントURLを指定されたものでオーバーライドします。
-P / --aws-profile: プロファイル名AWS資格情報ファイルの INI セクションなど。
--profile 非推奨: プロファイル名AWS資格情報ファイルの INI セクションなど --aws-profile に置き換えられます。
--read-timeout: 接続からの読み取りを待機しているときにタイムアウトが発生するまでの秒単位の時間デフォルト 60 秒。

Extra options for the Azure cloud provider

--azure-credential / --credential

許可されるオプションは次のとおりです。

azure-cli 。
managed-identity 。
default 。

`barman-cloud-backup-list`#

Synopsis

barman-cloud-backup-list
                [ { -V | --version } ]
                [ --help ]
                [ { { -v | --verbose } | { -q | --quiet } } ]
                [ { -t | --test } ]
                [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ]
                [ --endpoint-url ENDPOINT_URL ]
                [ { -P | --aws-profile } AWS_PROFILE ]
                [ --profile AWS_PROFILE ]
                [ --read-timeout READ_TIMEOUT ]
                [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ]
                [ --format FORMAT ]
                SOURCE_URL SERVER_NAME

Description

このスクリプトは、クラウドに保存されている barman-cloud-backup コマンドを使用して作成されたバックアップをリストします。

注釈

GCPの場合、 GOOGLE_APPLICATION_CREDENTIALS envでの認証のみがサポートされています。

Parameters

SERVER_NAME

リストするバックアップを保持するサーバーの名前。

SOURCE_URL

AWS S3のバケットなどのクラウドソースのURL。例 s3://bucket/path/to/folder 。

-V / --version

バージョンを表示して終了します。

--help

このヘルプメッセージを表示して終了します。

-v / --verbose

出力の詳細度を増やしますたとえば、 -vv は -v より大きいです。

-q / --quiet

出力の詳細度を減らしますたとえば、 -qq は -q より小さいです。

-t / --test

クラウドの接続をテストして終了します。

--cloud-provider

ストレージバックエンドとして使用するクラウドプロバイダー。

許可されるオプションは次のとおりです。

aws-s3 。
azure-blob-storage 。
google-cloud-storage 。

--format

出力フォーマット console または json 。デフォルト console 。

Extra options for the AWS cloud provider

--endpoint-url: デフォルトのS3エンドポイントURLを指定されたものでオーバーライドします。
-P / --aws-profile: プロファイル名AWS資格情報ファイルの INI セクションなど。
--profile 非推奨: プロファイル名AWS資格情報ファイルの INI セクションなど --aws-profile に置き換えられます。
--read-timeout: 接続からの読み取りを待機しているときにタイムアウトが発生するまでの秒単位の時間デフォルト 60 秒。

Extra options for the Azure cloud provider

--azure-credential / --credential

許可されるオプションは次のとおりです。

azure-cli 。
managed-identity 。
default 。

`barman-cloud-backup-keep`#

Synopsis

barman-cloud-backup-keep
                [ { -V | --version } ]
                [ --help ]
                [ { { -v | --verbose } | { -q | --quiet } } ]
                [ { -t | --test } ]
                [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ]
                [ --endpoint-url ENDPOINT_URL ]
                [ { -P | --aws-profile } AWS_PROFILE ]
                [ --profile AWS_PROFILE ]
                [ --read-timeout READ_TIMEOUT ]
                [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ]
                [ { { -r | --release } | { -s | --status } | --target { full | standalone } } ]
                SOURCE_URL SERVER_NAME BACKUP_ID

Description

このスクリプトを使用して、クラウドストレージのバックアップをアーカイブバックアップとして指定し、保持ポリシーに関係なく無期限の保持を保証します。

このスクリプトを使用すると、 barman-cloud-backup で以前に作成したバックアップをアーカイブバックアップとしてマークできます。アーカイブとしてフラグが設定されると、これらのバックアップは無期限に保存され、標準の保持ポリシーの対象ではありません。

注釈

GCPの場合、 GOOGLE_APPLICATION_CREDENTIALS envでの認証のみがサポートされています。

重要

MinIOを使用している場合、最新のリリースまたは少なくとも RELEASE.2025-02-03T21-03-04Z 以降に must upgrade して、互換性を確保し、keepアノテーションをリリースする際の障害を回避します。

Parameters

SERVER_NAME

保持するバックアップを保持するサーバーの名前。

SOURCE_URL

AWS S3のバケットなどのクラウドソースのURL。例 s3://bucket/path/to/folder 。

BACKUP_ID

保持するバックアップのID。バックアップIDの代わりにショートカットを使用できます。

-V / --version

バージョンを表示して終了します。

--help

このヘルプメッセージを表示して終了します。

-v / --verbose

出力の詳細度を増やしますたとえば、 -vv は -v より大きいです。

-q / --quiet

出力の詳細度を減らしますたとえば、 -qq は -q より小さいです。

-t / --test

クラウドの接続をテストして終了します。

--cloud-provider

ストレージバックエンドとして使用するクラウドプロバイダー。

許可されるオプションは次のとおりです。

aws-s3 。
azure-blob-storage 。
google-cloud-storage 。

-r / --release

指定すると、コマンドはkeepアノテーションを削除し、バックアップは削除の対象になります。

-s / --status

バックアップのkeepステータスを出力します。

--target

このバックアップのリカバリターゲットを指定します。許可されるオプションは次のとおりです。

full
standalone

Extra options for the AWS cloud provider

--endpoint-url: デフォルトのS3エンドポイントURLを指定されたものでオーバーライドします。
-P / --aws-profile: プロファイル名AWS資格情報ファイルの INI セクションなど。
--profile 非推奨: プロファイル名AWS資格情報ファイルの INI セクションなど --aws-profile に置き換えられます。
--read-timeout: 接続からの読み取りを待機しているときにタイムアウトが発生するまでの秒単位の時間デフォルト 60 秒。

Extra options for the Azure cloud provider

--azure-credential / --credential

許可されるオプションは次のとおりです。

azure-cli 。
managed-identity 。
default 。

`barman-cloud-check-wal-archive`#

Synopsis

barman-cloud-check-wal-archive
                [ { -V | --version } ]
                [ --help ]
                [ { { -v | --verbose } | { -q | --quiet } } ]
                [ { -t | --test } ]
                [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ]
                [ --endpoint-url ENDPOINT_URL ]
                [ { -P | --aws-profile } AWS_PROFILE ]
                [ --profile AWS_PROFILE ]
                [ --read-timeout READ_TIMEOUT ]
                [ { --azure-credential | --credential }
                  { azure-cli | managed-identity | default } ]
                [ --timeline TIMELINE ]
                DESTINATION_URL SERVER_NAME

Description

サーバーのWALアーカイブ宛先が新しいPostgresクラスターでの使用に適していることを確認します。デフォルトでは、WALアーカイブが空であるか、ターゲットバケットが見つからない場合、チェックは成功します。他の条件では失敗します。

注釈

barman-cloud-check-wal-archive コマンドは、初期 HeadBucket 呼び出しを実行して、ターゲットバケットがS3ストレージに既に存在するかどうかを確認します。バケットが存在しない場合、コマンドは自動的に作成しようとします。

これは、これらの操作バケットの存在チェックと自動作成を実行する唯一のBarmanコマンドです。

注釈

GCPの場合、 GOOGLE_APPLICATION_CREDENTIALS envでの認証のみがサポートされています。

Parameters

SERVER_NAME

確認する必要があるサーバーの名前。

DESTINATION_URL

AWS S3のバケットなどのクラウド宛先のURL。例 s3://bucket/path/to/folder 。

-V / --version

バージョンを表示して終了します。

--help

このヘルプメッセージを表示して終了します。

-v / --verbose

出力の詳細度を増やしますたとえば、 -vv は -v より大きいです。

-q / --quiet

出力の詳細度を減らしますたとえば、 -qq は -q より小さいです。

-t / --test

クラウドの接続をテストして終了します。

--cloud-provider

ストレージバックエンドとして使用するクラウドプロバイダー。

許可されるオプションは次のとおりです。

aws-s3 。
azure-blob-storage 。
google-cloud-storage 。

--timeline

WALがチェックを失敗させる最も古いタイムライン。

Extra options for the AWS cloud provider

--endpoint-url: デフォルトのS3エンドポイントURLを指定されたものでオーバーライドします。
-P / --aws-profile: プロファイル名AWS資格情報ファイルの INI セクションなど。
--profile 非推奨: プロファイル名AWS資格情報ファイルの INI セクションなど --aws-profile に置き換えられます。
--read-timeout: 接続からの読み取りを待機しているときにタイムアウトが発生するまでの秒単位の時間デフォルト 60 秒。

Extra options for the Azure cloud provider

--azure-credential / --credential

許可されるオプションは次のとおりです。

azure-cli 。
managed-identity 。
default 。

`barman-cloud-restore`#

Synopsis

barman-cloud-restore
                [ { -V | --version } ]
                [ --help ]
                [ { { -v | --verbose } | { -q | --quiet } } ]
                [ { -t | --test } ]
                [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ]
                [ --endpoint-url ENDPOINT_URL ]
                [ { -P | --aws-profile } AWS_PROFILE ]
                [ --profile AWS_PROFILE ]
                [ --read-timeout READ_TIMEOUT ]
                [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ]
                [ --snapshot-recovery-instance SNAPSHOT_RECOVERY_INSTANCE ]
                [ --snapshot-recovery-zone GCP_ZONE ]
                [ --aws-region AWS_REGION ]
                [ --gcp-zone GCP_ZONE ]
                [ --azure-resource-group AZURE_RESOURCE_GROUP ]
                [ --tablespace NAME:LOCATION [ --tablespace NAME:LOCATION ... ] ]
                [ --target-lsn LSN ]
                [ --target-time TIMESTAMP ]
                [ --target-tli TLI ]
                SOURCE_URL SERVER_NAME BACKUP_ID RECOVERY_DESTINATION

Description

このスクリプトを使用して、 barman-cloud-backup コマンドで作成されたクラウドストレージからバックアップを直接復元します。さらに、このスクリプトは、接続されたディスクが正しいスナップショットからクローン化されたことを確認し、オブジェクトストレージからバックアップラベルをダウンロードすることにより、スナップショットバックアップからのリカバリーの準備をできます。

このコマンドは、リカバリのためにPostgresを自動的に準備しません。 Postgresを確実に起動するには、手動または外部ツールを使用して、PITR`オプション、カスタム ``restore_command` 値、シグナルファイル、または必要なWALファイルを手動で管理する必要があります。

注釈

GCPの場合、 GOOGLE_APPLICATION_CREDENTIALS envでの認証のみがサポートされています。

Parameters

SERVER_NAME

復元するバックアップを保持するサーバーの名前。

SOURCE_URL

AWS S3のバケットなどのクラウドソースのURL。例 s3://bucket/path/to/folder 。

BACKUP_ID

復元するバックアップのID。バックアップIDの代わりにショートカットを使用できます。それに加えて、 auto を使用して、 Barmanに復元操作に最適なバックアップを自動的に見つけさせることができます。

RECOVERY_DESTINATION

リカバリー用のディレクトリへのパス。

-V / --version

バージョンを表示して終了します。

--help

このヘルプメッセージを表示して終了します。

-v / --verbose

出力の詳細度を増やしますたとえば、 -vv は -v より大きいです。

-q / --quiet

出力の詳細度を減らしますたとえば、 -qq は -q より小さいです。

-t / --test

クラウドの接続をテストして終了します。

--cloud-provider

ストレージバックエンドとして使用するクラウドプロバイダー。

許可されるオプションは次のとおりです。

aws-s3 。
azure-blob-storage 。
google-cloud-storage 。

--snapshot-recovery-instance

スナップショットから復元されたディスクが接続されているインスタンス。

--tablespace

テーブルスペースの再配置ルール。

--target-lsn

リカバリターゲットlsn、たとえば 3/64000000 。

--target-time

タイムゾーンの有無にかかわらず、 %Y-%m-%d %H:%M:%S 形式でのリカバリターゲットのタイムスタンプ。

--target-tli

リカバリターゲットのタイムライン。

Extra options for the AWS cloud provider

--endpoint-url: デフォルトのS3エンドポイントURLを指定されたものでオーバーライドします。
-P / --aws-profile: プロファイル名AWS資格情報ファイルの INI セクションなど。
--profile 非推奨: プロファイル名AWS資格情報ファイルの INI セクションなど --aws-profile に置き換えられます。
--read-timeout: 接続からの読み取りを待機しているときにタイムアウトが発生するまでの秒単位の時間デフォルト 60 秒。
--aws-region: EC2 VMと、 --snapshot-instance および --snapshot-disk 引数で定義されたストレージボリュームを含むAWSリージョンの名前。

Extra options for the Azure cloud provider

--azure-credential / --credential

許可されるオプションは次のとおりです。

azure-cli 。
managed-identity 。
default 。

--azure-resource-group

--snapshot-instance および --snapshot-disk 引数で定義されたコンピューティングインスタンスとディスクが属するAzureリソースグループの名前。

Extra options for GCP cloud provider

--gcp-zone: スナップショットを取得するディスクのゾーン。
--snapshot-recovery-zone 非推奨: スナップショットリカバリーのインスタンスとディスクを含むゾーン - --gcp-zone に置き換えられます。

`barman-cloud-wal-archive`#

Synopsis

barman-cloud-wal-archive
                [ { -V | --version } ]
                [ --help ]
                [ { { -v | --verbose } | { -q | --quiet } } ]
                [ { -t | --test } ]
                [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ]
                [ { { -z | --gzip } | { -j | --bzip2 } | --xz | --snappy | --zstd | --lz4 } ]
                [ --compression-level COMPRESSION_LEVEL ]
                [ --tag KEY,VALUE [ --tag KEY,VALUE ... ] ]
                [ --history-tag KEY,VALUE [ --history-tag KEY,VALUE ... ] ]
                [ --endpoint-url ENDPOINT_URL ]
                [ { -P | --aws-profile } AWS_PROFILE ]
                [ --profile AWS_PROFILE ]
                [ --read-timeout READ_TIMEOUT ]
                [ { -e | --encryption } ENCRYPTION ]
                [ --sse-kms-key-id SSE_KMS_KEY_ID ]
                [ { --azure-credential | --credential } { azure-cli | managed-identity |
                  default } ]
                [ --encryption-scope ENCRYPTION_SCOPE ]
                [ --max-block-size MAX_BLOCK_SIZE ]
                [ --max-concurrency MAX_CONCURRENCY ]
                [ --max-single-put-size MAX_SINGLE_PUT_SIZE ]
                [ --kms-key-name KMS_KEY_NAME ]
                DESTINATION_URL SERVER_NAME [ WAL_PATH ]

Description

barman-cloud-wal-archive コマンドは、Postgresサーバーの archive_command で使用して、WALファイルをクラウドストレージに直接シップするように設計されています。

注釈

Python 2またはPython 3のサポートされていないバージョンを使用している場合は、圧縮オプション --gzip または --bzip2 の使用を避けてください。このスクリプトは、Python < 3.2でgzip圧縮されたWAL、またはPython < 3.3でbzip2圧縮されたWALを復元できません。

このスクリプトにより、 Barmanサーバーをバイパスして、WALファイルをクラウドストレージに直接転送できます。さらに、WALアーカイブpre_archive_retry_scriptのフックスクリプトとして利用できます。

注釈

GCPの場合、 GOOGLE_APPLICATION_CREDENTIALS envでの認証のみがサポートされています。

Parameters

SERVER_NAME

WALをアーカイブするサーバーの名前。

DESTINATION_URL

AWS S3のバケットなどのクラウド宛先のURL。例 s3://bucket/path/to/folder 。

WAL_PATH

'%p'キーワードの値 archive_command によると。

-V / --version

バージョンを表示して終了します。

--help

このヘルプメッセージを表示して終了します。

-v / --verbose

出力の詳細度を増やしますたとえば、 -vv は -v より大きいです。

-q / --quiet

出力の詳細度を減らしますたとえば、 -qq は -q より小さいです。

-t / --test

クラウドの接続をテストして終了します。

--cloud-provider

ストレージバックエンドとして使用するクラウドプロバイダー。

許可されるオプションは次のとおりです。

aws-s3 。
azure-blob-storage 。
google-cloud-storage 。

-z / --gzip

クラウドにアップロードするときにWALをgzip圧縮します。

-j / --bzip2

クラウドへのアップロード中にWALをbzip2-圧縮します。

--xz

クラウドにアップロードするときにWALをxz圧縮します。

--snappy

クラウドへのアップロード中にWALをSnappy-圧縮します python-snappy Pythonライブラリをインストールする必要があります。

--zstd

クラウドへのアップロード中にWALをzstd圧縮します zstandard Pythonライブラリをインストールする必要があります。

--lz4

クラウドへのアップロード中にWALをlz4圧縮します lz4 Pythonライブラリをインストールする必要があります。

--compression-level

選択した圧縮アルゴリズムで使用される圧縮レベル。有効な値は、選択したアルゴリズムまたは事前定義されたラベルのいずれか low 、 medium 、および high のサポートされている範囲内の整数です。各アルゴリズムの範囲と、各事前定義されたラベルがマップするレベルは low で見つかります。

--tag

クラウドストレージにアーカイブされたWALファイルに追加されるタグ。

--tags

クラウドストレージにアーカイブされたWALファイルに追加されるタグ。

注釈

バージョン 3.15 で非推奨: --tags は非推奨です。代わりに --tag を使用してください。

--history-tag: クラウドストレージにアーカイブされた履歴ファイルに追加されるタグ。
--history-tags: クラウドストレージにアーカイブされた履歴ファイルに追加されるタグ。

注釈

位置引数の前に --history-tags を使用している場合、その後に -- を挿入してオプショナル引数の終了を示す必要があります。これは、 -- 以降のすべてを位置引数として扱うようにパーサーに指示します。 -- がないと、 Barmanは位置引数を最後のオプションの値と誤って解釈する可能性があります。

バージョン 3.15 で非推奨: --history-tags は非推奨です。代わりに --history-tag を使用してください。

Extra options for the AWS cloud provider

--endpoint-url

デフォルトのS3エンドポイントURLを指定されたものでオーバーライドします。

-P / --aws-profile

プロファイル名AWS資格情報ファイルの INI セクションなど。

--profile 非推奨

プロファイル名AWS資格情報ファイルの INI セクションなど --aws-profile に置き換えられます。

--read-timeout

接続からの読み取りを待機しているときにタイムアウトが発生するまでの秒単位の時間デフォルト 60 秒。

-e / --encryption

アップロードされたデータをS3に保存するときに使用される暗号化アルゴリズム。

許可されるオプション

AES256 。
aws:kms 。

--sse-kms-key-id

Extra options for the Azure cloud provider

--azure-credential / --credential

許可されるオプションは次のとおりです。

azure-cli 。
managed-identity 。
default 。

--encryption-scope

Azureのデータの暗号化に使用されるAzure Blob Storageサービスで定義された暗号化スコープの名前。

--max-block-size

コンカレントチャンク方法デフォルト 4MB を介してオブジェクトをアップロードするときに使用されるチャンクサイズ。

--max-concurrency

同時にアップロードされるチャンクの最大数デフォルト 1 。

--max-single-put-size

Azureクライアントが単一の要求でオブジェクトをアップロードする最大サイズデフォルト 64MB 。これが適用された圧縮後のPostgres WALセグメントサイズよりも低く設定されている場合、WALアーカイブのコンカレントチャンクアップロード方法が使用されます。

Extra options for GCP cloud provider

--kms-key-name: GCSでアップロードされたデータの暗号化に使用するGCP KMSキーの名前。

`barman-cloud-wal-restore`#

Synopsis

barman-cloud-wal-restore
                [ { -V | --version } ]
                [ --help ]
                [ { { -v | --verbose } | { -q | --quiet } } ]
                [ { -t | --test } ]
                [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ]
                [ --endpoint-url ENDPOINT_URL ]
                [ { -P | --aws-profile } AWS_PROFILE ]
                [ --profile AWS_PROFILE ]
                [ --read-timeout READ_TIMEOUT ]
                [ { --azure-credential | --credential } { azure-cli | managed-identity
                  | default } ]
                [ --no-partial ]
                SOURCE_URL SERVER_NAME WAL_NAME WAL_DEST

Description

barman-cloud-wal-restore スクリプトは、クラウドストレージからWALファイルを取得し、 BarmanサーバーをバイパスしてPostgresスタンバイサーバーに直接配置するための restore_command として機能します。

このスクリプトは、以前に barman-cloud-wal-archive コマンドでアーカイブされたWALファイルをダウンロードするために使用されます。 --no-partial オプションを呼び出して、 .partial ファイルの自動ダウンロードを無効にします。

重要

ターゲットPostgresノードで、 pg_wal とスプールディレクトリが同じファイルシステム上にある場合、ファイルは名前変更を介して移動されます。これは、コピーや削除よりも高速です。これにより、WALファイルの提供が大幅に高速化されます。ディレクトリが別のファイルシステム上にある場合でも、プロセスにはコピーと削除が含まれるため、その場合パフォーマンスの向上はありません。

注釈

GCPの場合、 GOOGLE_APPLICATION_CREDENTIALS envでの認証のみがサポートされています。

Parameters

SERVER_NAME

WALが復元されるサーバーの名前。

SOURCE_URL

AWS S3のバケットなどのクラウドソースのURL。例 s3://bucket/path/to/folder 。

WAL_NAME

'%f'キーワードの値 restore_command によると。

WAL_DEST

'%p'キーワードの値 restore_command によると。

-V / --version

バージョンを表示して終了します。

--help

このヘルプメッセージを表示して終了します。

-v / --verbose

出力の詳細度を増やしますたとえば、 -vv は -v より大きいです。

-q / --quiet

出力の詳細度を減らしますたとえば、 -qq は -q より小さいです。

-t / --test

クラウドの接続をテストして終了します。

--cloud-provider

ストレージバックエンドとして使用するクラウドプロバイダー。

許可されるオプションは次のとおりです。

aws-s3 。
azure-blob-storage 。
google-cloud-storage 。

--no-partial

部分的なWALファイルをダウンロードしないでください

Extra options for the AWS cloud provider

--endpoint-url: デフォルトのS3エンドポイントURLを指定されたものでオーバーライドします。
-P / --aws-profile: プロファイル名AWS資格情報ファイルの INI セクションなど。
--profile 非推奨: プロファイル名AWS資格情報ファイルの INI セクションなど --aws-profile に置き換えられます。
--read-timeout: 接続からの読み取りを待機しているときにタイムアウトが発生するまでの秒単位の時間デフォルト 60 秒。

Extra options for the Azure cloud provider

--azure-credential / --credential

許可されるオプションは次のとおりです。

azure-cli 。
managed-identity 。
default 。

クラウドのBarman#

Barmanクラウドクライアントパッケージ#

インストール#

オブジェクトロックのサポート#

S3オブジェクトロック#

コマンドリファレンス#

barman-cloud-backup#

barman-cloud-backup-delete#

barman-cloud-backup-show#

barman-cloud-backup-list#

barman-cloud-backup-keep#

barman-cloud-check-wal-archive#

barman-cloud-restore#

barman-cloud-wal-archive#

barman-cloud-wal-restore#

`barman-cloud-backup`#

`barman-cloud-backup-delete`#

`barman-cloud-backup-show`#

`barman-cloud-backup-list`#

`barman-cloud-backup-keep`#

`barman-cloud-check-wal-archive`#

`barman-cloud-restore`#

`barman-cloud-wal-archive`#

`barman-cloud-wal-restore`#