Skip to content

Commit 087623f

Browse files
gbartolinimnencia
andauthored
docs: document the container images (#317)
Closes #299 Signed-off-by: Gabriele Bartolini <[email protected]> Co-authored-by: Marco Nenciarini <[email protected]>
1 parent f56072a commit 087623f

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

web/docs/images.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,37 @@
11
---
2-
sidebar_position: 40
2+
sidebar_position: 99
33
---
44

55
# Container Images
66

77
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
88

9-
TODO
9+
The Barman Cloud Plugin is distributed using two container images:
10+
11+
- One for deploying the plugin components
12+
- One for the sidecar that runs alongside each PostgreSQL instance in a
13+
CloudNativePG `Cluster` using the plugin
14+
15+
## Plugin Container Image
16+
17+
The plugin image contains the logic required to operate the Barman Cloud Plugin
18+
within your Kubernetes environment with CloudNativePG. It is published on the
19+
GitHub Container Registry at `ghcr.io/cloudnative-pg/plugin-barman-cloud`.
20+
21+
This image is built from the
22+
[`Dockerfile.plugin`](https://github.com/cloudnative-pg/plugin-barman-cloud/blob/main/containers/Dockerfile.plugin)
23+
in the plugin repository.
24+
25+
## Sidecar Container Image
26+
27+
The sidecar image is used within each PostgreSQL pod in the cluster. It
28+
includes the latest supported version of Barman Cloud and is responsible for
29+
performing WAL archiving and backups on behalf of CloudNativePG.
30+
31+
It is available at `ghcr.io/cloudnative-pg/plugin-barman-cloud-sidecar` and is
32+
built from the
33+
[`Dockerfile.sidecar`](https://github.com/cloudnative-pg/plugin-barman-cloud/blob/main/containers/Dockerfile.sidecar).
34+
35+
These sidecar images are designed to work seamlessly with the
36+
[`minimal` PostgreSQL container images](https://github.com/cloudnative-pg/postgres-containers?tab=readme-ov-file#minimal-images)
37+
maintained by the CloudNativePG Community.

0 commit comments

Comments
 (0)