mirror of
https://github.com/cloudnative-pg/plugin-barman-cloud.git
synced 2026-01-11 21:23:12 +01:00
Add documentation for the parameters that can be set for the plugin. Closes #327 Signed-off-by: Francesco Canovai <francesco.canovai@enterprisedb.com>
19 lines
543 B
Markdown
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.
|