marco/plugin-barman-cloud
1
0
Fork 0
mirror of https://github.com/cloudnative-pg/plugin-barman-cloud.git synced 2026-07-07 02:02:21 +02:00
Code Issues Packages Projects Releases Wiki Activity
bbb2c0a15b
plugin-barman-cloud/web/docs/misc.md
Armando Ruocco bbb2c0a15b docs: document wal.restoreAdditionalCommandArgs 
The 'Extra Options' section enumerated every additionalCommandArgs knob
except wal.restoreAdditionalCommandArgs, which already existed in the
API. Add the missing bullet and example so the list is complete.

Signed-off-by: Armando Ruocco <armando.ruocco@enterprisedb.com>
2026-06-03 11:31:37 +02:00

2.9 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, WAL Archiving, and Restore

You can pass additional command-line arguments to the underlying barman-cloud-* commands using the corresponding fields in the ObjectStore configuration.

  • .spec.configuration.data.additionalCommandArgs: for barman-cloud-backup
  • .spec.configuration.data.restoreAdditionalCommandArgs: for barman-cloud-restore
  • .spec.configuration.wal.archiveAdditionalCommandArgs: for barman-cloud-wal-archive
  • .spec.configuration.wal.restoreAdditionalCommandArgs: for barman-cloud-wal-restore

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 Restore Options

kind: ObjectStore
metadata:
  name: my-store
spec:
  configuration:
    data:
      restoreAdditionalCommandArgs:
        - "--read-timeout=900"

Example: Extra WAL Archive Options

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

Example: Extra WAL Restore Options

kind: ObjectStore
metadata:
  name: my-store
spec:
  configuration:
    wal:
      restoreAdditionalCommandArgs:
        - "--read-timeout=60"

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

Enable the pprof debug server for the sidecar

You can enable the instance sidecar's pprof debug HTTP server by adding the --pprof-server=<address> flag to the container's arguments via .spec.instanceSidecarConfiguration.additionalContainerArgs.

Pass a bind address in the form <host>:<port> (for example, 0.0.0.0:6061). An empty value disables the server (disabled by default).

Example

apiVersion: barmancloud.cnpg.io/v1
kind: ObjectStore
metadata:
  name: my-store
spec:
  instanceSidecarConfiguration:
    additionalContainerArgs:
      - "--pprof-server=0.0.0.0:6061"