Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions config/crd/bases/barmancloud.cnpg.io_objectstores.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,37 @@ spec:
format: int32
minimum: 1
type: integer
listAdditionalCommandArgs:
description: |-
ListAdditionalCommandArgs represents additional arguments that can be appended
to the 'barman-cloud-backup-list' command-line invocation. This command is
used internally for retention-policy enforcement; flags relevant to the
underlying S3 client (e.g. `--addressing-style=virtual` for strictly
virtual-hosted S3-compatible endpoints) generally belong here as well.

Note:
It's essential to ensure that the provided arguments are valid and supported
by the 'barman-cloud-backup-list' command, to avoid potential errors or
unintended behavior during execution.
items:
type: string
type: array
showAdditionalCommandArgs:
description: |-
ShowAdditionalCommandArgs represents additional arguments that can be appended
to the 'barman-cloud-backup-show' command-line invocation. This command is
used after a successful upload to verify and record metadata about the
freshly-written backup, so flags relevant to the underlying S3 client
(e.g. `--addressing-style=virtual` for strictly virtual-hosted S3-compatible
endpoints) generally belong here as well.

Note:
It's essential to ensure that the provided arguments are valid and supported
by the 'barman-cloud-backup-show' command, to avoid potential errors or
unintended behavior during execution.
items:
type: string
type: array
type: object
destinationPath:
description: |-
Expand Down
31 changes: 31 additions & 0 deletions manifest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,37 @@ spec:
format: int32
minimum: 1
type: integer
listAdditionalCommandArgs:
description: |-
ListAdditionalCommandArgs represents additional arguments that can be appended
to the 'barman-cloud-backup-list' command-line invocation. This command is
used internally for retention-policy enforcement; flags relevant to the
underlying S3 client (e.g. `--addressing-style=virtual` for strictly
virtual-hosted S3-compatible endpoints) generally belong here as well.

Note:
It's essential to ensure that the provided arguments are valid and supported
by the 'barman-cloud-backup-list' command, to avoid potential errors or
unintended behavior during execution.
items:
type: string
type: array
showAdditionalCommandArgs:
description: |-
ShowAdditionalCommandArgs represents additional arguments that can be appended
to the 'barman-cloud-backup-show' command-line invocation. This command is
used after a successful upload to verify and record metadata about the
freshly-written backup, so flags relevant to the underlying S3 client
(e.g. `--addressing-style=virtual` for strictly virtual-hosted S3-compatible
endpoints) generally belong here as well.

Note:
It's essential to ensure that the provided arguments are valid and supported
by the 'barman-cloud-backup-show' command, to avoid potential errors or
unintended behavior during execution.
items:
type: string
type: array
type: object
destinationPath:
description: |-
Expand Down
15 changes: 11 additions & 4 deletions web/docs/misc.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,22 @@ spec:
[...]
```

## Extra Options for Backup and WAL Archiving
## Extra Options for Backup, WAL Archiving, Show, and List

You can pass additional command-line arguments to `barman-cloud-backup` and
`barman-cloud-wal-archive` using the `additionalCommandArgs` field in the
`ObjectStore` configuration.
You can pass additional command-line arguments to each barman-cloud
invocation the plugin shells out to, using the matching
`additionalCommandArgs` fields in the `ObjectStore` configuration.

- `.spec.configuration.data.additionalCommandArgs`: for `barman-cloud-backup`
- `.spec.configuration.data.showAdditionalCommandArgs`: for `barman-cloud-backup-show` (post-write verification)
- `.spec.configuration.data.listAdditionalCommandArgs`: for `barman-cloud-backup-list` (retention pruning)
- `.spec.configuration.wal.archiveAdditionalCommandArgs`: for `barman-cloud-wal-archive`

If you need a flag that applies to every cloud command — such as
`--addressing-style=virtual` for an S3-compatible endpoint that only
accepts virtual-hosted-style requests — set it on all of the above so
both writes and the post-write read-back / retention steps honor it.

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

Expand Down