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

docs: document data.restoreAdditionalCommandArgs

Browse Source 
Extend the "Extra Options" section in `misc.md` to cover
`barman-cloud-restore` alongside backup and WAL archiving, and add a
usage example for `.spec.configuration.data.restoreAdditionalCommandArgs`.

Refs #821

Signed-off-by: Armando Ruocco <armando.ruocco@enterprisedb.com>
This commit is contained in:
Armando Ruocco 2026-05-13 11:59:55 +02:00 committed by Leonardo Cecchi
parent ddb2154fae
commit e9dc671b0e
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
web/docs/misc.md
View File

@ -32,13 +32,14 @@ spec:
[...] [...]
``` ```
## Extra Options for Backup and WAL Archiving ## Extra Options for Backup, WAL Archiving, and Restore
You can pass additional command-line arguments to `barman-cloud-backup` and You can pass additional command-line arguments to the underlying
`barman-cloud-wal-archive` using the `additionalCommandArgs` field in the `barman-cloud-*` commands using the corresponding fields in the `ObjectStore`
`ObjectStore` configuration. configuration.
- `.spec.configuration.data.additionalCommandArgs`: for `barman-cloud-backup` - `.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.archiveAdditionalCommandArgs`: for `barman-cloud-wal-archive`
Each field accepts a list of string arguments. If an argument is already Each field accepts a list of string arguments. If an argument is already
@ -58,6 +59,19 @@ spec:
- "--read-timeout=60" - "--read-timeout=60"
``` ```
### Example: Extra Restore Options
```yaml
kind: ObjectStore
metadata:
name: my-store
spec:
configuration:
data:
restoreAdditionalCommandArgs:
- "--read-timeout=900"
```
### Example: Extra WAL Archive Options ### Example: Extra WAL Archive Options
```yaml ```yaml