Compare commits

..

3 Commits

Author SHA1 Message Date
Krypton
39e25fa10f
Merge 5e923c9599 into 77118ed413 2026-08-24 20:37:46 +02:00
Krypton
5e923c9599
docs: add Helm chart installation
* Use built-in Docusaurus tabs for the Helm and kubectl install methods
* Rename the Helm release to plugin-barman-cloud, matching the chart's README and making the rollout verification command work
* Drop --create-namespace: the operator prerequisite guarantees the namespace exists
* Give each method its own verification step and example output

Signed-off-by: Krypton <root@krypton.ninja>
Signed-off-by: danishedb <danish.khan@enterprisedb.com>
Co-authored-by: danishedb <danish.khan@enterprisedb.com>
2026-08-24 20:37:15 +02:00
renovate[bot]
77118ed413
chore(deps): update all cloudnative-pg daggerverse dependencies to 26cd57f (#1072)
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2026-08-19 13:01:46 +02:00
5 changed files with 83 additions and 30 deletions

View File

@ -46,7 +46,7 @@ tasks:
- wordlist-ordered - wordlist-ordered
env: env:
# renovate: datasource=git-refs depName=spellcheck lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main # renovate: datasource=git-refs depName=spellcheck lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main
DAGGER_SPELLCHECK_SHA: 7174b66d283da487638a98b431b7707b311a9a32 DAGGER_SPELLCHECK_SHA: 26cd57fb6ad66e88c036b675b0478d38df93962d
cmds: cmds:
- > - >
GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/spellcheck@${DAGGER_SPELLCHECK_SHA} GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/spellcheck@${DAGGER_SPELLCHECK_SHA}
@ -60,7 +60,7 @@ tasks:
desc: Check for conventional commits desc: Check for conventional commits
env: env:
# renovate: datasource=git-refs depName=commitlint lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main # renovate: datasource=git-refs depName=commitlint lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main
DAGGER_COMMITLINT_SHA: 7174b66d283da487638a98b431b7707b311a9a32 DAGGER_COMMITLINT_SHA: 26cd57fb6ad66e88c036b675b0478d38df93962d
cmds: cmds:
- > - >
GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/commitlint@${DAGGER_COMMITLINT_SHA} GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/commitlint@${DAGGER_COMMITLINT_SHA}
@ -74,7 +74,7 @@ tasks:
- wordlist-ordered - wordlist-ordered
env: env:
# renovate: datasource=git-refs depName=uncommitted lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main # renovate: datasource=git-refs depName=uncommitted lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main
DAGGER_UNCOMMITTED_SHA: 7174b66d283da487638a98b431b7707b311a9a32 DAGGER_UNCOMMITTED_SHA: 26cd57fb6ad66e88c036b675b0478d38df93962d
cmds: cmds:
- GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/uncommitted@${DAGGER_UNCOMMITTED_SHA} check-uncommitted --source . stdout - GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/uncommitted@${DAGGER_UNCOMMITTED_SHA} check-uncommitted --source . stdout
sources: sources:
@ -86,7 +86,7 @@ tasks:
- controller-gen - controller-gen
env: env:
# renovate: datasource=git-refs depName=crd-gen-refs lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main # renovate: datasource=git-refs depName=crd-gen-refs lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main
DAGGER_CRDGENREF_SHA: 7174b66d283da487638a98b431b7707b311a9a32 DAGGER_CRDGENREF_SHA: 26cd57fb6ad66e88c036b675b0478d38df93962d
# renovate: datasource=go depName=github.com/elastic/crd-ref-docs # renovate: datasource=go depName=github.com/elastic/crd-ref-docs
CRDREFDOCS_VERSION: v0.3.0 CRDREFDOCS_VERSION: v0.3.0
cmds: cmds:
@ -383,7 +383,7 @@ tasks:
run: once run: once
env: env:
# renovate: datasource=git-refs depName=controller-gen lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main # renovate: datasource=git-refs depName=controller-gen lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main
DAGGER_CONTROLLER_GEN_SHA: 7174b66d283da487638a98b431b7707b311a9a32 DAGGER_CONTROLLER_GEN_SHA: 26cd57fb6ad66e88c036b675b0478d38df93962d
cmds: cmds:
- > - >
GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/controller-gen@${DAGGER_CONTROLLER_GEN_SHA} GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/controller-gen@${DAGGER_CONTROLLER_GEN_SHA}

View File

@ -54,10 +54,13 @@ Both checks are required before proceeding with the installation.
## Installing the Barman Cloud Plugin ## Installing the Barman Cloud Plugin
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import { InstallationSnippet } from '@site/src/components/Installation'; import { InstallationSnippet } from '@site/src/components/Installation';
import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation'; import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation';
### Using the Helm Chart <Tabs groupId="install-method">
<TabItem value="helm" label="Helm Chart" default>
The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud): The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud):
@ -66,8 +69,8 @@ The plugin can be installed using the provided [Helm chart](https://github.com/c
Example output: Example output:
```output ```output
Release "barman-cloud" does not exist. Installing it now. Release "plugin-barman-cloud" does not exist. Installing it now.
NAME: barman-cloud NAME: plugin-barman-cloud
LAST DEPLOYED: Wed Jul 1 09:05:16 2026 LAST DEPLOYED: Wed Jul 1 09:05:16 2026
NAMESPACE: cnpg-system NAMESPACE: cnpg-system
STATUS: deployed STATUS: deployed
@ -76,7 +79,20 @@ DESCRIPTION: Install complete
TEST SUITE: None TEST SUITE: None
``` ```
### Directly using the manifest Finally, check that the deployment is up and running:
```sh
kubectl -n cnpg-system rollout status deploy/plugin-barman-cloud
```
Example output:
```output
deployment "plugin-barman-cloud" successfully rolled out
```
</TabItem>
<TabItem value="kubectl" label="Manifest (kubectl)">
Install the plugin using `kubectl` by applying the manifest for the latest Install the plugin using `kubectl` by applying the manifest for the latest
release: release:
@ -105,13 +121,10 @@ certificate.cert-manager.io/barman-cloud-server created
issuer.cert-manager.io/selfsigned-issuer created issuer.cert-manager.io/selfsigned-issuer created
``` ```
---
Finally, check that the deployment is up and running: Finally, check that the deployment is up and running:
```sh ```sh
kubectl rollout status deployment \ kubectl -n cnpg-system rollout status deploy/barman-cloud
-n cnpg-system barman-cloud
``` ```
Example output: Example output:
@ -120,6 +133,11 @@ Example output:
deployment "barman-cloud" successfully rolled out deployment "barman-cloud" successfully rolled out
``` ```
</TabItem>
</Tabs>
---
This confirms that the plugin is deployed and ready to use. This confirms that the plugin is deployed and ready to use.
## Testing the latest development snapshot ## Testing the latest development snapshot

View File

@ -14,9 +14,8 @@ export function HelmInstallationSnippet({
return ( return (
<CodeBlock language="sh"> <CodeBlock language="sh">
{`helm repo add cnpg https://cloudnative-pg.github.io/charts --force-update {`helm repo add cnpg https://cloudnative-pg.github.io/charts --force-update
helm upgrade --install barman-cloud \\ helm upgrade --install plugin-barman-cloud \\
--namespace cnpg-system \\ --namespace cnpg-system \\${versionArg}
--create-namespace \\${versionArg}
cnpg/plugin-barman-cloud`} cnpg/plugin-barman-cloud`}
</CodeBlock> </CodeBlock>
); );

View File

@ -54,10 +54,13 @@ Both checks are required before proceeding with the installation.
## Installing the Barman Cloud Plugin ## Installing the Barman Cloud Plugin
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import { InstallationSnippet } from '@site/src/components/Installation'; import { InstallationSnippet } from '@site/src/components/Installation';
import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation'; import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation';
### Using the Helm Chart <Tabs groupId="install-method">
<TabItem value="helm" label="Helm Chart" default>
The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud): The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud):
@ -66,8 +69,8 @@ The plugin can be installed using the provided [Helm chart](https://github.com/c
Example output: Example output:
```output ```output
Release "barman-cloud" does not exist. Installing it now. Release "plugin-barman-cloud" does not exist. Installing it now.
NAME: barman-cloud NAME: plugin-barman-cloud
LAST DEPLOYED: Wed Jul 1 09:05:16 2026 LAST DEPLOYED: Wed Jul 1 09:05:16 2026
NAMESPACE: cnpg-system NAMESPACE: cnpg-system
STATUS: deployed STATUS: deployed
@ -76,7 +79,20 @@ DESCRIPTION: Install complete
TEST SUITE: None TEST SUITE: None
``` ```
### Directly using the manifest Finally, check that the deployment is up and running:
```sh
kubectl -n cnpg-system rollout status deploy/plugin-barman-cloud
```
Example output:
```output
deployment "plugin-barman-cloud" successfully rolled out
```
</TabItem>
<TabItem value="kubectl" label="Manifest (kubectl)">
Install the plugin using `kubectl` by applying the manifest for the latest Install the plugin using `kubectl` by applying the manifest for the latest
release: release:
@ -105,13 +121,10 @@ certificate.cert-manager.io/barman-cloud-server created
issuer.cert-manager.io/selfsigned-issuer created issuer.cert-manager.io/selfsigned-issuer created
``` ```
---
Finally, check that the deployment is up and running: Finally, check that the deployment is up and running:
```sh ```sh
kubectl rollout status deployment \ kubectl -n cnpg-system rollout status deploy/barman-cloud
-n cnpg-system barman-cloud
``` ```
Example output: Example output:
@ -120,6 +133,11 @@ Example output:
deployment "barman-cloud" successfully rolled out deployment "barman-cloud" successfully rolled out
``` ```
</TabItem>
</Tabs>
---
This confirms that the plugin is deployed and ready to use. This confirms that the plugin is deployed and ready to use.
## Testing the latest development snapshot ## Testing the latest development snapshot

View File

@ -54,10 +54,13 @@ Both checks are required before proceeding with the installation.
## Installing the Barman Cloud Plugin ## Installing the Barman Cloud Plugin
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import { InstallationSnippet } from '@site/src/components/Installation'; import { InstallationSnippet } from '@site/src/components/Installation';
import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation'; import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation';
### Using the Helm Chart <Tabs groupId="install-method">
<TabItem value="helm" label="Helm Chart" default>
The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud): The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud):
@ -66,8 +69,8 @@ The plugin can be installed using the provided [Helm chart](https://github.com/c
Example output: Example output:
```output ```output
Release "barman-cloud" does not exist. Installing it now. Release "plugin-barman-cloud" does not exist. Installing it now.
NAME: barman-cloud NAME: plugin-barman-cloud
LAST DEPLOYED: Wed Jul 1 09:05:16 2026 LAST DEPLOYED: Wed Jul 1 09:05:16 2026
NAMESPACE: cnpg-system NAMESPACE: cnpg-system
STATUS: deployed STATUS: deployed
@ -76,7 +79,20 @@ DESCRIPTION: Install complete
TEST SUITE: None TEST SUITE: None
``` ```
### Directly using the manifest Finally, check that the deployment is up and running:
```sh
kubectl -n cnpg-system rollout status deploy/plugin-barman-cloud
```
Example output:
```output
deployment "plugin-barman-cloud" successfully rolled out
```
</TabItem>
<TabItem value="kubectl" label="Manifest (kubectl)">
Install the plugin using `kubectl` by applying the manifest for the latest Install the plugin using `kubectl` by applying the manifest for the latest
release: release:
@ -108,8 +124,7 @@ issuer.cert-manager.io/selfsigned-issuer created
Finally, check that the deployment is up and running: Finally, check that the deployment is up and running:
```sh ```sh
kubectl rollout status deployment \ kubectl -n cnpg-system rollout status deploy/barman-cloud
-n cnpg-system barman-cloud
``` ```
Example output: Example output:
@ -118,6 +133,9 @@ Example output:
deployment "barman-cloud" successfully rolled out deployment "barman-cloud" successfully rolled out
``` ```
</TabItem>
</Tabs>
This confirms that the plugin is deployed and ready to use. This confirms that the plugin is deployed and ready to use.
## Testing the latest development snapshot ## Testing the latest development snapshot