Skip to content

Commit d7e335f

Browse files
committed
fix: admonition termination, add notice in usage
Signed-off-by: Marco Nenciarini <[email protected]>
1 parent 33542e1 commit d7e335f

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

web/docs/parameters.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The following parameters are available for the Barman Cloud Plugin:
1313
- `serverName`: Specifies the server name in the object store.
1414

1515
:::important
16-
The `serverName` parameter within the `ObjectStore` resource exists only for
17-
API compatibility with the in-tree `barmanObjectStore` and is ignored by the
18-
plugin. Use the `serverName` plugin parameter when needed.
16+
The `serverName` parameter in the `ObjectStore` resource is retained solely for
17+
API compatibility with the in-tree `barmanObjectStore` and must always be left empty.
18+
When needed, use the `serverName` plugin parameter in the Cluster configuration instead.
19+
:::

web/docs/usage.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ The `.spec.configuration` schema follows the same format as the
4949
Refer to [the CloudNativePG documentation](https://cloudnative-pg.io/documentation/preview/backup_barmanobjectstore/)
5050
for additional details.
5151

52+
:::important
53+
The `serverName` parameter in the `ObjectStore` resource is retained solely for
54+
API compatibility with the in-tree `barmanObjectStore` and must always be left empty.
55+
When needed, use the `serverName` plugin parameter in the Cluster configuration instead.
56+
:::
57+
5258
## Configuring WAL Archiving
5359

5460
Once the `ObjectStore` is defined, you can configure your PostgreSQL cluster

0 commit comments

Comments
 (0)