Skip to content

Commit e809896

Browse files
committed
docs: add Helm chart installation
Signed-off-by: Krypton <root@krypton.ninja>
1 parent e694dd8 commit e809896

13 files changed

Lines changed: 116 additions & 42 deletions

File tree

web/docs/installation.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ Both checks are required before proceeding with the installation.
5656

5757
import { InstallationSnippet } from '@site/src/components/Installation';
5858

59+
### Directly using the manifest
60+
5961
Install the plugin using `kubectl` by applying the manifest for the latest
6062
release:
6163

@@ -98,6 +100,18 @@ deployment "barman-cloud" successfully rolled out
98100

99101
This confirms that the plugin is deployed and ready to use.
100102

103+
### Using the Helm Chart
104+
105+
The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud):
106+
107+
```sh
108+
helm repo add cnpg https://cloudnative-pg.github.io/charts
109+
helm upgrade --install barman-cloud \
110+
--namespace cnpg-system \
111+
--create-namespace \
112+
cnpg/plugin-barman-cloud
113+
```
114+
101115
## Testing the latest development snapshot
102116

103117
You can also test the latest development snapshot of the plugin with the

web/docs/troubleshooting.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -485,14 +485,10 @@ If problems persist:
485485

486486
### Plugin Limitations
487487

488-
1. **Installation method**: Currently only supports manifest and Kustomize
489-
installation ([#351](https://github.com/cloudnative-pg/plugin-barman-cloud/issues/351) -
490-
Helm chart requested)
491-
492-
2. **Sidecar resource sharing**: The plugin sidecar container shares pod
488+
1. **Sidecar resource sharing**: The plugin sidecar container shares pod
493489
resources with PostgreSQL
494490

495-
3. **Plugin restart behavior**: Restarting the sidecar container requires
491+
2. **Plugin restart behavior**: Restarting the sidecar container requires
496492
restarting the entire PostgreSQL pod
497493

498494
## Recap of General Debugging Steps
@@ -588,4 +584,3 @@ kubectl get secret -n <namespace> <secret-name> -o jsonpath='{.data}' | jq 'keys
588584
* **"NoSuchBucket"** — Verify the bucket exists and the endpoint URL is correct.
589585
* **"Connection timeout"** — Check network connectivity and firewall rules.
590586
* **"SSL certificate problem"** — For self-signed certificates, verify the CA bundle configuration.
591-

web/versioned_docs/version-0.10.0/installation.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ Both checks are required before proceeding with the installation.
5656

5757
import { InstallationSnippet } from '@site/src/components/Installation';
5858

59+
### Directly using the manifest
60+
5961
Install the plugin using `kubectl` by applying the manifest for the latest
6062
release:
6163

@@ -98,6 +100,19 @@ deployment "barman-cloud" successfully rolled out
98100

99101
This confirms that the plugin is deployed and ready to use.
100102

103+
### Using the Helm Chart
104+
105+
The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud):
106+
107+
```sh
108+
helm repo add cnpg https://cloudnative-pg.github.io/charts
109+
helm upgrade --install barman-cloud \
110+
--namespace cnpg-system \
111+
--create-namespace \
112+
--version 0.4.0 \
113+
cnpg/plugin-barman-cloud
114+
```
115+
101116
## Testing the latest development snapshot
102117

103118
You can also test the latest development snapshot of the plugin with the

web/versioned_docs/version-0.10.0/troubleshooting.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -485,14 +485,10 @@ If problems persist:
485485

486486
### Plugin Limitations
487487

488-
1. **Installation method**: Currently only supports manifest and Kustomize
489-
installation ([#351](https://github.com/cloudnative-pg/plugin-barman-cloud/issues/351) -
490-
Helm chart requested)
491-
492-
2. **Sidecar resource sharing**: The plugin sidecar container shares pod
488+
1. **Sidecar resource sharing**: The plugin sidecar container shares pod
493489
resources with PostgreSQL
494490

495-
3. **Plugin restart behavior**: Restarting the sidecar container requires
491+
2. **Plugin restart behavior**: Restarting the sidecar container requires
496492
restarting the entire PostgreSQL pod
497493

498494
## Recap of General Debugging Steps
@@ -588,4 +584,3 @@ kubectl get secret -n <namespace> <secret-name> -o jsonpath='{.data}' | jq 'keys
588584
* **"NoSuchBucket"** — Verify the bucket exists and the endpoint URL is correct.
589585
* **"Connection timeout"** — Check network connectivity and firewall rules.
590586
* **"SSL certificate problem"** — For self-signed certificates, verify the CA bundle configuration.
591-

web/versioned_docs/version-0.11.0/installation.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ Both checks are required before proceeding with the installation.
5656

5757
import { InstallationSnippet } from '@site/src/components/Installation';
5858

59+
### Directly using the manifest
60+
5961
Install the plugin using `kubectl` by applying the manifest for the latest
6062
release:
6163

@@ -98,6 +100,19 @@ deployment "barman-cloud" successfully rolled out
98100

99101
This confirms that the plugin is deployed and ready to use.
100102

103+
### Using the Helm Chart
104+
105+
The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud):
106+
107+
```sh
108+
helm repo add cnpg https://cloudnative-pg.github.io/charts
109+
helm upgrade --install barman-cloud \
110+
--namespace cnpg-system \
111+
--create-namespace \
112+
--version 0.5.0 \
113+
cnpg/plugin-barman-cloud
114+
```
115+
101116
## Testing the latest development snapshot
102117

103118
You can also test the latest development snapshot of the plugin with the

web/versioned_docs/version-0.11.0/troubleshooting.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -485,14 +485,10 @@ If problems persist:
485485

486486
### Plugin Limitations
487487

488-
1. **Installation method**: Currently only supports manifest and Kustomize
489-
installation ([#351](https://github.com/cloudnative-pg/plugin-barman-cloud/issues/351) -
490-
Helm chart requested)
491-
492-
2. **Sidecar resource sharing**: The plugin sidecar container shares pod
488+
1. **Sidecar resource sharing**: The plugin sidecar container shares pod
493489
resources with PostgreSQL
494490

495-
3. **Plugin restart behavior**: Restarting the sidecar container requires
491+
2. **Plugin restart behavior**: Restarting the sidecar container requires
496492
restarting the entire PostgreSQL pod
497493

498494
## Recap of General Debugging Steps
@@ -588,4 +584,3 @@ kubectl get secret -n <namespace> <secret-name> -o jsonpath='{.data}' | jq 'keys
588584
* **"NoSuchBucket"** — Verify the bucket exists and the endpoint URL is correct.
589585
* **"Connection timeout"** — Check network connectivity and firewall rules.
590586
* **"SSL certificate problem"** — For self-signed certificates, verify the CA bundle configuration.
591-

web/versioned_docs/version-0.12.0/installation.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ Both checks are required before proceeding with the installation.
5656

5757
import { InstallationSnippet } from '@site/src/components/Installation';
5858

59+
### Directly using the manifest
60+
5961
Install the plugin using `kubectl` by applying the manifest for the latest
6062
release:
6163

@@ -98,6 +100,19 @@ deployment "barman-cloud" successfully rolled out
98100

99101
This confirms that the plugin is deployed and ready to use.
100102

103+
### Using the Helm Chart
104+
105+
The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud):
106+
107+
```sh
108+
helm repo add cnpg https://cloudnative-pg.github.io/charts
109+
helm upgrade --install barman-cloud \
110+
--namespace cnpg-system \
111+
--create-namespace \
112+
--version 0.6.0 \
113+
cnpg/plugin-barman-cloud
114+
```
115+
101116
## Testing the latest development snapshot
102117

103118
You can also test the latest development snapshot of the plugin with the

web/versioned_docs/version-0.12.0/troubleshooting.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -485,14 +485,10 @@ If problems persist:
485485

486486
### Plugin Limitations
487487

488-
1. **Installation method**: Currently only supports manifest and Kustomize
489-
installation ([#351](https://github.com/cloudnative-pg/plugin-barman-cloud/issues/351) -
490-
Helm chart requested)
491-
492-
2. **Sidecar resource sharing**: The plugin sidecar container shares pod
488+
1. **Sidecar resource sharing**: The plugin sidecar container shares pod
493489
resources with PostgreSQL
494490

495-
3. **Plugin restart behavior**: Restarting the sidecar container requires
491+
2. **Plugin restart behavior**: Restarting the sidecar container requires
496492
restarting the entire PostgreSQL pod
497493

498494
## Recap of General Debugging Steps
@@ -588,4 +584,3 @@ kubectl get secret -n <namespace> <secret-name> -o jsonpath='{.data}' | jq 'keys
588584
* **"NoSuchBucket"** — Verify the bucket exists and the endpoint URL is correct.
589585
* **"Connection timeout"** — Check network connectivity and firewall rules.
590586
* **"SSL certificate problem"** — For self-signed certificates, verify the CA bundle configuration.
591-

web/versioned_docs/version-0.5.0/installation.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ Both checks are required before proceeding with the installation.
5656

5757
import { InstallationSnippet } from '@site/src/components/Installation';
5858

59+
### Directly using the manifest
60+
5961
Install the plugin using `kubectl` by applying the manifest for the latest
6062
release:
6163

@@ -98,6 +100,19 @@ deployment "barman-cloud" successfully rolled out
98100

99101
This confirms that the plugin is deployed and ready to use.
100102

103+
### Using the Helm Chart
104+
105+
The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud):
106+
107+
```sh
108+
helm repo add cnpg https://cloudnative-pg.github.io/charts
109+
helm upgrade --install barman-cloud \
110+
--namespace cnpg-system \
111+
--create-namespace \
112+
--version 0.1.0 \
113+
cnpg/plugin-barman-cloud
114+
```
115+
101116
## Testing the latest development snapshot
102117

103118
You can also test the latest development snapshot of the plugin with the

web/versioned_docs/version-0.7.0/installation.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ Both checks are required before proceeding with the installation.
5656

5757
import { InstallationSnippet } from '@site/src/components/Installation';
5858

59+
### Directly using the manifest
60+
5961
Install the plugin using `kubectl` by applying the manifest for the latest
6062
release:
6163

@@ -98,6 +100,19 @@ deployment "barman-cloud" successfully rolled out
98100

99101
This confirms that the plugin is deployed and ready to use.
100102

103+
### Using the Helm Chart
104+
105+
The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud):
106+
107+
```sh
108+
helm repo add cnpg https://cloudnative-pg.github.io/charts
109+
helm upgrade --install barman-cloud \
110+
--namespace cnpg-system \
111+
--create-namespace \
112+
--version 0.2.0 \
113+
cnpg/plugin-barman-cloud
114+
```
115+
101116
## Testing the latest development snapshot
102117

103118
You can also test the latest development snapshot of the plugin with the

0 commit comments

Comments
 (0)