From 134b514a56133ad6be7d556b3b39f3a0a77b53a6 Mon Sep 17 00:00:00 2001 From: Gabriele Bartolini Date: Fri, 12 Sep 2025 14:25:15 +0200 Subject: [PATCH] docs: review of intro page Signed-off-by: Gabriele Bartolini --- web/docs/intro.md | 32 +++++++++++++++++++++++--------- 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/web/docs/intro.md b/web/docs/intro.md index 39aa639..9781d0d 100644 --- a/web/docs/intro.md +++ b/web/docs/intro.md @@ -21,16 +21,30 @@ for detailed instructions. ## Requirements -To use the Barman Cloud Plugin, you need: +Before using the Barman Cloud Plugin, ensure that the following components are +installed and properly configured: -- [CloudNativePG](https://cloudnative-pg.io) version **1.26** or later - - **Version 1.27.0 or later is strongly recommended** for enhanced plugin error and status reporting - - See the [upgrade guide](https://cloudnative-pg.io/documentation/current/installation_upgrade) if you need to upgrade -- [cert-manager](https://cert-manager.io/) to enable TLS communication between - the plugin and the operator -- [kubectl-cnpg plugin](https://cloudnative-pg.io/documentation/current/kubectl-plugin/) (recommended) - - Provides enhanced debugging and status checking capabilities - - Install via `kubectl krew install cnpg` or download from [releases](https://github.com/cloudnative-pg/cloudnative-pg/releases) +- [CloudNativePG](https://cloudnative-pg.io) version 1.26 or later + + - We strongly recommend version 1.27.0 or later, which includes improved + error handling and status reporting for the plugin. + - If you are running an earlier release, refer to the + [upgrade guide](https://cloudnative-pg.io/documentation/current/installation_upgrade). + +- [cert-manager](https://cert-manager.io/) + + - The recommended way to enable secure TLS communication between the plugin + and the operator. + - Alternatively, you can provide your own certificate bundles. See the + [CloudNativePG documentation on TLS configuration](https://cloudnative-pg.io/documentation/current/cnpg_i/#configuring-tls-certificates). + +- [`kubectl-cnpg`](https://cloudnative-pg.io/documentation/current/kubectl-plugin/) + plugin (optional but recommended) + + - Simplifies debugging and monitoring with additional status and inspection + commands. + - Multiple installation options are available in the + [installation guide](https://cloudnative-pg.io/documentation/current/kubectl-plugin/#install). ## Key Features