Ansible Rola: restic

Beta: Ta rola jest w fazie beta.

Opis

Restic to wszechstronne rozwiązanie do tworzenia kopii zapasowych oparte na Go, które obsługuje różne backendy, deduplikację i przyrostowe kopie zapasowe.

Ta rola instaluje restic na kliencie, konfiguruje repozytoria kopii zapasowych i opcjonalnie ustawia timer systemd lub zadania cron do uruchamiania kopii zapasowych. Dodatkowo, tworzy skrypty wykonywalne do ręcznego uruchamiania kopii zapasowej.

Ten projekt czerpał inspirację z donat-b/ansible-restic i https://github.com/arillso/ansible.restic roli ansible. Staramy się uczynić tę rolę bardziej zrozumiałą i nowoczesną, używając timera systemd, /etc/crontab do definiowania ścieżek kopii zapasowej, więcej absolutnych ścieżek i mniej opcji. (nie testowane dla przechowywania S3 lub Windows...)

Skrypty Kopii Zapasowej

Ta rola utworzy skrypt kopii zapasowej i plik z danymi logowania, które można użyć z komendą source w systemie Linux dla każdej kopii zapasowej w katalogu restic_script_dir. Te wykonywalne skrypty mogą być używane do ręcznego wywołania akcji kopii zapasowej, ale są także używane do automatycznych kopii zapasowych, jeśli zmienna restic_create_schedule jest ustawiona na true. Upewnij się, że nie zmieniasz plików ręcznie, ponieważ może to znacznie zakłócić twoje kopie zapasowe.

W systemie Linux, jeśli chcesz zrobić ręczny zrzut, możesz uruchomić kopię zapasową w ten sposób:

$ /ścieżka/do/skryptu/kopia-zapasowa-przykład.sh

Domyślnie taki zrzut będzie mieć tag manual, więc możesz je odróżnić od automatycznie utworzonych zrzutów. Możesz również dodać więcej tagów, po prostu je dołączając:

$ /ścieżka/do/skryptu/kopia-zapasowa-przykład.sh --tag deployment

ZADANIA CRON / Zaplanowane

Aby korzystać z zdefiniowanych kopii, można je automatycznie ustawić jako zadania zaplanowane. Musisz być świadomy tego, że (na systemach Linux przynajmniej) musisz mieć uprawnienia administratora do skonfigurowania takiej akcji.

Jeśli nie możesz użyć automatycznego tworzenia zadań, nadal możesz korzystać z wygenerowanych skryptów. Na przykład, jeśli jesteś na serwerze hostingu współdzielonego i możesz zdefiniować zadanie cron przez interfejs internetowy, po prostu dodaj każdy plik kopii do wykonania. Upewnij się, że przed poleceniem dodajesz CRON=true, aby zasugerować, że zrzut został utworzony za pośrednictwem zadania zaplanowanego:

CRON=true /ścieżka/do/skryptu/kopia-zapasowa-przykład.sh

Instalacja

Jest kilka sposobów na zainstalowanie roli. Możesz sklonować lub pobrać ją bezpośrednio z repozytorium github. Możesz także zainstalować ją za pośrednictwem ansible galaxy:

ansible-galaxy install roles-ansible.restic

Wymagania

• bzip2

Zmienne Roli

Repozytoria

Restic przechowuje dane w repozytoriach. Musisz określić co najmniej jedno repozytorium, aby móc używać tej roli. Repozytorium może być lokalne lub zdalne (patrz oficjalna dokumentacja).

Korzystając z repozytorium SFTP

Aby używać zaplecza SFTP, użytkownik musi mieć bezhasłowy dostęp do hosta. Upewnij się, że odpowiednio rozprowadziłeś klucze ssh, ponieważ to wykracza poza zakres tej roli.

Dostępne zmienne:

Przykład:

restic_repos:
  lokalne:
    location: /srv/restic-repo
    password: securepassword0
    init: true
  zdalne:
    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/nazwa_bucketu
    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: nazwa_konta_storage
    azure_account_key: somekey
    azure_account_sas: sasurl
    azure_endpoint_suffix: core.windows.net
  b2:
    location: b2:nazwa_bucketu:ścieżka/do/repo
    password: securepassword5
    init: true
    b2_account_id: accountid
    b2_account_key: accountkey

Kopie Zapasowe

Kopia zapasowa określa katalog lub plik do zrobienia kopii zapasowej. Kopia zapasowa jest zapisywana w repozytorium zdefiniowanym w restic_repos.

Dostępne zmienne:

Przykład:

restic_backups:
  dane:
    name: dane
    repo: zdalne
    src: /path/to/data
    scheduled: true
    schedule_oncalendar: '*-*-* 01:00:00'
  baza_danych:
    name: baza_danych
    repo: zdalne
    stdin: true
    stdin_cmd: pg_dump -Ubackup nazwa_bazy
    stdin_filename: zrzut_bazy_danych.sql
    scheduled: true
    schedule_oncalendar: '*-*-* 01:30:00'
    niceness: 10
  wszystkie_bazy:
    name: wszystkie_bazy
    repo: zdalne
    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

Możesz również określić restic_backups jako tablicę, co jest funkcją przestarzałą i może być wycofana w przyszłości. obecnie, klucz name jest używany do nazwania dostępu i plików kopii zapasowej.

Wykluczenie

klucz exclude w kopii zapasowej pozwala określić wiele plików do wykluczenia lub plików, dla których można szukać nazw plików do wykluczenia. Możesz określić następujące klucze:

exclude:
    exclude_caches: true
    exclude:
        - /ścieżka/do/pliku
    iexclude:
        - /ścieżka/do/pliku
    exclude_file:
        - /ścieżka/do/pliku
    exclude_if_present:
        - /ścieżka/do/pliku

Proszę odwołać się do użycia konkretnych kluczy w dokumentacji.

Zależności

Ta rola nie ma innych ról ansible jako zależności.

Przykład Playbooka

- name: kopia zapasowa twoich folderów domowych do /mnt/backup codziennie w nocy
  hosts: localhost
  roles:
    - {role: do1jlr.restic, tags: restic}
  vars:
    restic_create_schedule: true
    restic_repos:
      lokalne:
        location: '/mnt/backup'
        password: 'ChangM3'
        init: true
    restic_backups:
      home:
        name: home
        repo: lokalne
        src: /home/
        scheduled: true
        schedule_oncalendar: '*-*-* 01:00:00'

Licencja

Ten projekt jest objęty licencją MIT. Zobacz plik LICENSE dla pełnego tekstu licencji.