Ansible Role: restic

Beta: This role is in beta status.

Description

Restic is a versatile Go based backup solution which supports multiple backends, deduplication and incremental backups.

This role installs Restic on a client, configures the backup repositories and optionally sets up cronjobs to run said backups. Aditionally, it will setup executable scripts to run a Backup manually.

This Project borrows heavily from the donat-b/ansible-restic ansible role. We try to make this role more server deployment friendly by allowing to use version tags and keep these snapshots and adapting the automated backup definition for use with windows systems.

Backup Scripts

This role will create a backup script and a file with credentials usable with the source command on Linux for each backup in the restic_script_dir. These executable scripts can be used to manually trigger a backup action, but are also used for automated backups if you have set restic_create_cron to true.

By default, this role will use the Jinja template file located at templates/restic_script_Linux.j2 to construct the backup script. However, if you wish to customize it further, you may override the template and set therestic_backup_script_template variable to a path to your own template file.

On Linux, if you want to take a manual snapshot, you can run the backup like this:

$ /path/to/backup/script/backup-example.sh

By default, such a snapshot will be given the tag manual, so you can distinguish them from automatically created snapshots. You can also append more tags by simply appending them:

$ /path/to/backup/script/backup-example.sh --tag deployment

CRON / Scheduled Tasks

In order to make use of defined backups, they can be automatically setup as scheduled tasks. You have to be aware of the fact that (on linux systems at least) you need to have administrator permissions for configuring such an action.

If you cannot use the automatic creation of the tasks, you can still make use of the generated scripts. If you are for example on a shared hosting server and can define a cronjob via a webinterface, simply add each backup file to be executed. Make sure to prefix the command with CRON=true to imply that the snapshot was created via a scheduled task:

CRON=true /path/to/backup/script/backup-example.sh

Installation

ansible-galaxy install arillso.restic

Requirements

• bzip2

  Role Variables

Name	Default	Description
restic_url	undefined	The URL to download restic from. Use this variable to overwrite the default
restic_version	'0.12.0'	The version of Restic to install
restic_download_path	'/opt/restic'	Download location for the restic binary
restic_install_path	'/usr/bin'	Install location for the restic binary
restic_script_dir	'~/restic'	Location of the generated backup scripts
restic_log_dir	'{{ restic_script_dir }}/log'	Location of the logs of the backup scripts
restic_repos	{}	A dictionary of repositories where snapshots are stored
restic_backups	{} (or [])	A list of dictionaries specifying the files and directories to be backed up
restic_create_cron	false	Should a cronjob be created for each backup
restic_dir_owner	'{{ansible_user}}'	The owner of all created dirs
restic_dir_group	'{{ansible_user}}'	The group of all created dirs
restic_backup_script_template	restic_script_Linux.j2	The path to the Jinja template file to use for the backup script

Repos

Restic stores data in repositories. You have to specify at least one repository to be able to use this role. A repository can be local or remote (see the official documentation).

Using an SFTP repository

For using an SFTP backend, the user needs passwordless access to the host. Please make sure to distribute ssh keys accordingly, as this is outside of the scope of this role.

Available variables:

Name	Required	Description
location	yes	The location of the Backend. Currently, Local, SFTP, S3 and B2 are supported
password	yes	The password used to secure this repository
init	no	Describes if the repository should be initialized or not. Use false if you are backuping to an already existing repo.
aws_access_key	no	The access key for the S3 backend
aws_secret_access_key	no	The secret access key for the S3 backend
aws_default_region	no	The desired region for the S3 backend
b2_account_id	no	The account ID for Backblaze B2 backend
b2_account_key	no	The account key for Backblaze B2 backend

Example:

restic_repos:
  local:
    location: /srv/restic-repo
    password: securepassword1
    init: true
  remote:
    location: sftp:user@host:/srv/restic-repo
    password: securepassword2
    init: true

Backups

A backup specifies a directory or file to be backuped. A backup is written to a Repository defined in restic_repos.

Available variables:

Name	Required (Default)	Description
name	yes	The name of this backup. Used together with pruning and scheduling and needs to be unique.
repo	yes	The name of the repository to backup to.
src	yes	The source directory or file
stdin	no	Is this backup created from a stdin?
stdin_cmd	no (yes if stdin == true)	The command to produce the stdin.
stdin_filename	no	The filename used in the repository.
tags	no	Array of default tags
keep_last	no	If set, only keeps the last n snapshots.
keep_hourly	no	If set, only keeps the last n hourly snapshots.
keep_daily	no	If set, only keeps the last n daily snapshots.
keep_weekly	no	If set, only keeps the last n weekly snapshots.
keep_monthly	no	If set, only keeps the last n monthly snapshots.
keep_yearly	no	If set, only keeps the last n yearly snapshots.
keep_within	no	If set, only keeps snapshots in this time period.
keep_tag	no	If set, keep snapshots with this tags. Make sure to specify a list.
prune	no (false)	If true, the restic forget command in the script has the --prune option appended.
scheduled	no (false)	If restic_create_cron is set to true, this backup is scheduled.
schedule_minute	no (*)	Minute when the job is run. ( 0-59, *, */2, etc )
schedule_hour	no (*)	Hour when the job is run. ( 0-23, *, */2, etc )
schedule_weekday	no (*)	Weekday when the job is run. ( 0-6 for Sunday-Saturday, *, etc )
schedule_month	no (*)	Month when the job is run. ( 1-12, *, */2, etc )
exclude	no ({})	Allows you to specify files to exclude. See Exclude for reference.

Example:

restic_backups:
  data:
    name: data
    repo: remote
    src: /path/to/data
    scheduled: true
    schedule_hour: 3

You can also specify restic_backups as an array, which is a legacy feature and might be deprecated in the future. currently, the name key is used for naming the access and backup files

Exclude

the exclude key on a backup allows you to specify multiple files to exclude or files to look for filenames to be excluded. You can specify the following keys:

exclude:
    exclude_cache: true
    exclude:
        - /path/to/file
    iexclude:
        - /path/to/file
    exclude_file:
        - /path/to/file
    exclude_if_present:
        - /path/to/file

Please refer to the use of the specific keys to the documentation.

Dependencies

none

Example Playbook

- hosts: all
  roles:
    - restic

Author

• Matthias Leutenegger

License

This project is under the MIT License. See the LICENSE file for the full license text.

Copyright

(c) 2019, Arillso