Puppet Class: mysql::backup::mysqldump

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

Summary

"Provider" for mysqldump

Overview

Parameters:

  • backupuser (String) (defaults to: '')
  • backuppassword (Variant[String, Sensitive[String]]) (defaults to: '')
  • backupdir (String) (defaults to: '')
  • maxallowedpacket (String[1]) (defaults to: '1M')
  • 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[1]) (defaults to: 'mysqldump')
  • 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: false)
  • 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: [])
  • mysqlbackupdir_ensure (String[1]) (defaults to: 'directory')
  • mysqlbackupdir_target (Optional[String[1]]) (defaults to: undef)
  • incremental_backups (Boolean) (defaults to: false)
  • install_cron (Boolean) (defaults to: true)
  • compression_command (String[1]) (defaults to: 'bzcat -zc')
  • compression_extension (String[1]) (defaults to: '.bz2')
  • backupmethod_package (Optional[String[1]]) (defaults to: undef)
  • excludedatabases (Array[String]) (defaults to: [])


5
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
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'manifests/backup/mysqldump.pp', line 5

class mysql::backup::mysqldump (
  String                                        $backupuser               = '',
  Variant[String, Sensitive[String]]            $backuppassword           = '',
  String                                        $backupdir                = '',
  String[1]                                     $maxallowedpacket         = '1M',
  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[1]                                     $backupmethod             = 'mysqldump',
  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         = false,
  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            = [],
  String[1]                                     $mysqlbackupdir_ensure    = 'directory',
  Optional[String[1]]                           $mysqlbackupdir_target    = undef,
  Boolean                                       $incremental_backups      = false,
  Boolean                                       $install_cron             = true,
  String[1]                                     $compression_command      = 'bzcat -zc',
  String[1]                                     $compression_extension    = '.bz2',
  Optional[String[1]]                           $backupmethod_package     = undef,
  Array[String]                                 $excludedatabases         = [],
) inherits mysql::params {
  $backuppassword_unsensitive = if $backuppassword =~ Sensitive {
    $backuppassword.unwrap
  } else {
    $backuppassword
  }

  unless $facts['os']['family'] == 'FreeBSD' {
    if $backupcompress and $compression_command == 'bzcat -zc' {
      stdlib::ensure_packages(['bzip2'])
      Package['bzip2'] -> File['mysqlbackup.sh']
    }
  }

  mysql_user { "${backupuser}@localhost":
    ensure        => $ensure,
    password_hash => Deferred('mysql::password', [$backuppassword]),
    require       => Class['mysql::server::root_password'],
  }

  if $include_triggers {
    $privs = ['SELECT', 'RELOAD', 'LOCK TABLES', 'SHOW VIEW', 'PROCESS', 'TRIGGER']
  } else {
    $privs = ['SELECT', 'RELOAD', 'LOCK TABLES', 'SHOW VIEW', 'PROCESS']
  }

  mysql_grant { "${backupuser}@localhost/*.*":
    ensure     => $ensure,
    user       => "${backupuser}@localhost",
    table      => '*.*',
    privileges => $privs,
    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 { 'mysql-backup':
    ensure   => $ensure,
    command  => '/usr/local/sbin/mysqlbackup.sh',
    user     => 'root',
    hour     => $time[0],
    minute   => $time[1],
    monthday => $time[2],
    month    => $time[3],
    weekday  => $time[4],
    require  => File['mysqlbackup.sh'],
  }

  $parameters = {
    'backupuser'=> $backupuser,
    'backuppassword_unsensitive'=> $backuppassword_unsensitive,
    'maxallowedpacket'=> $maxallowedpacket,
    'backupdir'=> $backupdir,
    'backuprotate'=> $backuprotate,
    'prescript'=> $prescript,
    'ignore_events'=> $ignore_events,
    'backupdatabases'=> $backupdatabases,
    'include_triggers'=> $include_triggers,
    'optional_args'=> $optional_args,
    'execpath'=> $execpath,
    'delete_before_dump'=> $delete_before_dump,
    'excludedatabases'=> $excludedatabases,
    'backupmethod'=> $backupmethod,
    'backupcompress'=> $backupcompress,
    'compression_command'=> $compression_command,
    'compression_extension'=> $compression_extension,
    'backup_success_file_path'=> $backup_success_file_path,
    'postscript'=> $postscript,
    'file_per_database'=> $file_per_database,
    'include_routines' => $include_routines,
  }

  # TODO: use EPP instead of ERB, as EPP can handle Data of Type Sensitive without further ado
  file { 'mysqlbackup.sh':
    ensure  => $ensure,
    path    => '/usr/local/sbin/mysqlbackup.sh',
    mode    => '0700',
    owner   => 'root',
    group   => $mysql::params::root_group,
    content => epp('mysql/mysqlbackup.sh.epp',$parameters),
  }

  if $mysqlbackupdir_target {
    file { $backupdir:
      ensure => $mysqlbackupdir_ensure,
      target => $mysqlbackupdir_target,
      mode   => $backupdirmode,
      owner  => $backupdirowner,
      group  => $backupdirgroup,
    }
  } else {
    file { $backupdir:
      ensure => $mysqlbackupdir_ensure,
      mode   => $backupdirmode,
      owner  => $backupdirowner,
      group  => $backupdirgroup,
    }
  }
}