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用です。大量のバックアップがクラウドストレージに蓄積されている場合、保持ポリシーによって削除すると、大量の削除要求が発生する場合があります。

重要

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 して、互換性を確保し、障害を回避します。

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

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

  • azure-cli 。

  • managed-identity 。

  • default 。

ソースコードを表示