plugin-barman-cloud/web/docs/parameters.md
Francesco Canovai 33542e1e00
doc: plugin parameters
Add documentation for the parameters that can be set for the plugin.

Closes #327

Signed-off-by: Francesco Canovai <francesco.canovai@enterprisedb.com>
2025-05-09 11:47:28 +02:00

19 lines
543 B
Markdown

---
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.