Ansible Rolle: restic

Beta: Diese Rolle ist im Beta-Stadium.

Beschreibung

Restic ist eine vielseitige Backup-Lösung, die in Go entwickelt wurde. Sie unterstützt mehrere Backends, Daten-Deduplizierung und inkrementelle Backups.

Diese Rolle installiert restic auf einem Client, konfiguriert die Backup-Repositories und optionale systemd-Timer oder Cronjobs, um die Backups auszuführen. Zusätzlich werden ausführbare Skripte eingerichtet, um ein Backup manuell durchzuführen.

Dieses Projekt basiert stark auf den Rollen donat-b/ansible-restic und arillso/ansible.restic. Wir versuchen, diese Rolle einfach zu verstehen und modern zu gestalten, indem wir systemd-Timer und /etc/crontab zur Definition der Backup-Pfade verwenden, mehr absolute Pfade und weniger Optionen implementieren. (Nicht getestet für S3-Speicher oder Windows...)

Backup-Skripte

Diese Rolle erstellt ein Backup-Skript und eine Datei mit Anmeldedaten, die mit dem source-Befehl unter Linux für jedes Backup im restic_script_dir verwendet werden können. Diese ausführbaren Skripte können manuell verwendet werden, um eine Backup-Aktion auszulösen, werden aber auch für automatische Backups verwendet, wenn Sie die Variable restic_create_schedule auf true setzen. Stellen Sie sicher, dass Sie die Dateien nicht manuell bearbeiten, da dies Ihre Backups stören kann.

Unter Linux können Sie ein manuelles Snapshot so ausführen:

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

Standardmäßig erhält ein solches Snapshot das Tag manual, damit Sie es von automatisch erstellten Snapshots unterscheiden können. Sie können auch weitere Tags hinzufügen, indem Sie sie einfach anhängen:

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

CRON / Geplante Aufgaben

Um die definierten Backups zu nutzen, können sie automatisch als geplante Aufgaben eingerichtet werden. Sie müssen sich bewusst sein, dass (zumindest auf Linux-Systemen) Administratorrechte erforderlich sind, um eine solche Aktion zu konfigurieren.

Wenn Sie die automatische Erstellung der Aufgaben nicht nutzen können, können Sie dennoch die generierten Skripte verwenden. Wenn Sie beispielsweise auf einem Shared-Hosting-Server sind und einen Cronjob über eine Weboberfläche definieren können, fügen Sie einfach jede Backup-Datei hinzu, die ausgeführt werden soll. Achten Sie darauf, den Befehl mit CRON=true zu beginnen, um anzuzeigen, dass das Snapshot über eine geplante Aufgabe erstellt wurde:

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

Installation

Es gibt mehrere Möglichkeiten, die Rolle zu installieren. Entweder klonen oder laden Sie sie direkt aus dem GitHub-Repository herunter oder installieren Sie sie über Ansible Galaxy:

ansible-galaxy install roles-ansible.restic

Anforderungen

• bzip2

Rollenvariablen

Repos

Restic speichert Daten in Repositories. Sie müssen mindestens ein Repository angeben, um diese Rolle verwenden zu können. Ein Repository kann lokal oder remote sein (siehe die offizielle Dokumentation).

Verwendung eines SFTP-Repositorys

Zum Einsatz eines SFTP-Backends benötigt der Benutzer passwortlosen Zugriff auf den Host. Bitte stellen Sie sicher, dass Sie die SSH-Schlüssel entsprechend verteilen, da dies außerhalb des Geltungsbereichs dieser Rolle liegt.

Verfügbare Variablen:

Beispiel:

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
    # Nur einer der folgenden ist erforderlich
    azure_account_key: somekey
    azure_account_sas: sasurl
    # Optional
    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

Backups

Ein Backup legt ein Verzeichnis oder eine Datei fest, die gesichert werden soll. Ein Backup wird in einem Repository gespeichert, das in restic_repos definiert ist.

Verfügbare Variablen:

Beispiel:

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

Sie können auch restic_backups als Array angeben, was ein veraltetes Merkmal ist und in Zukunft möglicherweise nicht mehr unterstützt wird. Derzeit wird der Name-Schlüssel verwendet, um den Zugriff und die Backup-Dateien zu benennen.

Ausschließen

Der exclude-Schlüssel bei einem Backup ermöglicht es Ihnen, mehrere Dateien anzugeben, die ausgeschlossen oder nach Dateinamen gesucht werden sollen, um ausgeschlossen zu werden. Sie können die folgenden Schlüssel angeben:

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

Bitte beziehen Sie sich auf die Verwendung der spezifischen Schlüssel in der Dokumentation.

Abhängigkeiten

Diese Rolle hat keine anderen Ansible-Rollen als Abhängigkeiten.

Beispiel-Playbook

- name: Sichern Sie Ihre Home-Verzeichnisse nach /mnt/backup jede Nacht
  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'

Lizenz

Dieses Projekt steht unter der MIT-Lizenz. Siehe die LICENSE Datei für den vollständigen Lizenztext.