Skip to content

Commit c5a195f

Browse files
committed
doc: plugin parameters
Add documentation for the parameters that can be set for the plugin. Closes #327 Signed-off-by: Francesco Canovai <[email protected]>
1 parent fc0d141 commit c5a195f

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

web/docs/parameters.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
sidebar_position: 100
3+
---
4+
5+
# Parameters
6+
7+
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
8+
9+
The following parameters are available for the Barman Cloud Plugin:
10+
11+
- `barmanObjectName`: references the `ObjectStore` resource to be used by the
12+
plugin.
13+
- `serverName`: Specifies the server name in the object store.
14+
15+
:::important
16+
The `serverName` parameter within the `ObjectStore` resource exists only for
17+
API compatibility with the in-tree `barmanObjectStore` and is ignored by the
18+
plugin. Use the `serverName` plugin parameter when needed.

0 commit comments

Comments
 (0)