marco/plugin-barman-cloud
1
0
Fork 0
mirror of https://github.com/cloudnative-pg/plugin-barman-cloud.git synced 2026-01-12 05:33:11 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
8aabd2860b
plugin-barman-cloud/web/versioned_docs/version-0.6.0/intro.md
Jeff Mealo 8aabd2860b docs(web): add troubleshooting guide and improve navigation 
- Create troubleshooting page with debugging steps and known issues
- Add hero subtitle and quick links to landing page
- Document kubectl-cnpg backup command syntax changes
- Include migration notes for users switching from in-tree backup

Signed-off-by: Jeff Mealo <jmealo@protonmail.com>
2025-09-19 10:35:07 +02:00

2.6 KiB
Raw Blame History

sidebar_position sidebar_label
1 Introduction

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:

  • CloudNativePG version 1.26 or later
    • Version 1.27.0 or later is strongly recommended for enhanced plugin error and status reporting
    • See the upgrade guide if you need to upgrade
  • cert-manager to enable TLS communication between the plugin and the operator
  • kubectl-cnpg plugin (recommended)
    • Provides enhanced debugging and status checking capabilities
    • Install via kubectl krew install cnpg or download from releases

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