From 92e481264937f21b85a442758ca2e7f47fa46a40 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niccol=C3=B2=20Fei?= Date: Wed, 11 Nov 2026 14:20:43 +0100 Subject: [PATCH 1/3] docs(installation): document OperatorHub (OLM) installation method MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add an "OperatorHub (OLM)" tab to the installation page covering: - installing the plugin via an OLM Subscription, in the same namespace as the CloudNativePG operator - manually creating the barman-cloud-server-tls and barman-cloud-client-tls secrets, since OLM bundles cannot ship cert-manager resources - an example cert-manager Issuer and Certificates to generate them Signed-off-by: Niccolò Fei --- web/docs/installation.mdx | 108 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 108 insertions(+) diff --git a/web/docs/installation.mdx b/web/docs/installation.mdx index 7649166b..83226676 100644 --- a/web/docs/installation.mdx +++ b/web/docs/installation.mdx @@ -130,6 +130,114 @@ kubectl -n cnpg-system rollout status deploy/barman-cloud Example output: +```output +deployment "barman-cloud" successfully rolled out +``` + + + + +The plugin is published on [OperatorHub](https://operatorhub.io/operator/plugin-barman-cloud) +and can be installed with the [Operator Lifecycle Manager](https://olm.operatorframework.io/) +(OLM), either from the OpenShift web console or by creating a `Subscription`. + +:::important +Install the plugin in the **same namespace as the CloudNativePG operator**. +If CloudNativePG was also installed through OLM, use the namespace of its +`Subscription` (for example `operators`). +::: + +Create a `Subscription` for the plugin. +The example below uses the `operatorhubio-catalog` +catalog source shipped with upstream OLM: + +```yaml +apiVersion: operators.coreos.com/v1alpha1 +kind: Subscription +metadata: + name: plugin-barman-cloud + namespace: +spec: + name: plugin-barman-cloud + source: operatorhubio-catalog + sourceNamespace: olm +``` + +Wait for the `ClusterServiceVersion` to reach the `Succeeded` phase: + +```sh +kubectl -n get csv +``` + +### Creating the TLS certificates + +An OLM bundle cannot contain cert-manager resources, so, unlike the other +installation methods, **the plugin's TLS secrets are not created for you**. +The plugin pod starts without them, but CloudNativePG cannot register the plugin, +and clusters that use it report an unknown plugin, until both secrets exist in +the plugin's namespace: + +- `barman-cloud-server-tls` +- `barman-cloud-client-tls` + +If cert-manager is installed, create them with the following resources: + +```yaml +apiVersion: cert-manager.io/v1 +kind: Issuer +metadata: + name: selfsigned-issuer +spec: + selfSigned: {} +--- +apiVersion: cert-manager.io/v1 +kind: Certificate +metadata: + name: barman-cloud-server +spec: + secretName: barman-cloud-server-tls + commonName: barman-cloud + dnsNames: + - barman-cloud + usages: + - server auth + issuerRef: + name: selfsigned-issuer + kind: Issuer + group: cert-manager.io +--- +apiVersion: cert-manager.io/v1 +kind: Certificate +metadata: + name: barman-cloud-client +spec: + secretName: barman-cloud-client-tls + commonName: barman-cloud-client + usages: + - client auth + issuerRef: + name: selfsigned-issuer + kind: Issuer + group: cert-manager.io +``` + +```sh +kubectl apply -n -f certificates.yaml +``` + +The plugin loads the certificates on every TLS handshake, so it starts serving +as soon as the secrets exist, without a restart. You can also provide the +secrets by other means, as long as they have the same names and contain the +`tls.crt` and `tls.key` keys. + +Finally, check that the deployment is up and running: + +```sh +kubectl -n rollout status deploy/barman-cloud +``` + +Example output: + ```output deployment "barman-cloud" successfully rolled out ``` From 9763292f2c89896ef0085ab8a97d9b93b00a101a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niccol=C3=B2=20Fei?= Date: Wed, 11 Nov 2026 17:29:07 +0100 Subject: [PATCH 2/3] docs: apply Gabriele's review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Gabriele Quaresima Signed-off-by: Niccolò Fei --- web/docs/installation.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/web/docs/installation.mdx b/web/docs/installation.mdx index 83226676..cefcf41c 100644 --- a/web/docs/installation.mdx +++ b/web/docs/installation.mdx @@ -142,8 +142,8 @@ and can be installed with the [Operator Lifecycle Manager](https://olm.operatorf (OLM), either from the OpenShift web console or by creating a `Subscription`. :::important -Install the plugin in the **same namespace as the CloudNativePG operator**. -If CloudNativePG was also installed through OLM, use the namespace of its +Install the plugin in the **same namespace as the CloudNativePG operator**. +As CloudNativePG was also installed through OLM, use the namespace of its `Subscription` (for example `operators`). ::: @@ -172,7 +172,7 @@ kubectl -n get csv ### Creating the TLS certificates An OLM bundle cannot contain cert-manager resources, so, unlike the other -installation methods, **the plugin's TLS secrets are not created for you**. +installation methods, **the plugin's TLS secrets are not created for you**. The plugin pod starts without them, but CloudNativePG cannot register the plugin, and clusters that use it report an unknown plugin, until both secrets exist in the plugin's namespace: From 2ebf500e176addde9ffebd0d2f625e6c4796066e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niccol=C3=B2=20Fei?= Date: Tue, 17 Nov 2026 15:21:32 +0100 Subject: [PATCH 3/3] fix: improve CNPG olm dependency MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Depend directly on GVK properties instead of a specific operator name, and let OLM resolve the dependency dinamically. Update the DOC accordingly. Signed-off-by: Niccolò Fei --- config/olm/metadata/dependencies.yaml | 12 +++++++++--- web/docs/installation.mdx | 18 ++++++++++++++---- 2 files changed, 23 insertions(+), 7 deletions(-) diff --git a/config/olm/metadata/dependencies.yaml b/config/olm/metadata/dependencies.yaml index 355bc12a..66484415 100644 --- a/config/olm/metadata/dependencies.yaml +++ b/config/olm/metadata/dependencies.yaml @@ -1,5 +1,11 @@ dependencies: -- type: olm.package +- type: olm.gvk value: - packageName: cloudnative-pg - version: ">=1.30.0" + group: postgresql.cnpg.io + kind: Cluster + version: v1 +- type: olm.gvk + value: + group: postgresql.cnpg.io + kind: Backup + version: v1 diff --git a/web/docs/installation.mdx b/web/docs/installation.mdx index cefcf41c..6389ed32 100644 --- a/web/docs/installation.mdx +++ b/web/docs/installation.mdx @@ -139,12 +139,22 @@ deployment "barman-cloud" successfully rolled out The plugin is published on [OperatorHub](https://operatorhub.io/operator/plugin-barman-cloud) and can be installed with the [Operator Lifecycle Manager](https://olm.operatorframework.io/) -(OLM), either from the OpenShift web console or by creating a `Subscription`. +(OLM) by creating a `Subscription`. :::important -Install the plugin in the **same namespace as the CloudNativePG operator**. -As CloudNativePG was also installed through OLM, use the namespace of its -`Subscription` (for example `operators`). +This installation method **requires CloudNativePG to be installed through OLM +as well**. The plugin depends on the CloudNativePG APIs (the `Cluster` and +`Backup` resources of the `postgresql.cnpg.io` group), so OLM looks for an +operator it manages that provides them. If CloudNativePG was installed in any +other way (for example with the manifest or the Helm chart), OLM does not +detect it and **installs a second CloudNativePG operator** to satisfy the +dependency, which conflicts with the existing one. + +If your CloudNativePG operator is not managed by OLM, use one of the other +installation methods instead. + +Install the plugin in the **same namespace as the CloudNativePG operator**, +that is, the namespace of its OLM `Subscription` (for example `operators`). ::: Create a `Subscription` for the plugin.