vrischmann/ansible-restic

Role to deploy restic using systemd services and timers

Restic

Deploy restic backups using systemd services and timers.

This role has two modes:

• user which adds user-wide services and timers (for your normal user).
• server which adds system-wide services and timers.

Requirements

You need restic installed and your repositories already initialized.

Role Variables

Name	Required	Description
restic_binary	no	Full path of the restic binary.
restic_backup_mode	yes	Backup mode (either "user" or "server").
restic_user_home	no	Home directory of the user (if running in "user" mode).
restic_user_name	no	Name of the user (if running in "user" mode).
restic_user_group	no	Group of the user (if running in "user" mode).
restic_backups	yes	List of backup definitions for restic.
restic_conf_directory	no	Configuration directory (if running in "server" mode).

Backup definition

The restic_backups list contains N items defining the backups.

Each backup definition must contain the following information:

• The name of the repository (used for the systemd services: only use alphanumeric characters)
• The environment variables for restic to use the repository
• The calendar spec for the systemd timer.
• The directories to backup

It can also contain a list of directories to exclude.

For example this defines two repositories:

restic_backups:
  - name: remote-scaleway
    env:
      AWS_ACCESS_KEY_ID: "{{ restic_scaleway_aws_access_key_id }}"
      AWS_SECRET_ACCESS_KEY: "{{ restic_scaleway_aws_secret_access_key }}"
      RESTIC_REPOSITORY: "s3:s3.fr-par.scw.cloud/foobar/home"
      RESTIC_PASSWORD: "{{ restic_remote_password }}"
    calendar_spec: "*-*-* *:00/15:00"
    backup_directories:
      - /home/vincent
    excludes:
      - /home/vincent/tmp

  - name: remote-linode
    env:
      AWS_ACCESS_KEY_ID: "{{ restic_linode_aws_access_key_id }}"
      AWS_SECRET_ACCESS_KEY: "{{ restic_linode_aws_secret_access_key }}"
      RESTIC_REPOSITORY: "s3:eu-central-1.linodeobjects.com/foobar/barbaz"
      RESTIC_PASSWORD: "{{ restic_remote_password }}"
    calendar_spec: "*-*-* *:00/15:00"
    backup_directories:
      - /data/media
    excludes:
      - /data/media/Movies

License

MIT