mirror of
https://github.com/cloudnative-pg/plugin-barman-cloud.git
synced 2026-09-04 22:22:21 +02:00
Merge 62b35326e4 into f459a30472
This commit is contained in:
commit
8a6d3004b8
@ -54,7 +54,45 @@ 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, ManifestVersion } from '@site/src/components/Installation';
|
import { InstallationSnippet, ManifestVersion } from '@site/src/components/Installation';
|
||||||
|
import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation';
|
||||||
|
|
||||||
|
<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):
|
||||||
|
|
||||||
|
<HelmInstallationSnippet />
|
||||||
|
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="kubectl" label="Manifest (kubectl)">
|
||||||
|
|
||||||
Install the plugin using `kubectl` by applying the manifest for <ManifestVersion />:
|
Install the plugin using `kubectl` by applying the manifest for <ManifestVersion />:
|
||||||
|
|
||||||
@ -85,8 +123,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:
|
||||||
@ -95,6 +132,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
|
||||||
|
|||||||
@ -485,14 +485,10 @@ If problems persist:
|
|||||||
|
|
||||||
### Plugin Limitations
|
### Plugin Limitations
|
||||||
|
|
||||||
1. **Installation method**: Currently only supports manifest and Kustomize
|
1. **Sidecar resource sharing**: The plugin sidecar container shares pod
|
||||||
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
|
|
||||||
resources with PostgreSQL
|
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
|
restarting the entire PostgreSQL pod
|
||||||
|
|
||||||
## Recap of General Debugging Steps
|
## Recap of General Debugging Steps
|
||||||
@ -588,4 +584,3 @@ kubectl get secret -n <namespace> <secret-name> -o jsonpath='{.data}' | jq 'keys
|
|||||||
* **"NoSuchBucket"** — Verify the bucket exists and the endpoint URL is correct.
|
* **"NoSuchBucket"** — Verify the bucket exists and the endpoint URL is correct.
|
||||||
* **"Connection timeout"** — Check network connectivity and firewall rules.
|
* **"Connection timeout"** — Check network connectivity and firewall rules.
|
||||||
* **"SSL certificate problem"** — For self-signed certificates, verify the CA bundle configuration.
|
* **"SSL certificate problem"** — For self-signed certificates, verify the CA bundle configuration.
|
||||||
|
|
||||||
|
|||||||
22
web/src/components/HelmInstallation/index.tsx
Normal file
22
web/src/components/HelmInstallation/index.tsx
Normal file
@ -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<null> {
|
||||||
|
const versionArg = chartVersion ? `\n --version ${chartVersion} \\` : "";
|
||||||
|
return (
|
||||||
|
<CodeBlock language="sh">
|
||||||
|
{`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`}
|
||||||
|
</CodeBlock>
|
||||||
|
);
|
||||||
|
}
|
||||||
@ -54,7 +54,45 @@ 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, ManifestVersion } from '@site/src/components/Installation';
|
import { InstallationSnippet, ManifestVersion } from '@site/src/components/Installation';
|
||||||
|
import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation';
|
||||||
|
|
||||||
|
<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):
|
||||||
|
|
||||||
|
<HelmInstallationSnippet chartVersion="0.7.0" />
|
||||||
|
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="kubectl" label="Manifest (kubectl)">
|
||||||
|
|
||||||
Install the plugin using `kubectl` by applying the manifest for <ManifestVersion />:
|
Install the plugin using `kubectl` by applying the manifest for <ManifestVersion />:
|
||||||
|
|
||||||
@ -85,8 +123,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:
|
||||||
@ -95,6 +132,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
|
||||||
|
|||||||
@ -485,14 +485,10 @@ If problems persist:
|
|||||||
|
|
||||||
### Plugin Limitations
|
### Plugin Limitations
|
||||||
|
|
||||||
1. **Installation method**: Currently only supports manifest and Kustomize
|
1. **Sidecar resource sharing**: The plugin sidecar container shares pod
|
||||||
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
|
|
||||||
resources with PostgreSQL
|
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
|
restarting the entire PostgreSQL pod
|
||||||
|
|
||||||
## Recap of General Debugging Steps
|
## Recap of General Debugging Steps
|
||||||
@ -588,4 +584,3 @@ kubectl get secret -n <namespace> <secret-name> -o jsonpath='{.data}' | jq 'keys
|
|||||||
* **"NoSuchBucket"** — Verify the bucket exists and the endpoint URL is correct.
|
* **"NoSuchBucket"** — Verify the bucket exists and the endpoint URL is correct.
|
||||||
* **"Connection timeout"** — Check network connectivity and firewall rules.
|
* **"Connection timeout"** — Check network connectivity and firewall rules.
|
||||||
* **"SSL certificate problem"** — For self-signed certificates, verify the CA bundle configuration.
|
* **"SSL certificate problem"** — For self-signed certificates, verify the CA bundle configuration.
|
||||||
|
|
||||||
|
|||||||
@ -54,7 +54,45 @@ 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, ManifestVersion } from '@site/src/components/Installation';
|
import { InstallationSnippet, ManifestVersion } from '@site/src/components/Installation';
|
||||||
|
import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation';
|
||||||
|
|
||||||
|
<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):
|
||||||
|
|
||||||
|
<HelmInstallationSnippet chartVersion="0.7.1" />
|
||||||
|
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="kubectl" label="Manifest (kubectl)">
|
||||||
|
|
||||||
Install the plugin using `kubectl` by applying the manifest for <ManifestVersion />:
|
Install the plugin using `kubectl` by applying the manifest for <ManifestVersion />:
|
||||||
|
|
||||||
@ -85,8 +123,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:
|
||||||
@ -95,6 +132,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
|
||||||
|
|||||||
@ -485,14 +485,10 @@ If problems persist:
|
|||||||
|
|
||||||
### Plugin Limitations
|
### Plugin Limitations
|
||||||
|
|
||||||
1. **Installation method**: Currently only supports manifest and Kustomize
|
1. **Sidecar resource sharing**: The plugin sidecar container shares pod
|
||||||
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
|
|
||||||
resources with PostgreSQL
|
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
|
restarting the entire PostgreSQL pod
|
||||||
|
|
||||||
## Recap of General Debugging Steps
|
## Recap of General Debugging Steps
|
||||||
@ -588,4 +584,3 @@ kubectl get secret -n <namespace> <secret-name> -o jsonpath='{.data}' | jq 'keys
|
|||||||
* **"NoSuchBucket"** — Verify the bucket exists and the endpoint URL is correct.
|
* **"NoSuchBucket"** — Verify the bucket exists and the endpoint URL is correct.
|
||||||
* **"Connection timeout"** — Check network connectivity and firewall rules.
|
* **"Connection timeout"** — Check network connectivity and firewall rules.
|
||||||
* **"SSL certificate problem"** — For self-signed certificates, verify the CA bundle configuration.
|
* **"SSL certificate problem"** — For self-signed certificates, verify the CA bundle configuration.
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user