cookbook 'duplicity_ng', '= 1.2.3'
duplicity_ng
(18) Versions
1.2.3
-
Follow2
Installs/Configures duplicity_ng
cookbook 'duplicity_ng', '= 1.2.3', :supermarket
knife supermarket install duplicity_ng
knife supermarket download duplicity_ng
duplicity_ng cookbook
Cookbook for installing duplicity backup cronjobs
Supported Platforms
It should work on most Linux distributions.
Tested on Ubuntu and CentOS.
Note: On RHEL (CentOS) 5.x, make sure you have python, python::package or python::source in your run_list or include them in your wrapper cookbook. Otherwise the process may fail.
Usage
Attributes
See the attributes/default.rb
file for default values.
# Path to duplicity executable (by default "/usr/bin/duplicity"). node['duplicity_ng']['path'] # Use pyhton pip to install duplicity dependencies (defaults to false) node['duplicity_ng']['use_pip'] = true # The following attributes are only used when using the "duplicity_ng::source" recipe node['duplicity_ng']['source']['checksum'] # duplicity remote source file checksum. node['duplicity_ng']['source']['version'] # duplicity version (only for "source" install method). node['duplicity_ng']['source']['gnupg']['checksum'] # GnuPGInterface remote source file checksum. node['duplicity_ng']['source']['gnupg']['version'] # GnuPGInterface version.
Recipes
package
Install duplicity using packages provided by the system. If you need newer versions, you can include
duplicity_ng::ppa
before running this recipe to setup the official duplicity ppa (on Ubuntu)
ppa
Setup Ubuntu repositories with latest version of duplicity
.
Run this recipe before you use the duplicity_ng::install
recipe.
Helper recipes
These recipes you probably do not need to call manually.
The providers run them in case they are required.
install_swift
Helper recipe, installs python-swiftclient
.
Uses the system package if node['duplicity_ng']['use_pip'] = false
, otherwise uses pip.
install_boto
Helper recipe, installs python-boto
.
Uses the system package if node['duplicity_ng']['use_pip'] = false
, otherwise uses pip.
install_azure
Helper recipe, installs MS Azure SDK on Python.
Recommended option: default['duplicity_ng']['use_pip'] = true
Note: Minimum python
version: 2.7.0.
Note: duplicity
works well with Azure starting from 0.7 and up versions. Use it on your own risk.
install_ftp
Helpe recipe, installs ncftp
.
Providers
To use the providers, append the following to your metadata.rb
depends 'duplicity_ng'
duplicity_ng_cronjob
Installs a duplicity cronjob
duplicity_ng_cronjob 'myduplicity' do name 'myduplicity' # Cronjob filename (name_attribute) # Attributes for the default cronjob template interval 'daily' # Cron interval (hourly, daily, monthly) duplicity_path '/usr/bin/duplicity' # Path to duplicity configure_zabbix false # Automatically configure zabbix user paremeters logfile '/dev/null' # Log cronjob output to this file # duplicity parameters backend 'ftp://server.com/folder' # Backend to use (default: nil, required!) passphrase 'supersecret' # duplicity passphrase (default: nil, required!) include %w(/etc/ /root/ /var/log/) # Default directories to backup exclude %w() # Default directories to exclude from backup archive_dir '/tmp/duplicity-archive' # duplicity archive directory temp_dir '/tmp/duplicity-tmp' # duplicity temp directory keep_full 5 # Keep 5 full backups nice 10 # Be nice (cpu) ionice 3 # Ionice class (3 => idle) full_backup_if_older_than '7D' # Take a full backup after this interval # Command(s) to run at the very beginning of the cronjob (default: empty) exec_pre %(if [ -f "/nobackup" ]; then exit 0; fi) # Command(s) to run after cleanup, but before the backup (default: empty) exec_before ['pg_dumpall -U postgres |bzip2 > /tmp/dump.sql.bz2'] # Command(s) to run after the backup has finished (default: empty) exec_after ['touch /backup-sucessfull', 'echo yeeeh'] # In case you use Swift as you backend, specify the credentials here swift_username 'mySwiftUsername' swift_password 'mySwiftPassword' swift_authurl 'SwiftAuthURL' # In case you use S3 as your backend, your credentials go here aws_access_key_id 'MY_ACCESS_ID' aws_secret_access_key 'MY_SECRET' # In case you use Google Cloud Storage as your backend, your credentials go here gs_access_key_id 'MY_ACCESS_ID' gs_secret_access_key 'MY_SECRET' # In case you use MS Azure Blob Storage as your backend, your credentials go here azure_account_name 'MY_ACCOUNT_NAME' azure_account_key 'MY_ACCOUNT_KEY' # GPG options (compression and algorithms) cipher_algo 'aes256' digest_algo 'sha512' compress_algo 'bzip2' compress_level 6 # Alternatively, you can specify your own template to use cookbook 'duplicity_ng' # Cookbook to take erb template from source 'cronjob.sh.erb' # ERB template to use variables {} # Custom variables for ERB template end
Feel free to specify additional (backend related) duplicity arguments to the backend attribute.
For example, to use europe buckets with S3, use the following
duplicity_ng 's3 europe' do backend '--s3-use-new-style --s3-european-buckets s3+http://bucket[/prefix]' # You can also specify a specific server to use # backend '--s3-use-new-style --s3-european-buckets s3://server.com/bucket[/prefix]' # Additional configuration here, see example above end
duplicity_ng_boto
Deploys boto configuration. With this you can skip keys in cronjob
provider.
duplicity_ng_boto 'mybotoconfig' do # In case you use S3, your credentials go here aws_access_key_id 'MY_ACCESS_ID' aws_secret_access_key 'MY_SECRET' # In case you use Google Cloud Storage, your credentials go here gs_access_key_id 'MY_ACCESS_ID' gs_secret_access_key 'MY_SECRET' # In case you need additional options for Boto options { debug: 0, num_retries: 10, ec2_region_name: 'us-west-1', autoscale_endpoint: 'autoscaling.us-west-1.amazonaws.com' } # Alternatively, you can specify your own template to use cookbook 'duplicity_ng' # Cookbook to take erb template from source 'boto.cfg.erb' # ERB template to use variables {} end
Checking status
Since version 1.1.2, you can run commands like collection-status
conveniently.
# Source the configuration . /etc/default/duplicity-$jobname # on Debian familiy . /etc/sysconfig/duplicity-$jobname # on RHEL familiy . /etc/duplicity-$jobname # On other families $DUPLICITY_PATH collection-status $DUPLICITY_ARGUMENTS
Contributing
- Fork the repository on Github
- Create a named feature branch (i.e.
add-new-recipe
) - Write your change
- Write tests for your change (if applicable)
- Run the tests, ensuring they all pass
- Submit a Pull Request
License and Authors
Author: Chris Aumann me@chr4.org
Contributors: Alexander Merkulov sasha@merqlove.ru
Dependent cookbooks
python >= 0.0.0 |
build-essential >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
1.2.3
- Fix path when compiling GPG from source
- Fix dependencies for Azure users
1.2.2
- Use
senstive true
attribute for duplicity environment files, so credentials won't end up in Chef logs - Fix escaping issue with
--gpg-options
1.2.1
- Add attribute to set encryption algorithms (defaults to aes256, sha512)
- Add attribute to set compression algorithm and level (defaults to bzip2, level 6)
- Add support or Microsoft Azure storage
1.2.0
- Use configuration file, so one can use credentials and arguments like temporary directories or backend information easily in interactive sessions (See README for details)
1.1.0
- Add support for CentOS 5.x
1.0.0
- Add support for Google Cloud Storage
- Add ability to install duplicity from source
- Add provider to configure boto
- Add integration tests (for install recipes)
- A lot of internal improvements and fixes
0.2.2
- Fix issue with properly detecting S3 backend
- When specifying additional arguments in front of the s3:// backend, backend dependencies weren't properly detected
0.2.1
- Fix an issue with directory permissions when using
/dev/null
as logfile
0.2.0
- Public release
0.1.0
- Initial release of duplicity_ng (internal)
Foodcritic Metric
1.2.3 passed this metric
1.2.3 passed this metric