mirror of
https://github.com/cloudnative-pg/plugin-barman-cloud.git
synced 2026-01-12 13:43:10 +01:00
8aabd2860b
- 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>
73 lines
2.6 KiB
Markdown
73 lines
2.6 KiB
Markdown
---
|
||
sidebar_position: 1
|
||
sidebar_label: "Introduction"
|
||
---
|
||
|
||
# Barman Cloud Plugin
|
||
|
||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||
|
||
The **Barman Cloud Plugin** for [CloudNativePG](https://cloudnative-pg.io/)
|
||
enables online continuous physical backups of PostgreSQL clusters to object storage
|
||
using the `barman-cloud` suite from the [Barman](https://docs.pgbarman.org/release/latest/)
|
||
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"](migration.md)
|
||
for detailed instructions.
|
||
:::
|
||
|
||
## Requirements
|
||
|
||
To use the Barman Cloud Plugin, you need:
|
||
|
||
- [CloudNativePG](https://cloudnative-pg.io) 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](https://cloudnative-pg.io/documentation/current/installation_upgrade) if you need to upgrade
|
||
- [cert-manager](https://cert-manager.io/) to enable TLS communication between
|
||
the plugin and the operator
|
||
- [kubectl-cnpg plugin](https://cloudnative-pg.io/documentation/current/kubectl-plugin/) (recommended)
|
||
- Provides enhanced debugging and status checking capabilities
|
||
- Install via `kubectl krew install cnpg` or download from [releases](https://github.com/cloudnative-pg/cloudnative-pg/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](https://min.io/) – An S3-compatible storage solution
|
||
- [Azurite](https://github.com/Azure/Azurite) – A simulator for Azure Blob Storage
|
||
- [fake-gcs-server](https://github.com/fsouza/fake-gcs-server) – A simulator for Google Cloud Storage
|
||
|
||
:::tip
|
||
For more details, refer to [Object Store Providers](object_stores.md).
|
||
:::
|