mirror of
https://github.com/cloudnative-pg/plugin-barman-cloud.git
synced 2026-09-04 22:22:21 +02:00
Compare commits
1 Commits
2a14ed371f
...
9ec4c7b912
| Author | SHA1 | Date | |
|---|---|---|---|
|
9ec4c7b912 |
20
Taskfile.yml
20
Taskfile.yml
@ -67,26 +67,6 @@ tasks:
|
||||
GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/commitlint@${DAGGER_COMMITLINT_SHA}
|
||||
lint --source . --args "--from=origin/main" stdout
|
||||
|
||||
pip-compile-sidecar:
|
||||
desc: Regenerate containers/sidecar-requirements.txt with the same Python version as the sidecar image
|
||||
cmds:
|
||||
- >
|
||||
GITHUB_REF= dagger call --no-mod
|
||||
container from --address=debian:trixie-slim
|
||||
with-env-variable --name=DEBIAN_FRONTEND --value=noninteractive
|
||||
with-exec --args="apt-get,update,-qq"
|
||||
with-exec --args="apt-get,install,-y,-qq,python3,python3-venv,python3-pip,gcc,libpq-dev"
|
||||
with-exec --args="pip,install,--quiet,--break-system-packages,pip-tools,click<8.5.0"
|
||||
with-directory --path=/work --source=containers
|
||||
with-workdir --path=/work
|
||||
with-exec --args="pip-compile,--allow-unsafe,--generate-hashes,--output-file=sidecar-requirements.txt,--strip-extras,sidecar-requirements.in"
|
||||
file --path=/work/sidecar-requirements.txt
|
||||
export --path=containers/sidecar-requirements.txt
|
||||
sources:
|
||||
- containers/sidecar-requirements.in
|
||||
generates:
|
||||
- containers/sidecar-requirements.txt
|
||||
|
||||
uncommitted:
|
||||
desc: Check for uncommitted changes
|
||||
deps:
|
||||
|
||||
@ -54,47 +54,7 @@ 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, ManifestVersion } from '@site/src/components/Installation';
|
||||
import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation';
|
||||
|
||||
<Tabs groupId="install-method" queryString>
|
||||
<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).
|
||||
This installs the latest published chart release; to test an unreleased
|
||||
development snapshot instead, switch to the [**Manifest (kubectl)**](./?install-method=kubectl#installing-the-barman-cloud-plugin) tab.
|
||||
|
||||
<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 />:
|
||||
|
||||
@ -125,7 +85,8 @@ issuer.cert-manager.io/selfsigned-issuer created
|
||||
Finally, check that the deployment is up and running:
|
||||
|
||||
```sh
|
||||
kubectl -n cnpg-system rollout status deploy/barman-cloud
|
||||
kubectl rollout status deployment \
|
||||
-n cnpg-system barman-cloud
|
||||
```
|
||||
|
||||
Example output:
|
||||
@ -134,11 +95,6 @@ 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
|
||||
|
||||
@ -485,10 +485,14 @@ If problems persist:
|
||||
|
||||
### Plugin Limitations
|
||||
|
||||
1. **Sidecar resource sharing**: The plugin sidecar container shares pod
|
||||
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
|
||||
resources with PostgreSQL
|
||||
|
||||
2. **Plugin restart behavior**: Restarting the sidecar container requires
|
||||
3. **Plugin restart behavior**: Restarting the sidecar container requires
|
||||
restarting the entire PostgreSQL pod
|
||||
|
||||
## Recap of General Debugging Steps
|
||||
@ -584,3 +588,4 @@ kubectl get secret -n <namespace> <secret-name> -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.
|
||||
|
||||
|
||||
@ -1,36 +0,0 @@
|
||||
import {ReactElement} from 'react';
|
||||
import CodeBlock from '@theme/CodeBlock';
|
||||
import {useActiveVersion, useLatestVersion} from '@docusaurus/plugin-content-docs/client';
|
||||
|
||||
// HelmInstallationSnippet is the Helm command to install the plugin.
|
||||
//
|
||||
// - Latest release: no override. The chart already defaults to
|
||||
// itself.
|
||||
// - Older release: pin image.tag and sidecarImage.tag to that
|
||||
// version. We check this again on every build using
|
||||
// useLatestVersion, so an old page updates itself once a newer
|
||||
// version ships.
|
||||
// - Dev docs: also no override, but this does NOT install a dev
|
||||
// build. Setting the tag alone would not be enough, since the
|
||||
// chart's own templates (CRDs, RBAC...) can be older than what
|
||||
// main needs. Use the kubectl method to test a dev build.
|
||||
export function HelmInstallationSnippet(): ReactElement<null> {
|
||||
const activeVersion = useActiveVersion('default');
|
||||
const latestVersion = useLatestVersion('default');
|
||||
const isOlderRelease = activeVersion
|
||||
&& activeVersion.name !== 'current'
|
||||
&& activeVersion.name !== latestVersion.name;
|
||||
const setArgs = isOlderRelease
|
||||
? ` \\
|
||||
--set image.tag=v${activeVersion.name} \\
|
||||
--set sidecarImage.tag=v${activeVersion.name}`
|
||||
: '';
|
||||
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${setArgs} \\
|
||||
cnpg/plugin-barman-cloud`}
|
||||
</CodeBlock>
|
||||
);
|
||||
}
|
||||
@ -1,7 +1,5 @@
|
||||
import {ReactElement} from 'react';
|
||||
import CodeBlock from '@theme/CodeBlock';
|
||||
import Link from '@docusaurus/Link';
|
||||
import {useLocation} from '@docusaurus/router';
|
||||
import {useActiveVersion} from '@docusaurus/plugin-content-docs/client';
|
||||
|
||||
// DEV_MANIFEST_URL is the URL of the manifest.yaml on the main branch of the plugin repo.
|
||||
@ -33,17 +31,14 @@ export function ManifestVersion(): ReactElement<null> {
|
||||
: <>the latest development snapshot from the <code>main</code> branch</>;
|
||||
}
|
||||
|
||||
// DevSnapshotSection shows how to test the main-branch manifest. On
|
||||
// the Dev docs, the kubectl install above already does that, so we
|
||||
// hide this section there. (The Helm tab there installs the latest
|
||||
// release, not a dev build.)
|
||||
// DevSnapshotSection offers the main-branch manifest as an alternative;
|
||||
// on the Dev docs the main install already is that manifest, so hide it.
|
||||
export function DevSnapshotSection(): ReactElement {
|
||||
const activeVersion = useActiveVersion('default');
|
||||
const {pathname} = useLocation();
|
||||
if (!activeVersion || activeVersion.name === 'current') {
|
||||
return (
|
||||
<p>The <Link to={`${pathname}?install-method=kubectl#installing-the-barman-cloud-plugin`}>kubectl
|
||||
install command above</Link> already applies the latest development
|
||||
<p>The <a href="#installing-the-barman-cloud-plugin">install
|
||||
command above</a> already applies the latest development
|
||||
snapshot from the <code>main</code> branch.</p>
|
||||
);
|
||||
}
|
||||
|
||||
@ -54,45 +54,7 @@ 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, 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 />:
|
||||
|
||||
@ -123,7 +85,8 @@ issuer.cert-manager.io/selfsigned-issuer created
|
||||
Finally, check that the deployment is up and running:
|
||||
|
||||
```sh
|
||||
kubectl -n cnpg-system rollout status deploy/barman-cloud
|
||||
kubectl rollout status deployment \
|
||||
-n cnpg-system barman-cloud
|
||||
```
|
||||
|
||||
Example output:
|
||||
@ -132,11 +95,6 @@ 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
|
||||
|
||||
@ -485,10 +485,14 @@ If problems persist:
|
||||
|
||||
### Plugin Limitations
|
||||
|
||||
1. **Sidecar resource sharing**: The plugin sidecar container shares pod
|
||||
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
|
||||
resources with PostgreSQL
|
||||
|
||||
2. **Plugin restart behavior**: Restarting the sidecar container requires
|
||||
3. **Plugin restart behavior**: Restarting the sidecar container requires
|
||||
restarting the entire PostgreSQL pod
|
||||
|
||||
## Recap of General Debugging Steps
|
||||
@ -584,3 +588,4 @@ kubectl get secret -n <namespace> <secret-name> -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.
|
||||
|
||||
|
||||
@ -54,45 +54,7 @@ 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, 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 />:
|
||||
|
||||
@ -123,7 +85,8 @@ issuer.cert-manager.io/selfsigned-issuer created
|
||||
Finally, check that the deployment is up and running:
|
||||
|
||||
```sh
|
||||
kubectl -n cnpg-system rollout status deploy/barman-cloud
|
||||
kubectl rollout status deployment \
|
||||
-n cnpg-system barman-cloud
|
||||
```
|
||||
|
||||
Example output:
|
||||
@ -132,9 +95,6 @@ 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
|
||||
|
||||
@ -485,10 +485,14 @@ If problems persist:
|
||||
|
||||
### Plugin Limitations
|
||||
|
||||
1. **Sidecar resource sharing**: The plugin sidecar container shares pod
|
||||
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
|
||||
resources with PostgreSQL
|
||||
|
||||
2. **Plugin restart behavior**: Restarting the sidecar container requires
|
||||
3. **Plugin restart behavior**: Restarting the sidecar container requires
|
||||
restarting the entire PostgreSQL pod
|
||||
|
||||
## Recap of General Debugging Steps
|
||||
@ -584,3 +588,4 @@ kubectl get secret -n <namespace> <secret-name> -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.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user