Puppet Class: pgprobackup

Inherited by:
pgprobackup::catalog
pgprobackup::instance
Defined in:
manifests/init.pp

Summary

Manages PostgreSQL backups using pg_probackup

Overview

Examples:

include pgprobackup

Parameters:

  • package_ensure (String) —

    Ensure package installation

  • package_name (String) —

    Base package name, e.g. ‘pg_probackup`, `pg_probackup-std`, `pg_probackup-ent`

  • host_group (String) —

    Allows grouping DB servers, each host_group should have just one backup catalog.

  • db_name (String) —

    Database created on DB instance

  • db_user (String) —

    PostgreSQL role used for connecting to DB instance/replication.

  • debug_symbols (Boolean) —

    Whether to install package with debugging symbols, default: true

  • debug_suffix (Optional[String]) (defaults to: undef) —

    Suffix for debug package

  • backup_dir (Stdlib::AbsolutePath) —

    Path to backup catalog (physical backups storage)

  • manage_ssh_keys (Boolean) —

    When enabled public SSH key from backup catalog user will be added as authorized key on DB instance

  • manage_host_keys (Boolean) —

    Adds host’s ssh fingerprint to known hosts (required to negotiate ssh connection)

  • manage_pgpass (Boolean) —

    When true, configures password for database authentication (for backup role).

  • manage_hba (Boolean) —

    When enabled, create rule for connection from backup catalog server to DB instance.

  • backup_user (String)
  • manage_cron (Boolean)
  • log_dir (Optional[Stdlib::AbsolutePath]) (defaults to: undef)
  • host_key_type (String) 


34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'manifests/init.pp', line 34

class pgprobackup (
  String                         $package_name,
  String                         $package_ensure,
  String                         $host_group,
  String                         $db_name,
  String                         $db_user,
  Boolean                        $debug_symbols,
  Stdlib::AbsolutePath           $backup_dir,
  String                         $backup_user,
  Boolean                        $manage_ssh_keys,
  Boolean                        $manage_host_keys,
  Boolean                        $manage_pgpass,
  Boolean                        $manage_hba,
  Boolean                        $manage_cron,
  String                         $host_key_type,
  Optional[Stdlib::AbsolutePath] $log_dir = undef,
  Optional[String]               $debug_suffix = undef,
) {
  contain pgprobackup::repo
}