Puppet Class: mysql::backup::mysqlbackup

Inherits:
mysql::params
Defined in:
manifests/backup/mysqlbackup.pp

Summary

Manage the mysqlbackup client.

Overview

Parameters:

  • backupuser (String) (defaults to: '')
  • backuppassword (Variant[String, Sensitive[String]]) (defaults to: '')
  • maxallowedpacket (String[1]) (defaults to: '1M')
  • backupdir (String) (defaults to: '')
  • backupdirmode (String[1]) (defaults to: '0700')
  • backupdirowner (String[1]) (defaults to: 'root')
  • backupdirgroup (String[1]) (defaults to: $mysql::params::root_group)
  • backupcompress (Boolean) (defaults to: true)
  • backuprotate (Variant[Integer, String[1]]) (defaults to: 30)
  • backupmethod (String) (defaults to: '')
  • backup_success_file_path (Optional[String[1]]) (defaults to: undef)
  • ignore_events (Boolean) (defaults to: true)
  • delete_before_dump (Boolean) (defaults to: false)
  • backupdatabases (Array[String[1]]) (defaults to: [])
  • file_per_database (Boolean) (defaults to: false)
  • include_triggers (Boolean) (defaults to: true)
  • include_routines (Boolean) (defaults to: false)
  • ensure (Enum['present', 'absent']) (defaults to: 'present')
  • time (Variant[Array[String[1]], Array[Integer]]) (defaults to: ['23', '5'])
  • prescript (Variant[Boolean, String[1], Array[String[1]]]) (defaults to: false)
  • postscript (Variant[Boolean, String[1], Array[String[1]]]) (defaults to: false)
  • execpath (String[1]) (defaults to: '/usr/bin:/usr/sbin:/bin:/sbin')
  • optional_args (Array[String[1]]) (defaults to: [])
  • incremental_backups (Boolean) (defaults to: false)
  • install_cron (Boolean) (defaults to: true)
  • compression_command (Optional[String[1]]) (defaults to: undef)
  • compression_extension (Optional[String[1]]) (defaults to: undef)
  • backupmethod_package (Optional[String[1]]) (defaults to: undef)


6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'manifests/backup/mysqlbackup.pp', line 6

class mysql::backup::mysqlbackup (
  String                                        $backupuser               = '',
  Variant[String, Sensitive[String]]            $backuppassword           = '',
  String[1]                                     $maxallowedpacket         = '1M',
  String                                        $backupdir                = '',
  String[1]                                     $backupdirmode            = '0700',
  String[1]                                     $backupdirowner           = 'root',
  String[1]                                     $backupdirgroup           = $mysql::params::root_group,
  Boolean                                       $backupcompress           = true,
  Variant[Integer, String[1]]                   $backuprotate             = 30,
  String                                        $backupmethod             = '',
  Optional[String[1]]                           $backup_success_file_path = undef,
  Boolean                                       $ignore_events            = true,
  Boolean                                       $delete_before_dump       = false,
  Array[String[1]]                              $backupdatabases          = [],
  Boolean                                       $file_per_database        = false,
  Boolean                                       $include_triggers         = true,
  Boolean                                       $include_routines         = false,
  Enum['present', 'absent']                     $ensure                   = 'present',
  Variant[Array[String[1]], Array[Integer]]     $time                     = ['23', '5'],
  Variant[Boolean, String[1], Array[String[1]]] $prescript                = false,
  Variant[Boolean, String[1], Array[String[1]]] $postscript               = false,
  String[1]                                     $execpath                 = '/usr/bin:/usr/sbin:/bin:/sbin',
  Array[String[1]]                              $optional_args            = [],
  Boolean                                       $incremental_backups      = false,
  Boolean                                       $install_cron             = true,
  Optional[String[1]]                           $compression_command      = undef,
  Optional[String[1]]                           $compression_extension    = undef,
  Optional[String[1]]                           $backupmethod_package     = undef,
) inherits mysql::params {
  $backuppassword_unsensitive = if $backuppassword =~ Sensitive {
    $backuppassword.unwrap
  } else {
    $backuppassword
  }
  mysql_user { "${backupuser}@localhost":
    ensure        => $ensure,
    password_hash => Deferred('mysql::password', [$backuppassword]),
    require       => Class['mysql::server::root_password'],
  }

  package { 'meb':
    ensure    => $ensure,
  }

  # http://dev.mysql.com/doc/mysql-enterprise-backup/3.11/en/mysqlbackup.privileges.html
  mysql_grant { "${backupuser}@localhost/*.*":
    ensure     => $ensure,
    user       => "${backupuser}@localhost",
    table      => '*.*',
    privileges => ['RELOAD', 'SUPER', 'REPLICATION CLIENT'],
    require    => Mysql_user["${backupuser}@localhost"],
  }

  mysql_grant { "${backupuser}@localhost/mysql.backup_progress":
    ensure     => $ensure,
    user       => "${backupuser}@localhost",
    table      => 'mysql.backup_progress',
    privileges => ['CREATE', 'INSERT', 'DROP', 'UPDATE'],
    require    => Mysql_user["${backupuser}@localhost"],
  }

  mysql_grant { "${backupuser}@localhost/mysql.backup_history":
    ensure     => $ensure,
    user       => "${backupuser}@localhost",
    table      => 'mysql.backup_history',
    privileges => ['CREATE', 'INSERT', 'SELECT', 'DROP', 'UPDATE'],
    require    => Mysql_user["${backupuser}@localhost"],
  }

  if $install_cron {
    if $facts['os']['family'] == 'RedHat' {
      stdlib::ensure_packages('cronie')
    } elsif $facts['os']['family'] != 'FreeBSD' {
      stdlib::ensure_packages('cron')
    }
  }

  cron { 'mysqlbackup-weekly':
    ensure  => $ensure,
    command => 'mysqlbackup backup',
    user    => 'root',
    hour    => $time[0],
    minute  => $time[1],
    weekday => '0',
    require => Package['meb'],
  }

  cron { 'mysqlbackup-daily':
    ensure  => $ensure,
    command => 'mysqlbackup --incremental backup',
    user    => 'root',
    hour    => $time[0],
    minute  => $time[1],
    weekday => '1-6',
    require => Package['meb'],
  }

  $default_options = {
    'mysqlbackup' => {
      'backup-dir'             => $backupdir,
      'with-timestamp'         => true,
      'incremental_base'       => 'history:last_backup',
      'incremental_backup_dir' => $backupdir,
      'user'                   => $backupuser,
      'password'               => Deferred('mysql::password', [$backuppassword_unsensitive]),
    },
  }
  $options = mysql::normalise_and_deepmerge($default_options, $mysql::server::override_options)

  file { 'mysqlbackup-config-file':
    path    => '/etc/mysql/conf.d/meb.cnf',
    content => stdlib::deferrable_epp('mysql/meb.cnf.epp', { 'options' => $options }),
    mode    => '0600',
  }

  file { $backupdir:
    ensure => 'directory',
    mode   => $backupdirmode,
    owner  => $backupdirowner,
    group  => $backupdirgroup,
  }
}