taperole 1.5.5 → 1.6.0

data/vendor/Stouts.backup/README.md

@@ -0,0 +1,169 @@
+Stouts.backup
+=============
+
+[![Build Status](http://img.shields.io/travis/Stouts/Stouts.backup.svg?style=flat-square)](https://travis-ci.org/Stouts/Stouts.backup)
+[![Galaxy](http://img.shields.io/badge/galaxy-Stouts.backup-blue.svg?style=flat-square)](https://galaxy.ansible.com/list#/roles/945)
+
+Ansible role which manage backups. Support file backups, postgresql, mysql, mongo db backups.
+
+
+## Variables
+
+The role variables and default values.
+
+```yaml
+backup_enabled: yes             # Enable the role
+backup_remove: no               # Set yes for uninstall the role from target system
+
+backup_user: root               # Run backups as user
+backup_group: "{{backup_user}}"
+
+backup_home: /etc/duply         # Backup configuration directory
+backup_work: /var/duply         # Working directory
+
+backup_duplicity_ppa: ppa:duplicity-team/ppa  # Set empty for skipping PPA addition
+backup_duplicity_pkg: duplicity
+backup_duplicity_version:       # Set duplicity version
+
+# Logging
+backup_logdir: /var/log/duply   # Place where logs will be keepped
+backup_logrotate: yes           # Setup logs rotation
+
+# Posgresql
+backup_postgres_user: postgres
+backup_postgres_host: ""
+
+# Mysql
+backup_mysql_user: mysql
+backup_mysql_pass: ""
+
+backup_profiles: []           # Setup backup profiles
+                              # Ex. backup_profiles:
+                              #       - name: www               # required param
+                              #         schedule: 0 0 * * 0     # if defined enabled cronjob
+                              #         source: /var/www
+                              #         max_age: 10D
+                              #         target: s3://my.bucket/www
+                              #         params:
+                              #           - "BEST_PASSWORD={{ best_password }}"
+                              #         exclude:
+                              #           - *.pyc
+                              #       - name: postgresql
+                              #         schedule: 0 4 * * *
+                              #         action: restore         # Choose action: backup/restore (default is backup)
+                              #         source: postgresql://db_name
+                              #         target: s3://my.bucket/postgresql
+
+# Default values (overide them in backup profiles bellow) 
+# =======================================================
+# (every value can be replaced in jobs individually)
+
+# GPG
+backup_gpg_key: disabled
+backup_gpg_pw: ""
+backup_gpg_opts: ''
+
+# TARGET
+# syntax is
+#   scheme://[user:password@]host[:port]/[/]path
+# probably one out of
+#   file://[/absolute_]path
+#   ftp[s]://user[:password]@other.host[:port]/some_dir
+#   hsi://user[:password]@other.host/some_dir
+#   cf+http://container_name
+#   imap[s]://user[:password]@host.com[/from_address_prefix]
+#   rsync://user[:password]@other.host[:port]::/module/some_dir
+#   rsync://user@other.host[:port]/relative_path
+#   rsync://user@other.host[:port]//absolute_path
+#   # for the s3 user/password are AWS_ACCESS_KEY_ID/AWS_SECRET_ACCESS_KEY
+#   s3://[user:password]@host/bucket_name[/prefix]
+#   s3+http://[user:password]@bucket_name[/prefix]
+#   ssh://user[:password]@other.host[:port]/some_dir
+#   tahoe://alias/directory
+#   webdav[s]://user[:password]@other.host/some_dir
+backup_target: 'file:///var/backup'
+# optionally the username/password can be defined as extra variables
+backup_target_user:
+backup_target_pass:
+
+# Time frame for old backups to keep, Used for the "purge" command.  
+# see duplicity man page, chapter TIME_FORMATS)
+backup_max_age: 1M
+
+# Number of full backups to keep. Used for the "purge-full" command. 
+# See duplicity man page, action "remove-all-but-n-full".
+backup_max_full_backups: 1
+
+# forces a full backup if last full backup reaches a specified age
+backup_full_max_age: 1M
+
+# set the size of backup chunks to VOLSIZE MB instead of the default 25MB.
+backup_volsize: 50
+
+# verbosity of output (error 0, warning 1-2, notice 3-4, info 5-8, debug 9)
+backup_verbosity: 3
+
+backup_exclude: [] # List of filemasks to exlude
+```
+
+## Usage
+
+Add `Stouts.backup` to your roles and set variables in your playbook file.
+
+Example:
+
+```yaml
+
+- hosts: all
+
+  roles:
+    - Stouts.backup
+
+  vars:
+    backup_target_user: aws_access_key
+    backup_target_pass: aws_secret
+    backup_profiles:
+
+    # Backup file path
+    - name: uploads                               # Required params
+        schedule: 0 3 * * *                       # At 3am every day
+        source: /usr/lib/project/uploads
+        target: s3://s3-eu-west-1.amazonaws.com/backup.backet/{{inventory_hostname}}/uploads
+
+    # Backup postgresql database
+    - name: postgresql
+        schedule: 0 4 * * *                       # At 4am every day
+        source: postgresql://project              # Backup prefixes: postgresql://, maysql://, mongo://
+        target: s3://s3-eu-west-1.amazonaws.com/backup.backet/{{inventory_hostname}}/postgresql
+        user: postgres
+
+```
+
+### Manage backups manually
+
+Run backup for profile `uploads` manually:
+
+    $ duply uploads backup
+
+Load backup for profile `postgresql` from cloud and restore database (logged as postgres user)
+
+    $ duply postgresql restore
+
+Also see `duply usage`
+
+
+## License
+
+Licensed under the MIT License. See the LICENSE file for details.
+
+## Feedback, bug-reports, requests, ...
+
+Are [welcome](https://github.com/Stouts/Stouts.backup/issues)!
+
+If you wish to express your appreciation for the role, you are welcome to send
+a postcard to:
+
+    Kirill Klenov
+    pos. Severny 8-3
+    MO, Istra, 143500
+    Russia

data/vendor/Stouts.backup/defaults/main.yml

@@ -0,0 +1,93 @@
+---
+
+backup_enabled: yes             # Enable the role
+backup_remove: no               # Set yes for uninstall the role from target system
+
+backup_user: root               # Run backups as user
+backup_group: "{{backup_user}}"
+
+backup_home: /etc/duply         # Backup configuration directory
+backup_work: /var/duply         # Working directory
+
+backup_duplicity_ppa: ppa:duplicity-team/ppa  # Set empty for skipping PPA addition
+backup_duplicity_pkg: duplicity
+backup_duplicity_version:       # Set duplicity version
+
+# Logging
+backup_logdir: /var/log/duply   # Place where logs will be keepped
+backup_logrotate: yes           # Setup logs rotation
+
+# Posgresql
+backup_postgres_user: postgres
+backup_postgres_host: ""
+backup_postgres_port: 5432
+
+# Mysql
+backup_mysql_user: mysql
+backup_mysql_pass: ""
+
+backup_profiles: []           # Setup backup profiles
+                              # Ex. backup_profiles:
+                              #       - name: www               # required param
+                              #         schedule: 0 0 * * 0     # if defined enabled cronjob
+                              #         source: /var/www
+                              #         max_age: 10D
+                              #         target: s3://my.bucket/www
+                              #         exclude:
+                              #           - *.pyc
+                              #       - name: postgresql
+                              #         schedule: 0 4 * * *
+                              #         action: restore         # Choose action: backup/restore (default is backup)
+                              #         source: postgresql://db_name
+                              #         target: s3://my.bucket/postgresql
+
+# Default values (overide them in backup profiles bellow) 
+# =======================================================
+# (every value can be replaced in jobs individually)
+
+# GPG
+backup_gpg_key: disabled
+backup_gpg_pw: ""
+backup_gpg_opts: ''
+
+# TARGET
+# syntax is
+#   scheme://[user:password@]host[:port]/[/]path
+# probably one out of
+#   file://[/absolute_]path
+#   ftp[s]://user[:password]@other.host[:port]/some_dir
+#   hsi://user[:password]@other.host/some_dir
+#   cf+http://container_name
+#   imap[s]://user[:password]@host.com[/from_address_prefix]
+#   rsync://user[:password]@other.host[:port]::/module/some_dir
+#   rsync://user@other.host[:port]/relative_path
+#   rsync://user@other.host[:port]//absolute_path
+#   # for the s3 user/password are AWS_ACCESS_KEY_ID/AWS_SECRET_ACCESS_KEY
+#   s3://[user:password]@host/bucket_name[/prefix]
+#   s3+http://[user:password]@bucket_name[/prefix]
+#   ssh://user[:password]@other.host[:port]/some_dir
+#   tahoe://alias/directory
+#   webdav[s]://user[:password]@other.host/some_dir
+backup_target: 'file:///var/backup'
+# optionally the username/password can be defined as extra variables
+backup_target_user:
+backup_target_pass:
+
+# Time frame for old backups to keep, Used for the "purge" command.  
+# see duplicity man page, chapter TIME_FORMATS)
+backup_max_age: 1M
+
+# Number of full backups to keep. Used for the "purge-full" command. 
+# See duplicity man page, action "remove-all-but-n-full".
+backup_max_full_backups: 1
+
+# forces a full backup if last full backup reaches a specified age
+backup_full_max_age: 1M
+
+# set the size of backup chunks to VOLSIZE MB instead of the default 25MB.
+backup_volsize: 50
+
+# verbosity of output (error 0, warning 1-2, notice 3-4, info 5-8, debug 9)
+backup_verbosity: 3
+
+backup_exclude: [] # List of filemasks to exlude

data/vendor/Stouts.backup/meta/.galaxy_install_info

@@ -0,0 +1 @@
+{install_date: 'Mon May 16 16:58:23 2016', version: 3.3.0}

data/vendor/Stouts.backup/meta/main.yml

@@ -0,0 +1,16 @@
+---
+
+dependencies: []
+
+galaxy_info:
+  author: klen
+  company: Stouts
+  description: Backup system. Files, dirs, databases. Upload to clouds.
+  license: MIT
+  platforms:
+  - name: Ubuntu
+    versions:
+    - all
+  categories:
+  - system
+  - cloud

data/vendor/Stouts.backup/tasks/backup.yml

@@ -0,0 +1,10 @@
+---
+
+- include: install.deb.yml
+  when: ansible_os_family == "Debian" and not backup_remove
+
+- include: configure.yml
+  when: not backup_remove
+
+- include: remove.yml
+  when: backup_remove

data/vendor/Stouts.backup/tasks/configure.yml

@@ -0,0 +1,53 @@
+---
+
+- name: backup-configure | Ensure for backup user is exists
+  user: name={{backup_user}}
+
+- name: backup-configure | Ensure for backup directories is exits
+  file: path={{item}} state=directory owner={{backup_user}} group={{backup_group}}
+  with_items:
+    - "{{backup_home}}"
+    - "{{backup_work}}"
+    - "{{backup_logdir}}"
+
+- name: backup-configure | Install duply
+  template: src=duply.sh.j2 dest=/usr/local/bin/duply owner={{backup_user}} group={{backup_group}} mode=0755
+
+- name: backup-configure | Create profile directories
+  file: path={{backup_home}}/{{item.name}} state=directory mode=0700 owner={{item.user|default(backup_user)}} group={{item.group|default(backup_group)}} 
+  with_items: backup_profiles
+
+- name: backup-configure | Configure profiles
+  template: src=conf.j2 dest={{backup_home}}/{{item.name}}/conf owner={{item.user|default(backup_user)}} group={{item.group|default(backup_group)}} 
+  with_items: backup_profiles
+
+- name: backup-configure | Configure exclude lists
+  template: src=exclude.j2 dest={{backup_home}}/{{item.name}}/exclude owner={{item.user|default(backup_user)}} group={{item.group|default(backup_group)}} 
+  with_items: backup_profiles
+
+- name: backup-configure | Configure pre scripts
+  template: src=pre.j2 dest={{backup_home}}/{{item.name}}/pre owner={{item.user|default(backup_user)}} group={{item.group|default(backup_group)}} 
+  with_items: backup_profiles
+
+- name: backup-configure | Configure post scripts
+  template: src=post.j2 dest={{backup_home}}/{{item.name}}/post owner={{item.user|default(backup_user)}} group={{item.group|default(backup_group)}} 
+  with_items: backup_profiles
+
+- name: backup-configure | Configure restore scripts
+  template: src=restore.j2 dest={{backup_home}}/{{item.name}}/restore owner={{item.user|default(backup_user)}} group={{item.group|default(backup_group)}} 
+  with_items: backup_profiles
+
+- name: backup-configure | Create work directories
+  file: state=directory path={{backup_work}}/{{item.name}} owner={{item.user|default(backup_user)}} group={{item.group|default(backup_group)}}  
+  with_items: backup_profiles
+
+- name: backup-configure | Setup cron
+  template: src=cron.j2 dest=/etc/cron.d/backup owner=root group=root mode=0644
+
+- name: backup-configure | Create log files
+  file: state=touch path={{backup_logdir}}/{{item.name}}.log owner={{item.user|default(backup_user)}} group={{item.group|default(backup_group)}}
+  with_items: backup_profiles
+  changed_when: False
+
+- name: backup-configure | Configure logrotate
+  template: src=logrotate.j2 dest=/etc/logrotate.d/backup owner=root group=root mode=0644

data/vendor/Stouts.backup/tasks/install.deb.yml

@@ -0,0 +1,19 @@
+---
+
+- name: Add duplicity ppa
+  apt_repository: repo='{{ backup_duplicity_ppa }}' update_cache=yes
+  when: backup_duplicity_ppa
+
+- name: Install dependencies
+  apt: pkg={{item}}
+  with_items:
+    - cron
+    - gzip
+    - python-boto
+    - s3cmd
+
+- set_fact: backup_duplicity_pkg="{{backup_duplicity_pkg}}={{backup_duplicity_version}}"
+  when: backup_duplicity_version
+
+- name: Install duplicity
+  apt: pkg={{backup_duplicity_pkg}}

data/vendor/Stouts.backup/tasks/main.yml

@@ -0,0 +1,5 @@
+---
+
+- include: backup.yml
+  when: backup_enabled
+  tags: [backup]

data/vendor/Stouts.backup/tasks/remove.yml

@@ -0,0 +1,12 @@
+---
+# Uninstall the role
+
+- name: Uninstall the role - pt. 1
+  file: state=absent path=/etc/cron.d/backup
+
+- name: Uninstall the role - pt. 2
+  file: state=absent path={{item}}
+  with_items:
+    - "{{backup_home}}"
+    - "{{backup_work}}"
+    - "{{backup_logdir}}"

data/vendor/Stouts.backup/templates/conf.j2

@@ -0,0 +1,78 @@
+# This file was generated by Ansible for {{ ansible_fqdn }}
+# Do NOT modify this file by hand!
+
+# Setting only a passphrase and omitting the GPG key
+# will enable symmetric passphrase-only encryption.
+{% if item.gpg_key|default(backup_gpg_key) == 'disabled' and item.gpg_pw|default(backup_gpg_pw) %}
+# GPG_KEY='{{ item.gpg_key|default(backup_gpg_key) }}'
+{% else %}
+GPG_KEY='{{ item.gpg_key|default(backup_gpg_key) }}'
+{% endif %}
+GPG_PW='{{ item.gpg_pw|default(backup_gpg_pw) }}'
+{% if item.gpg_keys_enc|default(None) %}
+GPG_KEYS_ENC='{{item.gpg_keys_enc}}'
+{% endif %}
+{% if item.gpg_key_sign|default(None) %}
+GPG_KEY_SIGN='{{item.gpg_key_sign}}'
+{% endif %}
+{% if item.gpg_pw_sign|default(None) %}
+GPG_PW_SIGN='{{item.gpg_pw_sign}}'
+{% endif %}
+GPG_OPTS='{{item.gpg_opts|default(backup_gpg_opts)}}'
+
+TARGET='{{item.target|default(backup_target)}}'
+
+{% if item.target_user|default(backup_target_user) %}
+TARGET_USER='{{item.target_user|default(backup_target_user)}}'
+{% endif %}
+{% if item.target_pass|default(backup_target_pass) %}
+TARGET_PASS='{{item.target_pass|default(backup_target_pass)}}'
+{% endif %}
+
+{% if item.source.startswith('postgresql://') or item.source.startswith('mysql://') or item.source.startswith('mongo://') %}
+SOURCE='{{backup_work}}/{{item.name}}/dump'
+{% else %}
+SOURCE='{{item.source|default(backup_source)}}'
+{% endif %}
+
+# Time frame for old backups to keep, Used for the "purge" command.  
+# see duplicity man page, chapter TIME_FORMATS)
+MAX_AGE='{{item.max_age|default(backup_max_age)}}'
+
+# Number of full backups to keep. Used for the "purge-full" command. 
+# See duplicity man page, action "remove-all-but-n-full".
+MAX_FULL_BACKUPS='{{item.max_full_backups|default(backup_max_full_backups)}}'
+
+VERBOSITY={{item.verbosity|default(backup_verbosity)}}
+
+# ARCH_DIR=/tmp/backup_{{item.name}}
+
+# activates duplicity --full-if-older-than option (since duplicity v0.4.4.RC3)
+# forces a full backup if last full backup reaches a specified age, for the
+# format of MAX_FULLBKP_AGE see duplicity man page, chapter TIME_FORMATS
+MAX_FULLBKP_AGE={{ item.full_max_age|default(backup_full_max_age) }}
+DUPL_PARAMS="$DUPL_PARAMS --full-if-older-than $MAX_FULLBKP_AGE "
+
+# sets duplicity --volsize option (available since v0.4.3.RC7)
+# set the size of backup chunks to VOLSIZE MB instead of the default 25MB.
+# VOLSIZE must be number of MB's to set the volume size to.
+VOLSIZE={{ item.volsize|default(backup_volsize) }}
+DUPL_PARAMS="$DUPL_PARAMS --volsize $VOLSIZE "
+
+# exclude folders containing exclusion file (since duplicity 0.5.14)
+# Uncomment the following two lines to enable this setting.
+#FILENAME='.duplicity-ignore'
+#DUPL_PARAMS="$DUPL_PARAMS --exclude-if-present '$FILENAME'"
+
+# Add params needed for target or backup process.
+{% for param in item.params|default([]) %}
+{{ param }}
+{% endfor %}
+
+# temporary file space. at least the size of the biggest file in backup
+# for a successful restoration process. (default is '/tmp', if not set)
+#TEMP_DIR=/tmp
+
+# more duplicity command line options can be added in the following way
+# don't forget to leave a separating space char at the end
+#DUPL_PARAMS="$DUPL_PARAMS --put_your_options_here "

data/vendor/Stouts.backup/templates/cron.j2

@@ -0,0 +1,10 @@
+# This file was generated by Ansible for {{ ansible_fqdn }}
+# Do NOT modify this file by hand!
+
+# Run backups
+{% for profile in backup_profiles %}
+{% if profile.schedule|default(None) %}
+{{profile.schedule}} {{profile.user|default(backup_user)}} /usr/local/bin/duply {{backup_home}}/{{profile.name}} {{profile.action|default('backup')}} >> {{backup_logdir}}/{{profile.name}}.log 2>&1
+{% endif %}
+{% endfor %}
+