Container Images

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 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.

These sidecar images are designed to work seamlessly with the minimal PostgreSQL container images maintained by the CloudNativePG Community.

The image can be overridden per cluster with the sidecarImage parameter.

warning

This override is meant for debugging and testing. Running a sidecar whose version differs from the operator's is not recommended. Leave it unset in production.

Private Registries

The sidecar runs inside the PostgreSQL pods, so it pulls its image with the same credentials as the other containers of the pod. Set them in the Cluster, as you would for the PostgreSQL image:

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: cluster-example
spec:
  imagePullSecrets:
    - name: my-registry-secret

There is no plugin-specific setting for this.

note

If the Cluster uses a custom spec.serviceAccountName, CloudNativePG does not manage the pull secrets of that service account. Add them to it yourself.

For air-gapped environments, mirror the sidecar image to your registry and set the SIDECAR_IMAGE environment variable of the plugin deployment to the mirrored image.