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内にバックアップスクリプトとLinuxで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システムでは）管理者権限が必要であることに注意してください。

自動タスクの作成ができない場合でも、生成されたスクリプトを使用できます。たとえば、共有ホスティングサーバーにいる場合や、ウェブインターフェースを介してcronジョブを定義できる場合は、各バックアップファイルを実行するように追加してください。コマンドをCRON=trueで接頭して、スナップショットがスケジュールされたタスクによって作成されたことを示すようにしてください：

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

インストール

ロールをインストールする方法はいくつかあります。直接GitHubリポジトリからクローンまたはダウンロードするか、Ansible Galaxyを介してインストールします：

ansible-galaxy install roles-ansible.restic

要件

• bzip2

ロール変数

リポジトリ

Resticはデータをリポジトリに保存します。このロールを使用するためには、少なくとも1つのリポジトリを指定する必要があります。リポジトリはローカルまたはリモートである可能性があります（公式のドキュメントを参照）。

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を配列として指定することもできます。これはレガシー機能で、将来的に廃止される可能性があります。現在、名前キーはアクセスおよびバックアップファイルの命名に使用されています。

除外

バックアップの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ファイルを参照してください。