Puppet Class: barman::settings

Inherited by:
barman
Defined in:
manifests/settings.pp

Overview

Class: barman

This class just contains default settings for the ‘barman’ Puppet module.

NOTE: Parameters can be changed passing values by Hiera file.

Parameters

user
  • The Barman user. The default value is ‘barman’.

group
  • The group of the Barman user. The default value is ‘barman’.

dbuser
  • The user used by Barman to connect to PostgreSQL database(s). It will be used to build the ‘conninfo’ Barman parameter. The default value is ‘barman’, and will be the same for all the PostgreSQL servers.

dbname
  • The database where Barman can connect. It will be used to build the ‘conninfo’ Barman parameter. The default one is the ‘postgres’ database.

home
  • The Barman user home directory. The default value is ‘/var/lib/barman’, but it can be changed depending on the operating system.

autoconfigure
  • This is the main parameter to enable the autoconfiguration of the backup of a given postgreSQL server performed by Barman.

Authors

  • Giuseppe Broccolo <giuseppe.broccolo@2ndQuadrant.it>

  • Giulio Calacoci <giulio.calacoci@2ndQuadrant.it>

  • Francesco Canovai <francesco.canovai@2ndQuadrant.it>

  • Marco Nenciarini <marco.nenciarini@2ndQuadrant.it>

  • Gabriele Bartolini <gabriele.bartolini@2ndQuadrant.it>

  • Alessandro Grassi <alessandro.grassi@2ndQuadrant.it>

Many thanks to Alessandro Franceschi <al@lab42.it>

Copyright 2012-2017 2ndQuadrant Italia

Parameters:

  • user (Any) (defaults to: 'barman')
  • group (Any) (defaults to: 'barman')
  • dbuser (Any) (defaults to: 'barman')
  • dbname (Any) (defaults to: 'postgres')
  • home (Any) (defaults to: '/var/lib/barman')
  • home_mode (Any) (defaults to: '0750')
  • archiver (Any) (defaults to: true)
  • archiver_batch_size (Any) (defaults to: undef)
  • backup_method (Any) (defaults to: undef)
  • backup_options (Any) (defaults to: 'exclusive_backup')
  • bandwidth_limit (Any) (defaults to: undef)
  • basebackup_retry_sleep (Any) (defaults to: false)
  • basebackup_retry_times (Any) (defaults to: false)
  • check_timeout (Any) (defaults to: undef)
  • custom_compression_filter (Any) (defaults to: undef)
  • custom_decompression_filter (Any) (defaults to: undef)
  • compression (Any) (defaults to: 'gzip')
  • immediate_checkpoint (Any) (defaults to: false)
  • last_backup_maximum_age (Any) (defaults to: false)
  • logfile (Any) (defaults to: '/var/log/barman/barman.log')
  • log_level (Any) (defaults to: undef)
  • minimum_redundancy (Any) (defaults to: '0')
  • network_compression (Any) (defaults to: undef)
  • parallel_jobs (Any) (defaults to: undef)
  • path_prefix (Any) (defaults to: undef)
  • post_archive_retry_script (Any) (defaults to: false)
  • post_archive_script (Any) (defaults to: false)
  • post_backup_retry_script (Any) (defaults to: false)
  • post_backup_script (Any) (defaults to: false)
  • pre_archive_retry_script (Any) (defaults to: false)
  • pre_archive_script (Any) (defaults to: false)
  • pre_backup_retry_script (Any) (defaults to: false)
  • pre_backup_script (Any) (defaults to: false)
  • recovery_options (Any) (defaults to: undef)
  • retention_policy (Any) (defaults to: '')
  • retention_policy_mode (Any) (defaults to: 'auto')
  • reuse_backup (Any) (defaults to: false)
  • slot_name (Any) (defaults to: undef)
  • streaming_archiver (Any) (defaults to: false)
  • streaming_archiver_batch_size (Any) (defaults to: undef)
  • streaming_archiver_name (Any) (defaults to: undef)
  • streaming_backup_name (Any) (defaults to: undef)
  • tablespace_bandwidth_limit (Any) (defaults to: undef)
  • wal_retention_policy (Any) (defaults to: 'main')
  • custom_lines (Any) (defaults to: '')
  • autoconfigure (Any) (defaults to: false)
  • host_group (Any) (defaults to: 'global')
  • manage_package_repo (Any) (defaults to: false)
  • manage_ssh_host_keys (Any) (defaults to: false)
  • purge_unknown_conf (Any) (defaults to: false)
  • hba_entry_order (Any) (defaults to: 50)


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'manifests/settings.pp', line 44

class barman::settings (
  $user                          = 'barman',
  $group                         = 'barman',
  $dbuser                        = 'barman',
  $dbname                        = 'postgres',
  $home                          = '/var/lib/barman',
  $home_mode                     = '0750',
  $archiver                      = true,
  $archiver_batch_size           = undef,
  $backup_method                 = undef,
  $backup_options                = 'exclusive_backup',
  $bandwidth_limit               = undef,
  $basebackup_retry_sleep        = false,
  $basebackup_retry_times        = false,
  $check_timeout                 = undef,
  $custom_compression_filter     = undef,
  $custom_decompression_filter   = undef,
  $compression                   = 'gzip',
  $immediate_checkpoint          = false,
  $last_backup_maximum_age       = false,
  $logfile                       = '/var/log/barman/barman.log',
  $log_level                     = undef,
  $minimum_redundancy            = '0',
  $network_compression           = undef,
  $parallel_jobs                 = undef,
  $path_prefix                   = undef,
  $post_archive_retry_script     = false,
  $post_archive_script           = false,
  $post_backup_retry_script      = false,
  $post_backup_script            = false,
  $pre_archive_retry_script      = false,
  $pre_archive_script            = false,
  $pre_backup_retry_script       = false,
  $pre_backup_script             = false,
  $recovery_options              = undef,
  $retention_policy              = '',
  $retention_policy_mode         = 'auto',
  $reuse_backup                  = false,
  $slot_name                     = undef,
  $streaming_archiver            = false,
  $streaming_archiver_batch_size = undef,
  $streaming_archiver_name       = undef,
  $streaming_backup_name         = undef,
  $tablespace_bandwidth_limit    = undef,
  $wal_retention_policy          = 'main',
  $custom_lines                  = '',
  $autoconfigure                 = false,
  $host_group                    = 'global',
  $manage_package_repo           = false,
  $manage_ssh_host_keys          = false,
  $purge_unknown_conf            = false,
  $hba_entry_order               = 50,
) {

}