diff --git a/web/docs/installation.mdx b/web/docs/installation.mdx index 027d1e8f..3a6eff9f 100644 --- a/web/docs/installation.mdx +++ b/web/docs/installation.mdx @@ -54,7 +54,45 @@ 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'; + + + + +The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud): + + + +Example output: + +```output +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 +REVISION: 1 +DESCRIPTION: Install complete +TEST SUITE: None +``` + +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: @@ -86,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: @@ -96,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/docs/troubleshooting.md b/web/docs/troubleshooting.md index fe57262f..c57a81ec 100644 --- a/web/docs/troubleshooting.md +++ b/web/docs/troubleshooting.md @@ -485,14 +485,10 @@ If problems persist: ### Plugin Limitations -1. **Installation method**: Currently only supports manifest and Kustomize - installation ([#351](https://github.com/cloudnative-pg/plugin-barman-cloud/issues/351) - - Helm chart requested) - -2. **Sidecar resource sharing**: The plugin sidecar container shares pod +1. **Sidecar resource sharing**: The plugin sidecar container shares pod resources with PostgreSQL -3. **Plugin restart behavior**: Restarting the sidecar container requires +2. **Plugin restart behavior**: Restarting the sidecar container requires restarting the entire PostgreSQL pod ## Recap of General Debugging Steps @@ -588,4 +584,3 @@ kubectl get secret -n -o jsonpath='{.data}' | jq 'keys * **"NoSuchBucket"** — Verify the bucket exists and the endpoint URL is correct. * **"Connection timeout"** — Check network connectivity and firewall rules. * **"SSL certificate problem"** — For self-signed certificates, verify the CA bundle configuration. - diff --git a/web/src/components/HelmInstallation/index.tsx b/web/src/components/HelmInstallation/index.tsx new file mode 100644 index 00000000..b105cc43 --- /dev/null +++ b/web/src/components/HelmInstallation/index.tsx @@ -0,0 +1,22 @@ +import { ReactElement } from "react"; +import CodeBlock from "@theme/CodeBlock"; + +type HelmInstallationProps = { + chartVersion?: string; +}; + +// HelmInstallationSnippet is the Helm incantation to install a specific +// or latest available version of the Barman Cloud Plugin. +export function HelmInstallationSnippet({ + chartVersion, +}: HelmInstallationProps): ReactElement { + const versionArg = chartVersion ? `\n --version ${chartVersion} \\` : ""; + return ( + + {`helm repo add cnpg https://cloudnative-pg.github.io/charts --force-update +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 027d1e8f..b03998ea 100644 --- a/web/versioned_docs/version-0.13.0/installation.mdx +++ b/web/versioned_docs/version-0.13.0/installation.mdx @@ -54,7 +54,45 @@ 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'; + + + + +The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud): + + + +Example output: + +```output +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 +REVISION: 1 +DESCRIPTION: Install complete +TEST SUITE: None +``` + +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: @@ -86,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: @@ -96,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.13.0/troubleshooting.md b/web/versioned_docs/version-0.13.0/troubleshooting.md index fe57262f..c57a81ec 100644 --- a/web/versioned_docs/version-0.13.0/troubleshooting.md +++ b/web/versioned_docs/version-0.13.0/troubleshooting.md @@ -485,14 +485,10 @@ If problems persist: ### Plugin Limitations -1. **Installation method**: Currently only supports manifest and Kustomize - installation ([#351](https://github.com/cloudnative-pg/plugin-barman-cloud/issues/351) - - Helm chart requested) - -2. **Sidecar resource sharing**: The plugin sidecar container shares pod +1. **Sidecar resource sharing**: The plugin sidecar container shares pod resources with PostgreSQL -3. **Plugin restart behavior**: Restarting the sidecar container requires +2. **Plugin restart behavior**: Restarting the sidecar container requires restarting the entire PostgreSQL pod ## Recap of General Debugging Steps @@ -588,4 +584,3 @@ kubectl get secret -n -o jsonpath='{.data}' | jq 'keys * **"NoSuchBucket"** — Verify the bucket exists and the endpoint URL is correct. * **"Connection timeout"** — Check network connectivity and firewall rules. * **"SSL certificate problem"** — For self-signed certificates, verify the CA bundle configuration. - diff --git a/web/versioned_docs/version-0.14.0/installation.mdx b/web/versioned_docs/version-0.14.0/installation.mdx index 027d1e8f..fa823b47 100644 --- a/web/versioned_docs/version-0.14.0/installation.mdx +++ b/web/versioned_docs/version-0.14.0/installation.mdx @@ -54,7 +54,45 @@ 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'; + + + + +The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud): + + + +Example output: + +```output +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 +REVISION: 1 +DESCRIPTION: Install complete +TEST SUITE: None +``` + +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: @@ -86,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: @@ -96,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 diff --git a/web/versioned_docs/version-0.14.0/troubleshooting.md b/web/versioned_docs/version-0.14.0/troubleshooting.md index fe57262f..c57a81ec 100644 --- a/web/versioned_docs/version-0.14.0/troubleshooting.md +++ b/web/versioned_docs/version-0.14.0/troubleshooting.md @@ -485,14 +485,10 @@ If problems persist: ### Plugin Limitations -1. **Installation method**: Currently only supports manifest and Kustomize - installation ([#351](https://github.com/cloudnative-pg/plugin-barman-cloud/issues/351) - - Helm chart requested) - -2. **Sidecar resource sharing**: The plugin sidecar container shares pod +1. **Sidecar resource sharing**: The plugin sidecar container shares pod resources with PostgreSQL -3. **Plugin restart behavior**: Restarting the sidecar container requires +2. **Plugin restart behavior**: Restarting the sidecar container requires restarting the entire PostgreSQL pod ## Recap of General Debugging Steps @@ -588,4 +584,3 @@ kubectl get secret -n -o jsonpath='{.data}' | jq 'keys * **"NoSuchBucket"** — Verify the bucket exists and the endpoint URL is correct. * **"Connection timeout"** — Check network connectivity and firewall rules. * **"SSL certificate problem"** — For self-signed certificates, verify the CA bundle configuration. -