diff --git a/web/docs/parameters.md b/web/docs/parameters.md new file mode 100644 index 0000000..72af6b9 --- /dev/null +++ b/web/docs/parameters.md @@ -0,0 +1,18 @@ +--- +sidebar_position: 100 +--- + +# Parameters + + + +The following parameters are available for the Barman Cloud Plugin: + +- `barmanObjectName`: references the `ObjectStore` resource to be used by the + plugin. +- `serverName`: Specifies the server name in the object store. + +:::important + The `serverName` parameter within the `ObjectStore` resource exists only for + API compatibility with the in-tree `barmanObjectStore` and is ignored by the + plugin. Use the `serverName` plugin parameter when needed.