@@ -6,23 +6,40 @@ sidebar_position: 10
66
77<!-- SPDX-License-Identifier: CC-BY-4.0 -->
88
9- The ** Barman Cloud Plugin** adds support for ** hot (online) backups** of
10- PostgreSQL clusters in CloudNativePG, enabling continuous physical backup and
11- WAL archiving to an ** object store** —without requiring downtime. It also enables
12- ** Full Recovery** and ** Point-in-Time Recovery (PITR)** of a Postgres cluster.
13-
14- Before proceeding, ensure you have reviewed the following sections of the CloudNativePG documentation:
15-
16- - [ ** Backup** ] ( https://cloudnative-pg.io/documentation/current/backup/ )
17- - [ ** WAL Archiving** ] ( https://cloudnative-pg.io/documentation/current/wal_archiving/ )
18- - [ ** Recovery** ] ( https://cloudnative-pg.io/documentation/current/recovery/ )
9+ The ** Barman Cloud Plugin** enables ** hot (online) backups** of PostgreSQL
10+ clusters in CloudNativePG, supporting continuous physical backups and WAL
11+ archiving to an ** object store** —without interrupting write operations.
12+
13+ It also supports both ** full recovery** and ** Point-in-Time Recovery (PITR)**
14+ of a PostgreSQL cluster.
15+
16+ At the core is the [ ` ObjectStore ` custom resource (CRD)] ( plugin-barman-cloud.v1.md#objectstorespec ) ,
17+ which acts as the interface between the PostgreSQL cluster and the target
18+ object storage system. It allows you to configure:
19+
20+ - ** Authentication and bucket location** via the ` .spec.configuration ` section
21+ - ** WAL archiving** settings—such as compression type, parallelism, and
22+ server-side encryption—under ` .spec.configuration.wal `
23+ - ** Base backup options** —with similar settings for compression, concurrency,
24+ and encryption—under ` .spec.configuration.data `
25+ - ** Retention policies** to manage the lifecycle of archived WALs and backups
26+ via ` .spec.configuration.retentionPolicy `
27+
28+ ::: tip
29+ For details, please refer to the
30+ [ API reference for the ` ObjectStore ` resource] ( plugin-barman-cloud.v1.md#objectstorespec ) .
31+ :::
1932
33+ WAL files are archived in the ` wals ` directory, while base backups are stored
34+ as ** tarballs** in the ` base ` directory, following the
35+ [ Barman Cloud convention] ( https://docs.pgbarman.org/cloud/latest/usage/#object-store-layout ) .
2036
21- TODO:
37+ The plugin integrates seamlessly with CloudNativePG’s ` Backup ` and
38+ ` ScheduledBackup ` resources, supporting backups from both primary and
39+ [ standby instances] ( https://cloudnative-pg.io/documentation/current/backup/#backup-from-a-standby )
40+ —including designated primaries in [ replica cluster topologies] ( https://cloudnative-pg.io/documentation/current/replica_cluster/ ) .
2241
23- - explain object store
24- - explain WAL archive
25- - explain base backups
42+ ## About Barman Cloud
2643
2744Instead of relying on a traditional, centralised Barman server, the plugin
2845orchestrates backup operations directly within the Kubernetes cluster using the
@@ -34,14 +51,6 @@ following tools from the [`barman-cloud`](https://pgbarman.org) suite:
3451- ` barman-cloud-backup-list `
3552- ` barman-cloud-backup-delete `
3653
37- Base backups are stored as ** tarballs** , and both base backups and WAL files
38- can be compressed and encrypted.
39-
40- Backups are taken from a ** primary** or ** designated primary** instance in a
41- ` Cluster ` (see
42- [ replica clusters] ( https://cloudnative-pg.io/documentation/current/replica_cluster/ )
43- ) or, alternatively, from a [ standby instance] ( https://cloudnative-pg.io/documentation/current/backup/#backup-from-a-standby ) .
44-
4554## Retention Policies
4655
4756The Barman Cloud Plugin supports ** automated cleanup of obsolete backups** via
0 commit comments