Skip to content

review: update doc #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kkrypt0nn merged 1 commit into from
Aug 24, 2026
Merged

review: update doc #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 26 additions & 8 deletions web/docs/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<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):

Expand All @@ -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
Expand All @@ -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
```

</TabItem>
<TabItem value="kubectl" label="Manifest (kubectl)">

Install the plugin using `kubectl` by applying the manifest for the latest
release:
Expand Down Expand Up @@ -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:
Expand All @@ -120,6 +133,11 @@ Example output:
deployment "barman-cloud" successfully rolled out
```

</TabItem>
</Tabs>

---

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

## Testing the latest development snapshot
Expand Down
5 changes: 2 additions & 3 deletions web/src/components/HelmInstallation/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,8 @@ export function HelmInstallationSnippet({
return (
<CodeBlock language="sh">
{`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`}
</CodeBlock>
);
Expand Down
34 changes: 26 additions & 8 deletions web/versioned_docs/version-0.13.0/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<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):

Expand All @@ -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
Expand All @@ -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
```

</TabItem>
<TabItem value="kubectl" label="Manifest (kubectl)">

Install the plugin using `kubectl` by applying the manifest for the latest
release:
Expand Down Expand Up @@ -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:
Expand All @@ -120,6 +133,11 @@ Example output:
deployment "barman-cloud" successfully rolled out
```

</TabItem>
</Tabs>

---

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

## Testing the latest development snapshot
Expand Down
30 changes: 24 additions & 6 deletions web/versioned_docs/version-0.14.0/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<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):

Expand All @@ -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
Expand All @@ -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
```

</TabItem>
<TabItem value="kubectl" label="Manifest (kubectl)">

Install the plugin using `kubectl` by applying the manifest for the latest
release:
Expand Down Expand Up @@ -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:
Expand All @@ -118,6 +133,9 @@ Example output:
deployment "barman-cloud" successfully rolled out
```

</TabItem>
</Tabs>

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

## Testing the latest development snapshot
Expand Down