Ansible Rôle : restic

Bêta : Ce rôle est en statut bêta.

Description

Restic est une solution de sauvegarde polyvalente basée sur Go, qui prend en charge plusieurs systèmes de stockage, la déduplication et les sauvegardes incrémentielles.

Ce rôle installe restic sur un client, configure les dépôts de sauvegarde et, en option, configure un timer systemd ou des cronjobs pour exécuter les sauvegardes. De plus, il met en place des scripts exécutables pour effectuer une sauvegarde manuellement.

Ce projet s'inspire fortement de donat-b/ansible-restic et https://github.com/arillso/ansible.restic. Nous essayons de rendre ce rôle plus facile à comprendre et moderne en utilisant un timer systemd, /etc/crontab pour définir les chemins de sauvegarde, des chemins plus absolus et moins d'options. (non testé pour le stockage S3 ou Windows...)

Scripts de sauvegarde

Ce rôle créera un script de sauvegarde et un fichier avec des identifiants que vous pourrez utiliser avec la commande source sur Linux pour chaque sauvegarde dans le répertoire restic_script_dir. Ces scripts exécutables peuvent être utilisés pour déclencher manuellement une action de sauvegarde, mais sont également utilisés pour des sauvegardes automatisées si vous avez défini la variable restic_create_schedule sur true. Assurez-vous de ne pas modifier les fichiers manuellement, car cela peut interférer avec vos sauvegardes.

Sous Linux, si vous souhaitez effectuer un instantané manuel, vous pouvez exécuter la sauvegarde ainsi :

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

Par défaut, un tel instantané sera donné le tag manual, vous permettant de les distinguer des instantanés créés automatiquement. Vous pouvez également ajouter d'autres tags en les ajoutant simplement :

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

CRON / Tâches programmées

Pour utiliser les sauvegardes définies, elles peuvent être configurées automatiquement comme des tâches programmées. Vous devez être conscient du fait que (sur les systèmes Linux au moins) vous devez avoir des permissions d'administrateur pour configurer une telle action.

Si vous ne pouvez pas utiliser la création automatique des tâches, vous pouvez toujours utiliser les scripts générés. Si vous êtes, par exemple, sur un serveur d'hébergement partagé et que vous pouvez définir une cronjob via une interface web, ajoutez simplement chaque fichier de sauvegarde à exécuter. Assurez-vous de préfixer la commande avec CRON=true pour indiquer que l'instantané a été créé via une tâche programmée :

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

Installation

Il existe plusieurs façons d'installer le rôle. Soit vous le clonez ou le téléchargez directement depuis le dépôt GitHub. Ou installez-le via ansible galaxy :

ansible-galaxy install roles-ansible.restic

Exigences

• bzip2

Variables du rôle

Repos

Restic stocke les données dans des dépôts. Vous devez spécifier au moins un dépôt pour pouvoir utiliser ce rôle. Un dépôt peut être local ou distant (voir la documentation officielle).

Utilisation d'un dépôt SFTP

Pour utiliser un backend SFTP, l'utilisateur doit avoir un accès sans mot de passe à l'hôte. Veuillez vous assurer de distribuer les clés SSH en conséquence, car cela est en dehors du cadre de ce rôle.

Variables disponibles :

Exemple :

restic_repos:
  local:
    location: /srv/restic-repo
    password: securepassword0
    init: true
  remote:
    location: rest:https://restic_rest_server.example.com:8000/restic-repo/
    password: securepassword1
    init: true
  sftp:
    location: sftp:user@host:/srv/restic-repo
    password: securepassword2
    init: true
  aws:
    location: s3:s3.amazonaws.com/bucket_name
    password: securepassword3
    init: true
    aws_access_key: accesskey
    aws_secret_access_key: secretaccesskey
    aws_default_region: eu-west-1
  azure:
    location: azure:container:/
    password: securepassword4
    init: true
    azure_account_name: storageaccountname
    # Un seul des éléments suivants est requis
    azure_account_key: somekey
    azure_account_sas: sasurl
    # Optionnel
    azure_endpoint_suffix: core.windows.net
  b2:
    location: b2:bucketname:path/to/repo
    password: securepassword5
    init: true
    b2_account_id: accountid
    b2_account_key: accountkey

Sauvegardes

Une sauvegarde spécifie un répertoire ou un fichier à sauvegarder. Une sauvegarde est écrite dans un dépôt défini dans restic_repos.

Variables disponibles :

Exemple :

restic_backups:
  data:
    name: data
    repo: remote
    src: /path/to/data
    scheduled: true
    schedule_oncalendar: '*-*-* 01:00:00'
  database:
    name: database
    repo: remote
    stdin: true
    stdin_cmd: pg_dump -Ubackup db_name
    stdin_filename: db_name_dump.sql
    scheduled: true
    schedule_oncalendar: '*-*-* 01:30:00'
    niceness: 10
  all_databases:
    name: all_databases
    repo: remote
    src: /var/dumped_data
    scheduled: true
    schedule_oncalendar: '*-*-* 02:00:00'
    pre_backup_cmd: cd /var/dumped_data && mariadb -N -e 'show databases' | while read dbname; do mariadb-dump --complete-insert --routines --triggers --single-transaction "$dbname" > "$dbname".sql; done

Vous pouvez également spécifier restic_backups comme un tableau, ce qui est une fonctionnalité héritée et pourrait être obsolète à l'avenir. Actuellement, la clé nom est utilisée pour nommer les fichiers d'accès et de sauvegarde.

Exclure

La clé exclude sur une sauvegarde vous permet de spécifier plusieurs fichiers à exclure ou des fichiers à rechercher pour des noms à exclure. Vous pouvez spécifier les clés suivantes :

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

Veuillez vous référer à l'utilisation des clés spécifiques dans la documentation.

Dépendances

Ce rôle n'a pas d'autres rôles ansible comme dépendance.

Exemple de Playbook

- name: sauvegarder vos dossiers personnels vers /mnt/backup chaque nuit
  hosts: localhost
  roles:
    - {role: do1jlr.restic, tags: restic}
  vars:
    restic_create_schedule: true
    restic_repos:
      local:
        location: '/mnt/backup'
        password: 'ChangM3'
        init: true
    restic_backups:
      home:
        name: home
        repo: local
        src: /home/
        scheduled: true
        schedule_oncalendar: '*-*-* 01:00:00'

Licence

Ce projet est sous la licence MIT. Voir le fichier LICENSE pour le texte complet de la licence.