marco/plugin-barman-cloud
1
0
Fork 0
mirror of https://github.com/cloudnative-pg/plugin-barman-cloud.git synced 2026-01-11 21:23:12 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix: admonition termination, add notice in usage

Browse Source 
Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
This commit is contained in:
Marco Nenciarini 2025-05-09 11:47:01 +02:00
parent 33542e1e00
commit d7e335f16f
No known key found for this signature in database
GPG Key ID: 589F03F01BA55038
2 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
web/docs/parameters.md
View File

@ -13,6 +13,7 @@ The following parameters are available for the Barman Cloud Plugin:
- `serverName`: Specifies the server name in the object store. - `serverName`: Specifies the server name in the object store.
:::important :::important
The `serverName` parameter within the `ObjectStore` resource exists only for The `serverName` parameter in the `ObjectStore` resource is retained solely for
API compatibility with the in-tree `barmanObjectStore` and is ignored by the API compatibility with the in-tree `barmanObjectStore` and must always be left empty.
plugin. Use the `serverName` plugin parameter when needed. When needed, use the `serverName` plugin parameter in the Cluster configuration instead.
:::

6
web/docs/usage.md
View File

@ -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/) Refer to [the CloudNativePG documentation](https://cloudnative-pg.io/documentation/preview/backup_barmanobjectstore/)
for additional details. 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 ## Configuring WAL Archiving
Once the `ObjectStore` is defined, you can configure your PostgreSQL cluster Once the `ObjectStore` is defined, you can configure your PostgreSQL cluster