Forge Home


Install a generic database backup solution for mysql and postgres


53 latest version

4.7 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 2.1.0 (latest)
  • 2.0.0
  • 1.3.1
  • 1.3.0
  • 1.2.1
  • 1.2.0
  • 1.1.1
  • 1.1.0
  • 1.0.1
  • 1.0.0
released Jul 4th 2024
This version is compatible with:
  • Puppet Enterprise 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 9.0.0
  • , , Archlinux

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppet-dbbackup', '2.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppet-dbbackup
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppet-dbbackup --version 2.1.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.



puppet/dbbackup — version 2.1.0 Jul 4th 2024


Build Status Release Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores docs AGPL v3 License

Table of Contents


This is a module for deploying a backup solution for mysql,postgresql and LDAP databases.

It configures two things, the dump_databases script in /usr/local/bin/, and a sytemd timer+service to start it. multiple parameters are exposed to configure the history you want to keep and also the backup interval. All parameters have puppet-strings documentation in the Dependingon the database you backup, multiple CLI tools are required:

  • psql
  • pg_dumpall
  • mysql
  • mysqldump
  • slapcat
  • pigz

The script always assumes that it's executed on the same machine that runs the database. The dependencies aren't managed by this module.

Example configuration

You can simply include the class and it will do dumps every 1 hour and never delete them:

include dbbackup

you can also configure parameter via Hiera or Puppet DSL. An example:

dbbackup::backuphistory: 730
dbbackup::destination: '/var/dumps'
dbbackup::interval: '2h'


This module has several unit tests and linters configured. You can execute them by running:

bundle exec rake test

Detailed instructions are in the file.


Contribution is fairly easy:

  • Fork the module into your namespace
  • Create a new branch
  • Commit your bugfix or enhancement
  • Write a test for it (maybe start with the test first)
  • Create a pull request

Detailed instructions are in the file.

License and Author

This module was originally written by Tim Meusel. It's licensed with AGPL version 3.