Forge Home

burp

BURP - BackUp and Restore Program

16,442 downloads

883 latest version

5.0 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

  • 1.4.3 (latest)
  • 1.4.2
  • 1.4.1
  • 1.4.0
  • 1.3.1
  • 1.3.0
  • 1.2.1
  • 1.1.0
  • 1.0.2
  • 1.0.1
  • 1.0.0
released Dec 20th 2021
This version is compatible with:
  • Puppet Enterprise 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, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >=3.7.0 <8.0.0
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'vshn-burp', '1.4.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add vshn-burp
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install vshn-burp --version 1.4.3

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.

Download
Tags: backup, burp

Documentation

vshn/burp — version 1.4.3 Dec 20th 2021

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with burp
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module
  8. Contributors

Overview

This module installs and configures the BURP backup software (client and server mode). BURP stands for BackUp and Restore Program.

Build Status vshn-burp

Module Description

BURP provides one binary for client and server mode. The behaviour depends on the configuration file, passed to the application with the -c parameter. This module provides two main functions:

  • configuring the BURP backup server
  • creating one or more BURP backup client configurations

The default parameters are applicable for BURP version 1.x, but the flexible nature of this module also allows to use the upcomming BURP version 2.

In opposite to the original BURP packaging, this Puppet module configures BURP to only have configuration files in /etc/burp and no dynamic data. All dynamic data like SSL certificates (CA) and the backup data is by default configured to be located under /var/lib/burp (server) and /var/lib/burp-<clientname>.

There can be many client configurations, f.e. to backup to different backup servers with different parameters. Just instantiate the ::burp::client defined type. The default client is name 'burp' because this is the name of the default configuration file and makes it easier to call the application (so you don't need to add -c to every call).

Setup

What burp affects

  • Package burp
  • Configuration files under /etc/burp/
  • BURP server: directory /var/lib/burp
  • BURP client: directory /var/lib/burp-${name}
  • System service burp if configuring the server
  • Cronjob if configuring a client
  • Exported resources for creating clientconfigs on the backup server
  • Delivery of some default scripts to /usr/local/bin:
    • burp_timer_script
    • burp_summary_script
    • burp_notify_script
    • burp_ssl_extra_checks_script

Beginning with burp

Instantiating the main class burp does only install the package and will do some preparations, but nothing more. You need to chose which mode you want to configure:

BURP server mode

class { ::burp::server: }

BURP client mode

class { ::burp:
  clients => {
    burp = {}
  }
}

or

::burp::client { 'burp': }

Usage

To find the default values and parameter documentation, have a look at the .pp files. Everything is documented there.

Reference

This sections describes some specialities

burp::extraconfig

This defined type allows to add some extra configuration to the client from "outside". Configuration directives written to this extra configuration file is included in the main client configuration file. It is located by default under /etc/burp/<clientname>-extra.conf.

Example:

::burp::extraconfig { 'do_this':
  client        => 'burp',
  configuration => { 'include' => [ '/opt/', '/tmp/' ] },
}

More Examples

Please see the examples/ directory for more usage examples.

Limitations

The module has been developed under Ubuntu. But it should also work on Debian, RedHat, CentOS and probably more Linux OS.

Development

  1. Fork it (https://github.com/vshn/puppet-burp/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Make sure your PR passes the Rspec tests.

Contributors

Have a look at Github contributors to see a list of all the awesome contributors to this Puppet module. <3