Ansible Роль: restic

Бета: Эта роль находится на бета-стадии.

Описание

Restic — это универсальное решение для резервного копирования на основе Go, поддерживающее множество хранилищ, дедупликацию и инкрементные резервные копии.

Эта роль устанавливает restic на клиенте, настраивает репозитории для резервного копирования и при необходимости устанавливает таймер systemd или cron для выполнения резервного копирования. Кроме того, она создает исполняемые скрипты для ручного запуска резервного копирования.

Этот проект заимствовал много идей из donat-b/ansible-restic и https://github.com/arillso/ansible.restic. Мы стараемся сделать эту роль более понятной и современной, используя таймер systemd, /etc/crontab для определения путей резервного копирования, больше абсолютных путей и меньше параметров. (не тестировалось для S3 Storage или Windows...)

Скрипты резервного копирования

Эта роль создаст скрипт резервного копирования и файл с учетными данными, которые можно использовать с командой source в Linux для каждого резервного копирования в restic_script_dir. Эти исполняемые скрипты можно использовать для ручного запуска резервного копирования, но они также используются для автоматизированных резервных копий, если вы установите переменную restic_create_schedule в true. Убедитесь, что вы не изменяете файлы вручную, так как это может нарушить процесс резервного копирования.

В Linux, если вы хотите сделать ручной снимок, вы можете запустить резервное копирование так:

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

По умолчанию такой снимок будет иметь тег manual, чтобы вы могли отличить его от автоматически созданных снимков. Вы также можете добавить дополнительные теги, просто добавив их:

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

CRON / Запланированные задачи

Чтобы использовать определенные резервные копии, их можно автоматически установить как запланированные задачи. Вам нужно быть в курсе, что (по крайней мере, на системах Linux) вам нужны права администратора для настройки такого действия.

Если вы не можете использовать автоматическое создание задач, вы все равно можете использовать сгенерированные скрипты. Например, если вы находитесь на общем хостинге и можете задать cronjob через веб-интерфейс, просто добавьте каждый файл резервного копирования для выполнения. Убедитесь, что вы добавили CRON=true перед командой, чтобы указать, что снимок был создан через запланированную задачу:

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

Установка

Существует несколько способов установки роли. Либо клонируйте или загрузите ее напрямую из репозитория github. Либо установите ее через ansible galaxy:

ansible-galaxy install roles-ansible.restic

Требования

• bzip2

Переменные роли

Репозитории

Restic хранит данные в репозиториях. Вы должны указать как минимум один репозиторий, чтобы иметь возможность использовать эту роль. Репозиторий может быть локальным или удаленным (см. официальную документацию).

Использование репозитория SFTP

Для использования бэкенда SFTP пользователь должен иметь доступ без пароля к хосту. Убедитесь, что ключи ssh распространены соответствующим образом, так как это выходит за рамки данной роли.

Доступные переменные:

Пример:

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
    # Только один из следующих параметров требуется
    azure_account_key: somekey
    azure_account_sas: sasurl
    # Опционально
    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

Резервное копирование

Резервное копирование указывает директорию или файл, который нужно сохранить. Резервная копия записывается в репозиторий, определенный в restic_repos.

Доступные переменные:

Пример:

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

Вы также можете указать restic_backups как массив, что является устаревшей функцией и может быть удалено в будущем. в настоящее время ключ name используется для наименования доступа и файлов резервного копирования.

Исключение

Ключ exclude в резервной копии позволяет вам указать несколько файлов для исключения или файлы, которые нужно искать для имен файлов, которые необходимо исключить. Вы можете указать следующие ключи:

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

Пожалуйста, обратитесь к использованию конкретных ключей в документации.

Зависимости

Эта роль не имеет других зависимостей от других ролей ansible.

Пример документа

- name: резервное копирование ваших домашних папок на /mnt/backup каждую ночь
  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'

Лицензия

Этот проект имеет лицензию MIT. См. файл LICENSE для полного текста лицензии.