Bacula

A puppet module for the Bacula backup system.

Supported Platforms

• OpenBSD
• FreeBSD
• Linux (Debian, Ubuntu, Centos, RedHat, Fedora, SLES)

Requirements

This module requires that exported resources have been setup (e.g. with PuppetDB)

Usage

To understand Bacula, the Component Overview in the Bacula documentation is a useful start to begin understanding the moving parts.

A Minimal Setup

What follows here is the bare minimum you would need to get a fully functional Bacula environment with Puppet. This setup assumes that the three components of Bacula (Director, Storage, and Client) all run on three separate nodes. If desired, there is no reason this setup can not be build up on a single node, just updating the hostnames used below to all point to the same system.

Director Setup

The director component handles coordination of backups and databasing of transactions. In its simplest form, the director can be configured with a simple declaration:

class { 'bacula::director': storage => 'mystorage.example.com' }

Storage Setup

The storage component allocates disk storage for pools that can be used for holding backup data.

class { 'bacula::storage': director => 'mydirector.example.com' }

Client Setup

The client component is run on each system that needs something backed up.

class { 'bacula::client': director => 'mydirector.example.com' }

Creating Backup Jobs

In order for clients to be able to define jobs on the director, exported resources are used, thus there was a reliance on PuppetDB availability in the environment. In the client manifest the bacula::job can be declared as follows:

bacula::job { 'obsidian_logs':
  files => ['/var/log'],
}

Will create a new Job entry in /etc/bacula/conf.d/job.conf the next time the director applies it's catalog that will instruct the system to backup the files or directories at the paths specified in the files parameter.

If a group of jobs will contain the same files, a FileSet resource can be used to simplify the bacula::job resource. This can be exported from the node (ensuring the resource title will be unique when realized) or a simple resource specified on the director using the bacula::fileset defined type as follows:

bacula::fileset { 'Puppet':
  files   => ['/etc/puppet'],
  options => {'compression' => 'LZO' }
}

Available types

bacula::fileset

Defines a Bacula FileSet resource. Parameters are:

• files: string or array of files to backup. Bacula File directive.
• excludes: string or array of files to exclude from a backup. Defaults to ''. Bacula Exclude directive.
• options: hash of options. Defaults to {'signature' => 'MD5', 'compression' => 'GZIP'}. Bacula Options directive.

bacula::job

Define a Bacula Job resource resource which can create new Bacula::Fileset resources if needed. Parameters are:

• files: array of files to backup as part of Bacula::Fileset[$name] Defaults to [].
• excludes: array of files to exclude in Bacula::Fileset[$name] Defaults to [].
• jobtype: one of Backup (default), Restore, Admin or Verify. Defaults to Backup. Bacula Type directive.
• fileset: determines whether to use the Common fileset (false), define a new Bacula::Fileset[$name] (true) or use a previously defined Bacula::Fileset resource (any other string value). Defaults to true. Bacula FileSet directive.
• template: template to use for the fragment. Defaults to bacula/job.conf.erb.
• pool: name of the bacula::director::pool to use. Defaults to Default. Bacula Pool directive.
• jobdef: name of the bacula::jobdef to use. Defaults to Default. Bacula JobDefs directive.
• level: default job level to run the job as. Bacula Level directive.
• accurate: whether to enable accurate mode. NB, can be memory intensive on the client. Defaults to 'no'. Bacula 'Accurate' directive.

See also bacula::jobdefs.

bacula::jobdefs

Define a Bacula JobDefs resource resource. Parameters are:

• jobtype: one of Backup, Restore, Admin or Verify. Defaults to Backup. Bacula Type directive.
• sched: name of the bacula::schedule to use. Defaults to Default. Bacula Schedule directive.
• messages: which messages resource to deliver to. Defaults to Standard. Bacula Messages directive.
• priority: priority of the job. Defaults to 10. Bacula Priority directive.
• pool: name of the bacula::director::pool to use. Defaults to Default. Bacula Pool directive.
• level: default job level for jobs using this JobDefs. Bacula Level directive.
• accurate: whether to enable accurate mode. NB, can be memory intensive on the client. Defaults to 'no'. Bacula 'Accurate' directive.
• reschedule_on_error: Enable rescheduling of failed jobs. Default: false. Bacula Reschedule On Error directive.
• reschedule_interval: The time between retries for failed jobs. Bacula Reschedule Interval directive.
• reschedule_times: The number of retries for failed jobs. Bacula Reschedule Times directive.

bacula::messages

Define a Bacula Messages resource. Parameters are:

• mname: name of the Messages resource. Defaults to Standard. Bacula Name directive.
• daemon: Defaults to dir.
• director: Bacula Director directive.
• append: Bacula Append directive.
• Catalog: Bacula Catalog directive.
• syslog: Bacula Syslog directive.
• Console: Bacula Console directive.
• mail: Bacula Mail directive.
• Operator: Bacula Operator directive.
• mailcmd: Bacula Mail Command directive.
• operatorcmd: Bacula Operator Command directive.

bacula::schedule

Define a Bacula Schedule resource. Parameter is:

• runs: define when a job is run. Bacula Run directive.

bacula::director::pool

Define a Bacula Pool resource. Parameters are:

• pooltype: Defaults to Backup. Bacula Pool Type directive.
• recycle Bacula Recycle directive.
• autoprune: Defaults to Yes. Bacula AutoPrune directive.
• volret: Bacula Volume Retention directive.
• maxvoljobs: Bacula Maximum Volume Jobs directive.
• maxvolbytes: Bacula Maximum Volume Bytes directive.
• purgeaction: Bacula Action On Purge directive. Defaults to Truncate.
• label: Bacula Label Format directive.
• storage: name of the Storage resource backing the pool. Defaults to $bacula::params::bacula_storage. Bacula Storage directive.