Barman Manual

Barman Manual - EnterpriseDB UK Limited - January 24, 2024 (3.10.0)

Barman (Backup and Recovery Manager) is an open-source administration tool for disaster recovery of PostgreSQL servers written in Python. It allows your organisation to perform remote backups of multiple servers in business critical environments to reduce risk and help DBAs during the recovery phase.

Barman is distributed under GNU GPL 3 and maintained by EnterpriseDB , a platinum sponsor of the PostgreSQL project .

Important

This manual assumes that you are familiar with theoretical disaster recovery concepts, and that you have a grasp of PostgreSQL fundamentals in terms of physical backup and disaster recovery. See section "Before you start" below for details.

• Introduction
• Before you start
• Design and architecture
  • Where to install Barman
  • One Barman, many PostgreSQL servers
  • Streaming backup vs rsync/SSH
  • The Barman WAL archive
  • Two typical scenarios for backups
    • Scenario 1: Backup via streaming protocol
    • Scenario 2: Backup via rsync /SSH
• System requirements
  • Requirements for backup
  • Requirements for recovery
• Installation
  • Installation on Red Hat Enterprise Linux (RHEL) and RHEL-based systems using RPM packages
  • Installation on Debian/Ubuntu using packages
  • Installation on SLES using packages
  • Installation from sources
  • PostgreSQL client/server binaries
    • Third party PostgreSQL variants
• Upgrading Barman
  • Upgrading to Barman 3.0.0
    • Default backup approach for Rsync backups is now concurrent
    • Metadata changes
  • Upgrading from Barman 2.10
  • Upgrading from Barman 2.X (prior to 2.8)
  • Upgrading from Barman 1.X
• Configuration
  • Options scope
  • Examples of configuration
• Setup of a new server in Barman
• Preliminary steps
  • PostgreSQL connection
  • PostgreSQL WAL archiving and replication
  • PostgreSQL streaming connection
  • SSH connections
  • SSH configuration of postgres user
  • SSH configuration of barman user
  • From PostgreSQL to Barman
  • From Barman to PostgreSQL
• The server configuration file
• WAL streaming
  • Replication slots
  • How to configure the WAL streaming
  • Streaming WALs and backups from different hosts (Barman 3.10.0 and later)
  • Limitations of partial WAL files with recovery
• WAL archiving via archive_command
  • WAL archiving via barman-wal-archive
  • WAL archiving via rsync/SSH
• Verification of WAL archiving configuration
• Streaming backup
• Backup with rsync /SSH
• Backup with cloud snapshots
  • Prerequisites for cloud snapshots
  • Google Cloud Platform snapshot prerequisites
  • Azure snapshot prerequisites
  • AWS snapshot prerequisites
  • Configuration for snapshot backups
  • Configuration for Google Cloud Platform snapshots
  • Configuration for Azure snapshots
  • Configuration for AWS snapshots
  • Taking a snapshot backup
• How to setup a Windows based server
• General commands
  • cron
  • diagnose
  • list-servers
• Server commands
  • archive-wal
  • backup
  • check
  • config-update
  • config-switch
  • generate-manifest
  • get-wal
  • list-backups
  • rebuild-xlogdb
  • receive-wal
    • receive-wal process management
    • Replication slot management
  • replication-status
  • show-servers
  • status
  • switch-wal
  • verify-backup
• Backup commands
  • Backup ID shortcuts
  • check-backup
  • delete
  • keep
  • list-files
  • recover
    • Remote recovery
    • Tablespace remapping
    • Point in time recovery
    • Fetching WALs from the Barman server
    • Recovering compressed backups
  • show-backup
• Features in detail
  • Backup features
    • Incremental backup
    • Limiting bandwidth usage
    • Network Compression
    • Backup Compression
    • Compression algorithms
    • Compression workers
    • Compression level
    • Compression location
    • Compression format
    • Concurrent backup
    • Concurrent backup of a standby
    • Immediate checkpoint
    • Local backup
  • Archiving features
    • WAL compression
    • Synchronous WAL streaming
  • Catalog management features
    • Minimum redundancy safety
    • Retention policies
    • Scope
    • How they work
    • Configuration and syntax
  • Hook scripts
    • Backup scripts
    • Backup delete scripts
    • WAL archive scripts
    • WAL delete scripts
    • Recovery scripts
  • Customization
    • Lock file directory
    • Binary paths
  • Integration with cluster management systems
    • Configuration Models
  • Parallel jobs
    • Parallel jobs and sshd MaxStartups
  • Geographical redundancy
    • Sync information
    • Configuration
    • Node synchronisation
    • Manual synchronisation
  • Cloud snapshot backups
    • Snapshot backup details
    • Recovering from a snapshot backup
    • Backup metadata for snapshot backups
    • GCP provider-specific metadata
    • Azure provider-specific metadata
    • AWS provider-specific metadata
• Barman client utilities ( barman-cli)
  • Installation
• Barman client utilities for the Cloud ( barman-cli-cloud)
  • Installation
  • barman-cloud hook scripts
  • Selecting a cloud provider
  • Specificity by provider
    • Google Cloud Storage
    • set up
    • Usage
  • barman-cloud and snapshot backups
    • barman-cloud-backup for snapshots
    • barman-cloud-restore for snapshots
• Troubleshooting
  • Diagnose a Barman installation
  • Requesting help
    • Submitting a bug
• The Barman project
  • Support and sponsor opportunities
  • Contributing to Barman
  • Authors
  • Links
  • License and Contributions
• Reference Link