From 087623f3f2c883d4e5a9dcacbd258a43af8933e1 Mon Sep 17 00:00:00 2001 From: Gabriele Bartolini Date: Wed, 7 May 2025 10:59:32 +0200 Subject: [PATCH] docs: document the container images (#317) Closes #299 Signed-off-by: Gabriele Bartolini Co-authored-by: Marco Nenciarini --- web/docs/images.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/web/docs/images.md b/web/docs/images.md index ed1bdbb..f6c32d3 100644 --- a/web/docs/images.md +++ b/web/docs/images.md @@ -1,9 +1,37 @@ --- -sidebar_position: 40 +sidebar_position: 99 --- # Container Images -TODO +The Barman Cloud Plugin is distributed using two container images: + +- One for deploying the plugin components +- One for the sidecar that runs alongside each PostgreSQL instance in a + CloudNativePG `Cluster` using the plugin + +## Plugin Container Image + +The plugin image contains the logic required to operate the Barman Cloud Plugin +within your Kubernetes environment with CloudNativePG. It is published on the +GitHub Container Registry at `ghcr.io/cloudnative-pg/plugin-barman-cloud`. + +This image is built from the +[`Dockerfile.plugin`](https://github.com/cloudnative-pg/plugin-barman-cloud/blob/main/containers/Dockerfile.plugin) +in the plugin repository. + +## Sidecar Container Image + +The sidecar image is used within each PostgreSQL pod in the cluster. It +includes the latest supported version of Barman Cloud and is responsible for +performing WAL archiving and backups on behalf of CloudNativePG. + +It is available at `ghcr.io/cloudnative-pg/plugin-barman-cloud-sidecar` and is +built from the +[`Dockerfile.sidecar`](https://github.com/cloudnative-pg/plugin-barman-cloud/blob/main/containers/Dockerfile.sidecar). + +These sidecar images are designed to work seamlessly with the +[`minimal` PostgreSQL container images](https://github.com/cloudnative-pg/postgres-containers?tab=readme-ov-file#minimal-images) +maintained by the CloudNativePG Community.