Skip to content

Commit a2b04eb

Browse files
committed
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 <armando.ruocco@enterprisedb.com>
1 parent 3d80a8c commit a2b04eb

1 file changed

Lines changed: 18 additions & 4 deletions

File tree

web/docs/misc.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,14 @@ spec:
3232
[...]
3333
```
3434

35-
## Extra Options for Backup and WAL Archiving
35+
## Extra Options for Backup, WAL Archiving, and Restore
3636

37-
You can pass additional command-line arguments to `barman-cloud-backup` and
38-
`barman-cloud-wal-archive` using the `additionalCommandArgs` field in the
39-
`ObjectStore` configuration.
37+
You can pass additional command-line arguments to the underlying
38+
`barman-cloud-*` commands using the corresponding fields in the `ObjectStore`
39+
configuration.
4040

4141
- `.spec.configuration.data.additionalCommandArgs`: for `barman-cloud-backup`
42+
- `.spec.configuration.data.restoreAdditionalCommandArgs`: for `barman-cloud-restore`
4243
- `.spec.configuration.wal.archiveAdditionalCommandArgs`: for `barman-cloud-wal-archive`
4344

4445
Each field accepts a list of string arguments. If an argument is already
@@ -58,6 +59,19 @@ spec:
5859
- "--read-timeout=60"
5960
```
6061
62+
### Example: Extra Restore Options
63+
64+
```yaml
65+
kind: ObjectStore
66+
metadata:
67+
name: my-store
68+
spec:
69+
configuration:
70+
data:
71+
restoreAdditionalCommandArgs:
72+
- "--read-timeout=900"
73+
```
74+
6175
### Example: Extra WAL Archive Options
6276
6377
```yaml

0 commit comments

Comments
 (0)