PostgreSQL with CloudNativePG

CloudNativePG is an operator that runs PostgreSQL on Kubernetes. We provide one CloudNativePG operator for the whole Kubernetes cluster. You define a Cluster resource, and the operator creates and manages the PostgreSQL instances for it.

For the complete operator documentation, see the CloudNativePG website. The quickstart shows a minimal Cluster.

In this chapter, Cluster is the CloudNativePG resource that defines a PostgreSQL database cluster. “Kubernetes cluster” is the platform that runs it.

Pages in this chapter

• Deploy a cluster with the barman-cloud plugin: A replicated Cluster, an ObjectStore with your S3 credentials, a daily ScheduledBackup, and a NetworkPolicy. Use this page for all new deployments.
• Verify backups end-to-end: Checks for WAL archiving, the bucket contents, and an on-demand backup. The page also has a restore test.
• Access and operations: Connections from inside and outside the Kubernetes cluster, NetworkPolicy examples, custom credentials, high availability, storage, images, and known problems.
• Migrate from the legacy in-tree backup: Move an existing Cluster from .spec.backup.barmanObjectStore to the plugin. The data stays in place, and the backups continue in the same S3 path.
• Legacy in-tree backup reference: The deprecated backup configuration, for Clusters that you did not migrate yet.

Which backup does your Cluster use?

CloudNativePG deprecates the in-tree Barman Cloud backup since version 1.26. Version 1.31.0 removes it. To find the backup type of a Cluster, run:

kubectl get cluster.postgresql.cnpg.io <cluster> \
  -o jsonpath='{.spec.backup.barmanObjectStore.destinationPath}{"\n"}{.spec.plugins[*].name}{"\n"}'

• If the first line shows an S3 path, the Cluster uses the in-tree backup. Follow the migration guide.
• If the second line shows barman-cloud.cloudnative-pg.io, the Cluster uses the plugin. Follow Verify backups end-to-end.
• If both lines are empty, the Cluster has no backup to S3. Add the ObjectStore, the plugins section, and the ScheduledBackup from Deploy a cluster.