/puppet-duplicity

Puppet module for duplicity

Primary LanguagePuppet

Puppet module: duplicity

This is a Puppet module for duplicity It provides only package installation and file configuration.

Based on Example42 layouts by Alessandro Franceschi / Lab42

Official git repository: http://github.com/gehel/puppet-duplicity

Released under the terms of Apache 2 License.

This module requires the presence of Example42 Puppi module in your modulepath.

USAGE - Module specific usage

  • Install duplicity and configure a backup

      class { 'duplicity':
    backups => {
      my_own_backup => {
        source_dir   => '/some/dir/to/backup',
        target_url   =>   'scp://my_username@backup.server//path/to/my/backup/dir',
        user         =>  'my_username',
        ssh_key_file => '/home/my_username/.ssh/backup_key',
      }
    }
  }

  • Install duplicity and configure a backup, another way

      class { 'duplicity':
  }
  duplicity::backup { 'my_other_backup':
    source_dir   => '/some/dir/to/backup',
    target_url   =>   'scp://my_username@backup.server//path/to/my/backup/dir',
    user         =>  'my_username',
    ssh_key_file => '/home/my_username/.ssh/backup_key',
  }

  • Default values can be given at class level

      class { 'duplicity':
    user         =>  'my_username',
    ssh_key_file => '/home/my_username/.ssh/backup_key',
  }
  duplicity::backup { 'my_other_backup':
    source_dir   => '/some/dir/to/backup',
    target_url   =>   'scp://my_username@backup.server//path/to/my/backup/dir',
  }
  duplicity::backup { 'still_another_backup':
    source_dir   => '/some/other/dir/to/backup',
    target_url   =>   'scp://my_username@backup.server//path/to/my/other/backup/dir',
  }

USAGE - Basic management

  • Install duplicity with default settings

      class { 'duplicity': }

  • Install a specific version of duplicity package

      class { 'duplicity':
    version => '1.0.1',
  }

  • Remove duplicity resources

      class { 'duplicity':
    absent => true
  }

  • Enable auditing without without making changes on existing duplicity configuration files

      class { 'duplicity':
    audit_only => true
  }

  • Module dry-run: Do not make any change on all the resources provided by the module

      class { 'duplicity':
    noops => true
  }

USAGE - Overrides and Customizations

  • Use custom source directory for the whole configuration dir

      class { 'duplicity':
    source_dir       => 'puppet:///modules/example42/duplicity/conf/',
    source_dir_purge => false, # Set to true to purge any existing file not present in $source_dir
  }

  • Use custom template for main config file. Note that template and source arguments are alternative.

      class { 'duplicity':
    template => 'example42/duplicity/duplicity.conf.erb',
  }

  • Automatically include a custom subclass

      class { 'duplicity':
    my_class => 'example42::my_duplicity',
  }

TESTING

Build Status