marco/plugin-barman-cloud
1
0
Fork 0
mirror of https://github.com/cloudnative-pg/plugin-barman-cloud.git synced 2026-07-07 02:02:21 +02:00
Code Issues Packages Projects Releases Wiki Activity
8134ffa96d
plugin-barman-cloud/README.md
Gingiris 1cea59b234 docs: improve README onboarding
2026-05-18 11:08:09 +08:00

3.7 KiB
Raw Blame History

CloudNativePG

Barman Cloud CNPG-I plugin for CloudNativePG

The Barman Cloud CNPG-I plugin extends CloudNativePG with backup and restore integration powered by the Barman Cloud ecosystem.

Table of Contents

What this plugin does

This repository contains the operator, instance, restore, and healthcheck commands that support Barman Cloud backup workflows for CloudNativePG. It also includes Kubernetes manifests, example configurations, end-to-end tests, and the documentation site.

Highlights

  • Backup and restore integration for CloudNativePG environments
  • Operator and instance command implementations under cmd/ and internal/
  • Example manifests under hack/examples/
  • Installable Kubernetes manifests generated from config/
  • Project documentation site under web/

Quick Start

Read the full docs

Start with the official documentation:

Explore example manifests

This repository ships example YAML files such as:

  • hack/examples/backup-example.yaml
  • hack/examples/cluster-example.yaml
  • hack/examples/cluster-restore.yaml
  • hack/examples/minio-store.yaml

Run the main local workflows

make build
make test
make build-installer

Repository Layout

  • cmd/: entrypoints for manager commands
  • internal/: plugin internals, controllers, command implementations, and shared logic
  • config/: CRDs, RBAC, default deployment, samples, and install manifests
  • hack/examples/: example backup, restore, and object store manifests
  • test/: end-to-end coverage
  • web/: Docusaurus documentation site

Documentation

Community

The Barman Cloud CNPG-I plugin is part of the CloudNativePG project and follows the same community-driven governance model under the CNCF.

Sponsors and trademarks

CNCF logo

CloudNativePG was originally built and sponsored by EDB.

EDB logo

Postgres, PostgreSQL, and the Slonik Logo are trademarks or registered trademarks of the PostgreSQL Community Association of Canada, and used with their permission.