From 33542e1e00e673da553bf2a48c3379af85ac3fe6 Mon Sep 17 00:00:00 2001 From: Francesco Canovai Date: Thu, 8 May 2025 16:15:28 +0200 Subject: [PATCH 1/2] doc: plugin parameters Add documentation for the parameters that can be set for the plugin. Closes #327 Signed-off-by: Francesco Canovai --- web/docs/parameters.md | 18 ++++++++++++++++++ 1 file changed, 18 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 00000000..72af6b9a --- /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. From d7e335f16f96ddd2c70ff50294e995e19632a4eb Mon Sep 17 00:00:00 2001 From: Marco Nenciarini Date: Fri, 9 May 2025 11:47:01 +0200 Subject: [PATCH 2/2] fix: admonition termination, add notice in usage Signed-off-by: Marco Nenciarini --- web/docs/parameters.md | 7 ++++--- web/docs/usage.md | 6 ++++++ 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/web/docs/parameters.md b/web/docs/parameters.md index 72af6b9a..ca0cd2ba 100644 --- a/web/docs/parameters.md +++ b/web/docs/parameters.md @@ -13,6 +13,7 @@ The following parameters are available for the Barman Cloud 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. +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 3c22b2a1..1c464e86 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