mirror of https://github.com/cloudnative-pg/plugin-barman-cloud.git synced 2026-01-11 21:23:12 +01:00

Gabriele Bartolini e26ad81fba

docs: add backup, WAL archive and recovery information (#291 )

Reorganised the content, with a different structure,
added license information and instructions for spellchecking.

Closes #290

Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
Co-authored-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>

2025-05-06 11:49:09 +02:00

1.7 KiB

Raw Blame History

sidebar_position
90

Miscellaneous

Backup Object Tagging

You can attach key-value metadata tags to backup artifacts—such as base backups, WAL files, and history files—via the .spec.configuration section of the ObjectStore resource.

tags: applied to base backups and WAL files
historyTags: applied to history files only

Example

apiVersion: barmancloud.cnpg.io/v1
kind: ObjectStore
metadata:
  name: my-store
spec:
  configuration:
    [...]
    tags:
      backupRetentionPolicy: "expire"
    historyTags:
      backupRetentionPolicy: "keep"
  [...]

Extra Options for Backup and WAL Archiving

You can pass additional command-line arguments to barman-cloud-backup and barman-cloud-wal-archive using the additionalCommandArgs field in the ObjectStore configuration.

.spec.configuration.data.additionalCommandArgs: for barman-cloud-backup
.spec.configuration.wal.additionalCommandArgs: for barman-cloud-wal-archive

Each field accepts a list of string arguments. If an argument is already configured elsewhere in the plugin, the duplicate will be ignored.

Example: Extra Backup Options

kind: ObjectStore
metadata:
  name: my-store
spec:
  configuration:
    data:
      additionalCommandArgs:
        - "--min-chunk-size=5MB"
        - "--read-timeout=60"

Example: Extra WAL Archive Options

kind: ObjectStore
metadata:
  name: my-store
spec:
  configuration:
    wal:
      additionalCommandArgs:
        - "--max-concurrency=1"
        - "--read-timeout=60"

For a complete list of supported options, refer to the official Barman Cloud documentation.

1.7 KiB Raw Blame History