From e9dc671b0e360dfde0dda9dc38182411254a5a37 Mon Sep 17 00:00:00 2001 From: Armando Ruocco Date: Wed, 13 May 2026 11:59:55 +0200 Subject: [PATCH] docs: document data.restoreAdditionalCommandArgs 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 --- web/docs/misc.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/web/docs/misc.md b/web/docs/misc.md index 0f03b28..77eb97a 100644 --- a/web/docs/misc.md +++ b/web/docs/misc.md @@ -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 -`barman-cloud-wal-archive` using the `additionalCommandArgs` field in the -`ObjectStore` configuration. +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` Each field accepts a list of string arguments. If an argument is already @@ -58,6 +59,19 @@ spec: - "--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 ```yaml