Ansible 角色：restic

测试版： 此角色处于测试版状态。

描述

Restic 是一个多功能的基于 Go 的备份解决方案，支持多种后端、去重和增量备份。

此角色在客户端上安装 restic，配置备份库，并可选择设置 systemd 定时器或 cron 作业来运行备份。此外，它还会设置可执行脚本以手动运行备份。

本项目大量借鉴了 donat-b/ansible-restic 和 https://github.com/arillso/ansible.restic 的 ansible 角色。我们尝试通过使用 systemd 定时器、/etc/crontab 定义备份路径、更多绝对路径和更少选项，使此角色更易于理解和现代化。（未测试 S3 存储或 Windows...）

备份脚本

此角色将为 restic_script_dir 中的每个备份创建一个备份脚本和一个可用于 source 命令的凭据信息文件。这些可执行脚本可以用来手动触发备份操作，但如果你将 restic_create_schedule 变量设置为 true，它们也将用于自动备份。请确保不要手动更改这些文件，因为这可能会严重影响你的备份。

在 Linux 上，如果你想手动创建快照，可以这样运行备份：

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

默认情况下，这样的快照将被标记为 manual，以便你将其与自动创建的快照进行区分。你还可以通过简单地追加标签来添加更多标签：

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

CRON / 定时任务

为了使用定义的备份，它们可以自动设置为定时任务。你必须意识到（至少在 Linux 系统上）你需要拥有管理员权限才能配置此类操作。

如果你无法使用自动创建任务，你仍然可以使用生成的脚本。例如，如果你在共享主机服务器上，并且可以通过 Web 界面定义 cron 作业，只需将每个备份文件添加到要执行的列表中。确保在命令前加上 CRON=true，以表明快照是通过定时任务创建的：

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

安装

安装这个角色的方法有多种。你可以直接从 github 仓库 克隆或下载它。或者通过 ansible galaxy 安装：

ansible-galaxy install roles-ansible.restic

系统要求

• bzip2

角色变量

Repos

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 文件以获取完整的许可证文本。