From 3fee90befd908ca45509e5225d6de1844824fc03 Mon Sep 17 00:00:00 2001 From: Francesco Canovai Date: Fri, 9 May 2025 13:20:18 +0200 Subject: [PATCH] docs: plugin parameters (#330) Closes #327 Signed-off-by: Francesco Canovai Signed-off-by: Marco Nenciarini Co-authored-by: Marco Nenciarini --- web/docs/parameters.md | 19 +++++++++++++++++++ web/docs/usage.md | 6 ++++++ 2 files changed, 25 insertions(+) create mode 100644 web/docs/parameters.md 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