Rol de Ansible: restic

Beta: Este rol está en estado beta.

Descripción

Restic es una solución de respaldo versátil basada en Go que soporta múltiples Backend, deduplicación y respaldos incrementales.

Este rol instala restic en un cliente, configura los repositorios de respaldo y opcionalmente establece un temporizador de systemd o tareas de cron para ejecutar los respaldos. Además, configurará scripts ejecutables para realizar un respaldo manualmente.

Este proyecto se basa en gran medida en el donat-b/ansible-restic y en el https://github.com/arillso/ansible.restic rol de ansible. Intentamos hacer este rol más comprensible y moderno utilizando temporizadores de systemd, /etc/crontab para definir rutas de respaldo, más rutas absolutas y menos opciones. (no probado para almacenamiento S3 o Windows...)

Scripts de Respaldo

Este rol creará un script de respaldo y un archivo con credenciales utilizables con el comando source en Linux para cada respaldo en el restic_script_dir. Estos scripts ejecutables pueden usarse para activar manualmente una acción de respaldo, pero también se utilizan para respaldos automatizados si has configurado la variable restic_create_schedule como verdadera. Asegúrate de no cambiar los archivos manualmente, ya que esto puede interferir bastante con tus respaldos.

En Linux, si deseas tomar un snapshot manual, puedes ejecutar el respaldo así:

$ /ruta/al/script/de/respaldo/respaldo-ejemplo.sh

Por defecto, tal snapshot tendrá la etiqueta manual, para que puedas distinguirlos de los snapshots creados automáticamente. También puedes añadir más etiquetas simplemente añadiéndolas:

$ /ruta/al/script/de/respaldo/respaldo-ejemplo.sh --tag despliegue

Tareas CRON / Programadas

Para utilizar los respaldos definidos, se pueden configurar automáticamente como tareas programadas. Debes tener en cuenta que (al menos en sistemas Linux) necesitas permisos de administrador para configurar tal acción.

Si no puedes usar la creación automática de las tareas, aún puedes hacer uso de los scripts generados. Si, por ejemplo, estás en un servidor de hosting compartido y puedes definir un cronjob a través de una interfaz web, simplemente añade cada archivo de respaldo para ejecutarlo. Asegúrate de prefijar el comando con CRON=true para indicar que el snapshot fue creado a través de una tarea programada:

CRON=true /ruta/al/script/de/respaldo/respaldo-ejemplo.sh

Instalación

Hay múltiples maneras de instalar el rol. Puedes clonarlo o descargarlo directamente desde el repositorio de github. O instalarlo a través de ansible galaxy:

ansible-galaxy install roles-ansible.restic

Requisitos

• bzip2

Variables del Rol

Repos

Restic almacena datos en repositorios. Debes especificar al menos un repositorio para poder usar este rol. Un repositorio puede ser local o remoto (ver la documentación oficial).

Usando un repositorio SFTP

Para usar un backend SFTP, el usuario necesita acceso sin contraseña al host. Asegúrate de distribuir las claves ssh en consecuencia, ya que esto está fuera del ámbito de este rol.

Variables disponibles:

Ejemplo:

restic_repos:
  local:
    location: /srv/restic-repo
    password: contraseñasegura0
    init: true
  remote:
    location: rest:https://restic_rest_server.example.com:8000/restic-repo/
    password: contraseñasegura1
    init: true
  sftp:
    location: sftp:usuario@host:/srv/restic-repo
    password: contraseñasegura2
    init: true
  aws:
    location: s3:s3.amazonaws.com/nombre_del_bucket
    password: contraseñasegura3
    init: true
    aws_access_key: claveacceso
    aws_secret_access_key: claveprivada
    aws_default_region: eu-west-1
  azure:
    location: azure:container:/
    password: contraseñasegura4
    init: true
    azure_account_name: nombre_cuenta_almacenamiento
    # Solo una de las siguientes es requerida
    azure_account_key: algunaclave
    azure_account_sas: url_sas
    # Opcional
    azure_endpoint_suffix: core.windows.net
  b2:
    location: b2:nombrebucket:ruta/al/repo
    password: contraseñasegura5
    init: true
    b2_account_id: idcuenta
    b2_account_key: clavecuenta

Respaldos

Un respaldo especifica un directorio o archivo que debe ser respaldado. Un respaldo se escribe en un repositorio definido en restic_repos.

Variables disponibles:

Ejemplo:

restic_backups:
  data:
    name: data
    repo: remote
    src: /ruta/a/datos
    scheduled: true
    schedule_oncalendar: '*-* * 01:00:00'
  database:
    name: database
    repo: remote
    stdin: true
    stdin_cmd: pg_dump -Ubackup nombre_base_datos
    stdin_filename: volcado_nombre_base_datos.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

También puedes especificar restic_backups como un arreglo, que es una característica heredada y podría ser deprecada en el futuro. Actualmente, la clave name se usa para nombrar el acceso y los archivos de respaldo.

Excluir

La clave exclude en un respaldo te permite especificar múltiples archivos a excluir o buscar archivos para ser excluidos. Puedes especificar las siguientes claves:

exclude:
    exclude_caches: true
    exclude:
        - /ruta/a/archivo
    iexclude:
        - /ruta/a/archivo
    exclude_file:
        - /ruta/a/archivo
    exclude_if_present:
        - /ruta/a/archivo

Por favor, consulta el uso de las claves específicas en la documentación.

Dependencias

Este rol no tiene otros roles de ansible como dependencias.

Ejemplo de Playbook

- name: respaldar tus carpetas personales a /mnt/backup cada noche
  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'

Licencia

Este proyecto está bajo la Licencia MIT. Consulta el archivo LICENSE para el texto completo de la licencia.