DEBOPS.BACKUP2L(5)

NAME
debops.backup2l - Manage backup2l script using Ansible

SYNOPSIS

debops service/backup2l [--limit group,host,...] [--diff] [--check] [--tags tag1,tag2,...] [--skip-tags tag1,tag2,...] [<ansible-playbook options>] ...

DESCRIPTION

The debops.backup2l role manages the backup2l <https://github.com/gkiefer/backup2l> (backup tool) script. This script can be used to make automated, incremental archives of a given host which can be copied to another system as a backup.

GETTING STARTED

  Default configuration

By default the backups are maintained in the /var/backups/backup2l/ subdirectory, which will be automatically excluded from the archive.

The role configures the backup2l script to read the list of paths to backup from an external file, by default stored in /usr/local/etc/backup/include. This file is maintained using the lineinfile Ansible module, therefore other Ansible roles or the system administrators can add their own paths to it without breaking idempotency. This functionality can be disabled using the backup2l__srclist_from_file variable.

The backup2l script will execute pre-hooks and post-hooks from specific directories, by default:

•   pre-hooks: /usr/local/etc/backup/pre-hook.d/

•   post-hooks: /usr/local/etc/backup/post-hook.d/

    These directories can contain scripts which execute certain actions before or after a backup is performed. This can be used to for example, send new archives to a remote file using the rsync command. You can use the debops.resources Ansible role to provide custom pre/post hooks.

    The pre/post hook integration is designed to be "agnostic", and it's best not to rely on a specific backup solution, ie. backup2l in this case, to execute actions. You can maintain your own directories and files in the /var/backups/ directory, which will be subsequently included in the backup2l archive.

  Ansible local facts

The debops.backup2l role provides a set of Ansible local facts available in the ansible_local.backup2l.* hierarchy. Other Ansible roles can use these facts to include additional configuration using pre/post hook scripts, or add their own paths to the list of paths archived by the script.

  Example inventory

To enable backup2l script on a given host, it needs to be included in the [debops_service_backup2l] Ansible inventory group:

[debops_service_backup2l]
hostname

  Example playbook

If you are using this role without DebOps, here's an example Ansible playbook that uses the debops.backup2l role:

---
- name: Configure backup2l service
  collections: [ 'debops.debops', 'debops.roles01',
                 'debops.roles02', 'debops.roles03' ]
  hosts: [ 'debops_service_backup2l' ]
  become: True
  environment: '{{ inventory__environment | d({})
                   | combine(inventory__group_environment | d({}))
                   | combine(inventory__host_environment  | d({})) }}'
  roles:
    - role: backup2l
      tags: [ 'role::backup2l', 'skip::backup2l' ]

  Ansible tags

You can use Ansible --tags or --skip-tags parameters to limit what tasks are performed during Ansible run. This can be used after a host was first configured to speed up playbook execution, when you are sure that most of the configuration is already in the desired state.

Available role tags:

role::backup2l
    Main role tag, should be used in the playbook to execute all of the role tasks as well as role dependencies.

AUTHOR
Maciej Delmanowski

COPYRIGHT
2014-2022, Maciej Delmanowski, Nick Janetakis, Robin Schneider and others