Skip to content

Commit d399b5e

Browse files
committed
docs: continue review
Signed-off-by: Gabriele Bartolini <[email protected]>
1 parent b218fd2 commit d399b5e

File tree

1 file changed

+31
-19
lines changed

1 file changed

+31
-19
lines changed

README.md

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -49,49 +49,61 @@ plugin, ensuring compatibility and reliability across environments.
4949

5050
## Prerequisites
5151

52-
* [CloudNativePG](https://cloudnative-pg.io) 1.25RC1 or newer
53-
* [cert-manager](https://cert-manager.io/)
52+
To use this plugin, ensure the following prerequisites are met:
53+
54+
- [**CloudNativePG**](https://cloudnative-pg.io) version **1.25** or newer.
55+
- [**cert-manager**](https://cert-manager.io/) for enabling **TLS communication** between the plugin and the operator.
5456

5557
## Installation
5658

57-
**IMPORTANT** The plugin should be installed in the same namespace where the
58-
operator is **installed**, usually `cnpg-system`.
59+
**Important Notes:**
60+
61+
1. The plugin **must** be installed in the same namespace where the operator is
62+
installed (typically `cnpg-system`).
63+
64+
2. Be aware that the operator's **listening namespaces** may differ from its
65+
installation namespace. Ensure you verify this distinction to avoid
66+
configuration issues.
5967

60-
**IMPORTANT** This may be different from the namespaces the operator is
61-
listening on.
68+
Here’s an enhanced version of your instructions for verifying the prerequisites:
6269

63-
### Step 1 - verify the prerequisites are met
70+
### Step 1 - Verify the Prerequisites
6471

65-
Supposing that CloudNativePG is installed in the default `cnpg-system`
66-
namespace, the current version can be verified with:
72+
If CloudNativePG is installed in the default `cnpg-system` namespace, verify its version using the following command:
6773

6874
```sh
69-
$ kubectl get deployment -n cnpg-system cnpg-controller-manager | grep ghcr.io/cloudnative-pg/cloudnative-pg
75+
kubectl get deployment -n cnpg-system cnpg-controller-manager \
76+
| grep ghcr.io/cloudnative-pg/cloudnative-pg
7077
```
78+
79+
Example output:
80+
7181
```output
7282
image: ghcr.io/cloudnative-pg/cloudnative-pg:1.25.0-rc1
7383
```
7484

75-
Please ensure you're using CloudNativePG 1.25-rc1 or newer.
85+
Ensure that the version displayed is **1.25** or newer.
7686

77-
The [cert-manager](https://cert-manager.io) installation can be verified by
78-
using the [cmctl](https://cert-manager.io/v1.6-docs/usage/cmctl/#installation)
79-
tool:
87+
Then, use the [cmctl](https://cert-manager.io/v1.6-docs/usage/cmctl/#installation)
88+
tool to confirm that `cert-manager` is correctly installed:
8089

8190
```sh
82-
$ cmctl check api
91+
cmctl check api
8392
```
93+
94+
Example output:
95+
8496
```output
8597
The cert-manager API is ready
8698
```
8799

100+
Both checks are necessary to proceed with the installation.
101+
88102
### Step 2 - install the barman-cloud plugin
89103

90-
The plugin can be installed via its manifest:
104+
**TODO:** temporary section - to be rewritten when manifests are available
91105

92-
<!--
93-
TODO: replace this with the latest manifest as archived in the latest commit of main
94-
-->
106+
The plugin can be installed via its manifest:
95107

96108
```sh
97109
# Download the plugin-barman-cloud codebase, including its manifest

0 commit comments

Comments
 (0)