From 6c26df750b867e1c16e5fb833e5c302a5ddfd81c Mon Sep 17 00:00:00 2001 From: danishedb Date: Mon, 24 Aug 2026 22:54:57 +0530 Subject: [PATCH] review: - 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: danishedb --- web/docs/installation.mdx | 34 ++++++++++++++----- web/src/components/HelmInstallation/index.tsx | 5 ++- .../version-0.13.0/installation.mdx | 34 ++++++++++++++----- .../version-0.14.0/installation.mdx | 30 ++++++++++++---- 4 files changed, 78 insertions(+), 25 deletions(-) diff --git a/web/docs/installation.mdx b/web/docs/installation.mdx index 51d6b159..3a6eff9f 100644 --- a/web/docs/installation.mdx +++ b/web/docs/installation.mdx @@ -54,10 +54,13 @@ Both checks are required before proceeding with the installation. ## Installing the Barman Cloud Plugin +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; import { InstallationSnippet } from '@site/src/components/Installation'; import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation'; -### Using the Helm Chart + + 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: ```output -Release "barman-cloud" does not exist. Installing it now. -NAME: barman-cloud +Release "plugin-barman-cloud" does not exist. Installing it now. +NAME: plugin-barman-cloud LAST DEPLOYED: Wed Jul 1 09:05:16 2026 NAMESPACE: cnpg-system STATUS: deployed @@ -76,7 +79,20 @@ DESCRIPTION: Install complete 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 +``` + + + Install the plugin using `kubectl` by applying the manifest for the latest release: @@ -105,13 +121,10 @@ certificate.cert-manager.io/barman-cloud-server created issuer.cert-manager.io/selfsigned-issuer created ``` ---- - Finally, check that the deployment is up and running: ```sh -kubectl rollout status deployment \ - -n cnpg-system barman-cloud +kubectl -n cnpg-system rollout status deploy/barman-cloud ``` Example output: @@ -120,6 +133,11 @@ Example output: deployment "barman-cloud" successfully rolled out ``` + + + +--- + This confirms that the plugin is deployed and ready to use. ## Testing the latest development snapshot diff --git a/web/src/components/HelmInstallation/index.tsx b/web/src/components/HelmInstallation/index.tsx index f57c519f..b105cc43 100644 --- a/web/src/components/HelmInstallation/index.tsx +++ b/web/src/components/HelmInstallation/index.tsx @@ -14,9 +14,8 @@ export function HelmInstallationSnippet({ return ( {`helm repo add cnpg https://cloudnative-pg.github.io/charts --force-update -helm upgrade --install barman-cloud \\ - --namespace cnpg-system \\ - --create-namespace \\${versionArg} +helm upgrade --install plugin-barman-cloud \\ + --namespace cnpg-system \\${versionArg} cnpg/plugin-barman-cloud`} ); diff --git a/web/versioned_docs/version-0.13.0/installation.mdx b/web/versioned_docs/version-0.13.0/installation.mdx index f01f8061..b03998ea 100644 --- a/web/versioned_docs/version-0.13.0/installation.mdx +++ b/web/versioned_docs/version-0.13.0/installation.mdx @@ -54,10 +54,13 @@ Both checks are required before proceeding with the installation. ## Installing the Barman Cloud Plugin +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; import { InstallationSnippet } from '@site/src/components/Installation'; import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation'; -### Using the Helm Chart + + 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: ```output -Release "barman-cloud" does not exist. Installing it now. -NAME: barman-cloud +Release "plugin-barman-cloud" does not exist. Installing it now. +NAME: plugin-barman-cloud LAST DEPLOYED: Wed Jul 1 09:05:16 2026 NAMESPACE: cnpg-system STATUS: deployed @@ -76,7 +79,20 @@ DESCRIPTION: Install complete 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 +``` + + + Install the plugin using `kubectl` by applying the manifest for the latest release: @@ -105,13 +121,10 @@ certificate.cert-manager.io/barman-cloud-server created issuer.cert-manager.io/selfsigned-issuer created ``` ---- - Finally, check that the deployment is up and running: ```sh -kubectl rollout status deployment \ - -n cnpg-system barman-cloud +kubectl -n cnpg-system rollout status deploy/barman-cloud ``` Example output: @@ -120,6 +133,11 @@ Example output: deployment "barman-cloud" successfully rolled out ``` + + + +--- + This confirms that the plugin is deployed and ready to use. ## Testing the latest development snapshot diff --git a/web/versioned_docs/version-0.14.0/installation.mdx b/web/versioned_docs/version-0.14.0/installation.mdx index 18bff927..fa823b47 100644 --- a/web/versioned_docs/version-0.14.0/installation.mdx +++ b/web/versioned_docs/version-0.14.0/installation.mdx @@ -54,10 +54,13 @@ Both checks are required before proceeding with the installation. ## Installing the Barman Cloud Plugin +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; import { InstallationSnippet } from '@site/src/components/Installation'; import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation'; -### Using the Helm Chart + + 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: ```output -Release "barman-cloud" does not exist. Installing it now. -NAME: barman-cloud +Release "plugin-barman-cloud" does not exist. Installing it now. +NAME: plugin-barman-cloud LAST DEPLOYED: Wed Jul 1 09:05:16 2026 NAMESPACE: cnpg-system STATUS: deployed @@ -76,7 +79,20 @@ DESCRIPTION: Install complete 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 +``` + + + Install the plugin using `kubectl` by applying the manifest for the latest release: @@ -108,8 +124,7 @@ issuer.cert-manager.io/selfsigned-issuer created Finally, check that the deployment is up and running: ```sh -kubectl rollout status deployment \ - -n cnpg-system barman-cloud +kubectl -n cnpg-system rollout status deploy/barman-cloud ``` Example output: @@ -118,6 +133,9 @@ Example output: deployment "barman-cloud" successfully rolled out ``` + + + This confirms that the plugin is deployed and ready to use. ## Testing the latest development snapshot