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

doc: plugin parameters

Browse Source 
Add documentation for the parameters that can be set for the plugin.

Closes #327

Signed-off-by: Francesco Canovai <francesco.canovai@enterprisedb.com>
This commit is contained in:
Francesco Canovai 2025-05-08 16:15:28 +02:00 committed by Marco Nenciarini
parent 3420f43073
commit 33542e1e00
No known key found for this signature in database
GPG Key ID: 589F03F01BA55038
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
web/docs/parameters.md Normal file
View File

@ -0,0 +1,18 @@
---
sidebar_position: 100
---
# Parameters
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
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.