Skip to content

Commit bbb2c0a

Browse files
armruleonardoce
authored andcommitted
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>
1 parent e9dc671 commit bbb2c0a

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

web/docs/misc.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ configuration.
4141
- `.spec.configuration.data.additionalCommandArgs`: for `barman-cloud-backup`
4242
- `.spec.configuration.data.restoreAdditionalCommandArgs`: for `barman-cloud-restore`
4343
- `.spec.configuration.wal.archiveAdditionalCommandArgs`: for `barman-cloud-wal-archive`
44+
- `.spec.configuration.wal.restoreAdditionalCommandArgs`: for `barman-cloud-wal-restore`
4445

4546
Each field accepts a list of string arguments. If an argument is already
4647
configured elsewhere in the plugin, the duplicate will be ignored.
@@ -86,6 +87,19 @@ spec:
8687
- "--read-timeout=60"
8788
```
8889
90+
### Example: Extra WAL Restore Options
91+
92+
```yaml
93+
kind: ObjectStore
94+
metadata:
95+
name: my-store
96+
spec:
97+
configuration:
98+
wal:
99+
restoreAdditionalCommandArgs:
100+
- "--read-timeout=60"
101+
```
102+
89103
For a complete list of supported options, refer to the
90104
[official Barman Cloud documentation](https://docs.pgbarman.org/release/latest/).
91105

0 commit comments

Comments
 (0)