Forge Home

znapzend

Installs and configures ZnapZend

7,218 downloads

4,909 latest version

4.5 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.0.2 (latest)
  • 1.0.1
  • 1.0.0 (deleted)
  • 0.9.1
  • 0.9.0
released Nov 1st 2018
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x
  • Puppet >= 5.0.0 < 6.0.0
  • , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'ggrant-znapzend', '1.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add ggrant-znapzend
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install ggrant-znapzend --version 1.0.2

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

Documentation

ggrant/znapzend — version 1.0.2 Nov 1st 2018

znapzend

This modules installs and configures ZnapZend. ZnapZend provides high performance open source ZFS backup with mbuffer and ssh support.

Table of Contents

  1. Description
  2. Setup - The basics of getting started with znapzend
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.

Description

The ZnapZend module does the following:

  • Installs ZnapZend from a package that you supply. An .rpm SPEC file is available, see https://github.com/asciiphil/znapzend-spec
  • Configures ZnapZend via zfs dataset properties.
  • Manages the 'znapzend' service.

Setup

What znapzend affects

This module has the following dependencies:

Setup Requirements

Beginning with znapzend

The module supplies sensible defaults for other values, via included Hiera configuration.

This is the minimum configuration required (for local snapshots via a defaulted snapshot plan):

class { 'znapzend':
  dataset_backups => 
    [
      { 'dataset' => 'tank/dataset1' }
    ]
}

Using Puppet and Hiera:

include znapzend
znapzend::dataset_backups:
  - dataset: 'tank/dataset1'

A default source dataset plan of hourly backups kept for a day, and daily backups kept for a week will be applied.

Usage

A more complete example using most of the module features, using Puppet and Hiera:

include znapzend
  znapzend::dataset_backups:
    - dataset: nmsstore1
      config:
        destinations:
          remote:
            dst: root@foo.example.com
            dst_plan:
              - keep: 10 years
                freq: 1 year
          remote2:
            dst: root@some.other.host
            dst_plan:
              - keep: 1 month
                freq: 1 day
              - keep: 6 months
                freq: 1 week
    - dataset: tank2/home
      config:
        overrides:
          enabled: false
          mbuffer_size: 2G
        destinations:
          totank1:
            dst: root@tank1.example.com
            dst_plan:
              - keep: 1 week
                freq: 30 minutes

Reference

Please see the Puppet Strings generated documentation for a list of classes, parameters, etc.

Limitations

Tested using Puppet 5.5 and CentOS 7.

Development

Pull requests/issues welcome.