Ansible роль "papanito.borg"

Ansible роль для установки и настройки регулярных резервных копий с помощью borg. Роль выполняет следующие действия:

• [Необязательно] Удаление существующего репозитория

• Инициализация репозитория по адресу protocol://backup_server:target_dir или target_dir

  Примечания

  Если репозиторий target_dir уже существует, инициализация будет пропущена. Если backup_server не указан, роль предполагает локальное резервное копирование, то есть в локальную директорию.

• Создание службы systemd, которая регулярно (в соответствии с backup_schedule) запускает скрипт borg.sh с borgbackup.org.

• Будет создан индивидуальный скрипт borg с именем automatic-backup-{{service_name}}.sh в /opt/borg_backup, который настраивается с:

  • backup_source_dir
  • backup_exclude_file или backup_exclude_list
  • backup_schedule

Требования

Нет

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

Это все переменные

Следующие параметры связаны с файлом службы systemd:

Скрипт, который разворачивается, также определяет параметры для prune, как описано в borg prune. Если ожидается число, но переменная не определена, параметр не предоставляется.

Чтобы скрыть конфиденциальную информацию, я рекомендую использовать ansible-vault.

Вы можете определить файл пароля в ansible.cfg, чтобы не указывать параметры шифрования. Таким образом, зашифрованную переменную backup_encryption_key можно создать следующим образом:

ansible-vault encrypt_string 'SupersecretPa$$phrase' --name 'backup_encryption_key'

Зависимости

Нет

Примеры

Пример плейбука для удаленного резервного копирования

Включение примера того, как использовать вашу роль (например, с переменными в качестве параметров) всегда полезно для пользователей:

- hosts: localhost
  vars:
  - backup_server: borg.intra
  - backup_user: borguser
  - backup_name: mybackupname
  - backup_encryption_key: test
  - backup_port: 23
  - target_dir: "/var/backups/"
  - backup_schedule: "*-*-* 03:00:00"
  - backup_exclude_list:
    - "*/Downloads"
    - "*/google-chrome*"
  - backup_include_list:
    - /home/papanito
  - backup_prune_keep_daily: 7
  - backup_prune_keep_weekly: 5
  - backup_prune_keep_monthly: 6
  - backup_prune_keep_yearly: 1
  
  roles:
  - role: papanito.borg

Это создаст резервную копию по адресу ssh://[email protected]:/var/backup/mybackupname и следующие файлы systemd:

• /opt/borg_backup/automatic-backup-mybackupname-borg.intra.sh (скрипт резервного копирования)
• /etc/systemd/system/automatic-backup-mybackupname-borg.intra.service (файл службы systemd)
• /etc/systemd/system/automatic-backup-mybackupname-borg.intra.timer (файл таймеров systemd)

Пример плейбука для локального резервного копирования

Включение примера того, как использовать вашу роль (например, с переменными в качестве параметров) всегда полезно для пользователей:

- hosts: localhost
  vars:
  - backup_name: mybackupname
  - backup_encryption_key: test
  - target_dir: "/var/backup/"
  - backup_schedule: "*-*-* 03:00:00"
  - backup_exclude_list:
    - "*/Downloads"
    - "*/google-chrome*"
  - backup_include_list:
    - /home/papanito
  - backup_prune_keep_daily: 7
  - backup_prune_keep_weekly: 5
  - backup_prune_keep_monthly: 6
  - backup_prune_keep_yearly: 1

Это создаст резервную копию по адресу /var/backup/mybackupname и следующие файлы systemd:

• /opt/borg_backups/automatic-backup-mybackupname-local.sh (скрипт резервного копирования)
• /etc/systemd/system/automatic-backup-mybackupname-local.service (файл службы systemd)
• /etc/systemd/system/automatic-backup-mybackupname-local.timer (файл таймеров systemd)

Лицензия

Это свободное программное обеспечение, выпущенное на условиях лицензии Apache v2.

Информация об авторе

Написано Papanito - Gitlab / Github