Skip to main content
Version: 0.4.0

Barman Cloud Plugin

The Barman Cloud Plugin for CloudNativePG enables online continuous physical backups of PostgreSQL clusters to object storage using the barman-cloud suite from the Barman project.

important

If you plan to migrate your existing CloudNativePG cluster to the new plugin-based approach using the Barman Cloud Plugin, see "Migrating from Built-in CloudNativePG Backup" for detailed instructions.

Requirements

To use the Barman Cloud Plugin, you need:

Key Features

This plugin provides the following capabilities:

  • Physical online backup of the data directory
  • Physical restore of the data directory
  • Write-Ahead Log (WAL) archiving
  • WAL restore
  • Full cluster recovery
  • Point-in-Time Recovery (PITR)
  • Seamless integration with replica clusters for bootstrap and WAL restore from archive
important

The Barman Cloud Plugin is designed to replace the in-tree object storage support previously provided via the .spec.backup.barmanObjectStore section in the Cluster resource. Backups created using the in-tree approach are fully supported and compatible with this plugin.

Supported Object Storage Providers

The plugin works with all storage backends supported by barman-cloud, including:

  • Amazon S3
  • Google Cloud Storage
  • Microsoft Azure Blob Storage

In addition, the following S3-compatible and simulator solutions have been tested and verified:

  • MinIO – An S3-compatible storage solution
  • Azurite – A simulator for Azure Blob Storage
  • fake-gcs-server – A simulator for Google Cloud Storage
tip

For more details, refer to Object Store Providers.