diff --git a/web/docs/parameters.md b/web/docs/parameters.md new file mode 100644 index 0000000..ca0cd2b --- /dev/null +++ b/web/docs/parameters.md @@ -0,0 +1,19 @@ +--- +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 in the `ObjectStore` resource is retained solely for +API compatibility with the in-tree `barmanObjectStore` and must always be left empty. +When needed, use the `serverName` plugin parameter in the Cluster configuration instead. +::: diff --git a/web/docs/usage.md b/web/docs/usage.md index 3c22b2a..1c464e8 100644 --- a/web/docs/usage.md +++ b/web/docs/usage.md @@ -49,6 +49,12 @@ The `.spec.configuration` schema follows the same format as the Refer to [the CloudNativePG documentation](https://cloudnative-pg.io/documentation/preview/backup_barmanobjectstore/) for additional details. +:::important +The `serverName` parameter in the `ObjectStore` resource is retained solely for +API compatibility with the in-tree `barmanObjectStore` and must always be left empty. +When needed, use the `serverName` plugin parameter in the Cluster configuration instead. +::: + ## Configuring WAL Archiving Once the `ObjectStore` is defined, you can configure your PostgreSQL cluster