Puppet Class: backy2

Defined in:
modules/backy2/manifests/init.pp

Overview

SPDX-License-Identifier: Apache-2.0 Class backy2

Install backy2 and configure for backing up ceph rbd volumes to local storage

This class expects to find a ceph config in /etc/ceph/ceph.conf, which

is typically provided by profile::cloudceph::client::rbd

On an initial install, the database can be created with

$ sudo backy2 initdb

Parameters:

cluster_name: ceph cluster name
rados_name: ceph client username

Requires:

Sample Usage

include backy2

Parameters:

  • cluster_name (String)
  • db_pass (String)
  • rados_name (String) (defaults to: 'client.admin')
  • backup_dir (String) (defaults to: '/srv/backy2/data') 


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
 
# File 'modules/backy2/manifests/init.pp', line 22

class backy2(
    String       $cluster_name,
    String       $db_pass,
    String       $rados_name = 'client.admin',
    String       $backup_dir = '/srv/backy2/data',
    ) {

    # The upstream backy2 deb is available from
    #    https://github.com/wamdam/backy2/releases
    #
    # It targets ubuntu but installs just fine on Debian Buster.
    #
    # The dependencies are a bit incomplete, so rather than take any
    #  chances I'm enumerating them here.
    $packages = [
        'python3-alembic',
        'python3-dateutil',
        'python3-fusepy',
        'python3-mysqldb',
        'python3-prettytable',
        'python3-rados',
        'python3-rbd',
        'python3-setproctitle',
        'python3-shortuuid',
        'python3-sqlalchemy',
        'python3-lz4',
        'python3-pycryptodome',
        'python3-psycopg2',
    ]
    ensure_packages($packages)
    ensure_packages('backy2')
    $packages.each |String $package| {
      Package[$package] -> Package['backy2']
    }

    # python3-crypto is not included in bullseye, not sure if it's needed in Buster or not
    # let's include on buster until it's gone so that the existing hosts don't break
    if debian::codename::le('buster') {
        ensure_packages(['python3-crypto'])
        Package['python3-crypto'] -> Package['backy2']
    } elsif debian::codename::ge('bullseye') {
        # The upstream backy2 package expects to 'import Crypto.' On most distros
        # Crypto is installed by cryptodome but on Bullseye and Bookworm it doesn't override
        # the Crypto library name. We can hack around this by changing the library
        # name in the backy2 source.
        #
        # This is phabricator task T301909 and upstream bug
        # https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=886291
        #
        exec {'fix-backy2-crypto-imports':
            command   => '/usr/bin/sed -i s/Crypto\./Cryptodome\./g /usr/lib/python3/dist-packages/backy2/crypt.py /usr/lib/python3/dist-packages/backy2/aes_keywrap.py',
            logoutput => true,
            require   => Package['backy2'],
            unless    => '/usr/bin/grep Cryptodome /usr/lib/python3/dist-packages/backy2/crypt.py && /usr/bin/grep Cryptodome /usr/lib/python3/dist-packages/backy2/aes_keywrap.py',
        }
    }

    # Initialize backy2 db if it isn't already present
    exec {'initialize-backy2-database':
        command     => '/usr/bin/backy2 initdb',
        logoutput   => true,
        require     => Class['postgresql::server'],
        refreshonly => true,
    }

    file {
        '/srv/backy2':
            ensure => 'directory';
        '/srv/backy2/data':
            ensure  => 'directory',
            require => File['/srv/backy2'];
        '/etc/backy.cfg':
            content   => template('backy2/backy.cfg.erb'),
            owner     => 'root',
            group     => 'root',
            mode      => '0440',
            show_diff => false,
            require   => Package['backy2'];
    }

    # Hack in a one-character fix to an upstream bug.  There is a pending
    #  pull request for this, here: https://github.com/wamdam/backy2/pull/72
    file { '/usr/lib/python3/dist-packages/backy2/meta_backends/sql.py':
        owner   => 'root',
        group   => 'root',
        mode    => '0644',
        source  => 'puppet:///modules/backy2/sql.py',
        require => Package['backy2'];
    }
}