ウェブサイト検索

Linuxでautoresticを使用してresticバックアップをオーケストレーションする方法


Resticは、暗号化と重複排除をサポートする現代のバックアッププログラムです。このチュートリアルで見たように、Resticは使いやすいですが、設定ファイルを利用せず、複数のバックアップを調整し整理するための方法も標準では含まれていません。そこでautoresticが役立ちます。これはResticのラッパーであり、単一のyaml設定ファイルでバックアップを設定し調整することができます。複数のソース(場所)と宛先(バックエンド)を指定することが可能です。

このチュートリアルでは、Linuxにautoresticをインストールする方法、構成ファイルの構造、および基本的なセットアップの作成方法について学びます。

このチュートリアルでは、あなたは学びます:

  • Linuxにautoresticをインストールする方法
  • オートレストック設定ファイルの構造について
  • Resticバックアップをautoresticで構成する方法
  • autoresticフックでカスタムコマンドを実行する方法

autoresticをインストールする

この記事では、Resticを既にインストールしていると仮定します。まだ馴染みがない場合は、最初に私たちの入門チュートリアルを見てみることをお勧めします。

執筆時点で、主要なLinuxディストリビューションの中で、Fedoraだけがそのリポジトリにautoresticを含んでいます。このソフトウェアをインストールするには、プロジェクトのGitHubリポジトリからプリコンパイルされたバイナリをダウンロードするか、専用のDockerイメージを使用することができます。これらのオプションを探ってみましょう。

手動インストール

autoresticをインストールする最も簡単な方法は、私たちのオペレーティングシステムに適したバイナリのバージョンをダウンロードし、それを私たちのPATHのディレクトリに配置することです。以下の例では、最新のx86_64 Linuxバージョン(執筆時点での1.8.2)をダウンロードし、/usr/local/binディレクトリにインストールします。まず、「.bz2」アーカイブをダウンロードします:

curl -LO https://github.com/cupcakearmy/autorestic/releases/download/v1.8.2/autorestic_1.8.2_linux_amd64.bz2

ダウンロードが完了したら、ファイルを抽出します:

bzip2 -d autorestic_1.8.2_linux_amd64.bz2

最後に、ファイルをターゲットディレクトリに移動し、それを実行可能にします:

sudo mv autorestic_1.8.2_linux_amd64 /usr/local/bin/autorestic && sudo chmod +x /usr/local/bin/autorestic

パッケージマネージャーを介したインストール(Fedora専用)

Fedoraを使用している場合、autoresticをインストールする最も簡単で便利な方法は、dnfパッケージマネージャを使用することです。このツールはディストリビューションの公式リポジトリに含まれているためです。

sudo dnf install autorestic

autoresticのDockerイメージを使用する

公式のDocker autoresticイメージが利用可能です。このイメージに基づいてコンテナを実行する際には、バックアップしたいディレクトリ、autoresticの設定ファイル、およびターゲットリポジトリ(ローカルバックアップを実行する場合)をコンテナ内のどこかにバインドマウントする必要があります。そして、-cオプションを使用してautoresticに設定ファイルのパスを指定します。以下は、ホストの/dataディレクトリの内容をバックアップする例です:

sudo docker run --rm -v /data:/data:Z -v /etc/autorestic.yml:/etc/autorestic.yml:Z -v /mnt/restic_repo:/mnt/restic_repo:Z cupcakearmy/autorestic autorestic backup -va -c /etc/autorestic.yml

私たちは、/etc/autorestic.yaml 設定ファイル、/data ディレクトリ、および /mnt/restic_repo ディレクトリ(これらは、それぞれバックアップのソースと宛先です)をコンテナ内のそれぞれの位置にバインドマウントしました。各バインドマウントには Z オプションを使用しました:これはSELinuxがアクティブな場合にのみ必要で、参照されるファイルのラベルを object_r:container_file_t に変更し、コンテナ内でアクセスできるようにします。

オートレストリック構成ファイル

autoresticの核はそのyaml設定ファイルです。このファイルでは、バックアップのソースと宛先、使用したいresticのオプション、およびその他多くのことを設定します。明らかに理由から、ここですべての可能なオプションをカバーすることはできないため、基本的な内容のみを見ていきます。

Autoresticは、優先順位の順に以下の位置で構成ファイルを探します:

  1. .autorestic.yml
  2. ~/.autorestic.yml
  3. ~/.config/autorestic/.autorestic.yml

設定ファイル内では、「location」セクションでバックアップのソースを定義し、「backends」セクションでその宛先を定義します。基本的な例から始めましょう。/data ディレクトリの内容を /mnt/restic_repo ローカルリポジトリにバックアップしたいとしましょう。これが、現在の作業ディレクトリに .autorestic.yml として保存する autorestic 設定ファイルの記入方法です:

version: 2
locations:
  data:
    from: 
      - /data
    to:
      - localrepo

backends:
  localrepo:
    type: local
    path: /mnt/restic_repo
    key: repositorypassword

各ロケーションは小文字の名前で識別されます。この場合、私たちが作成したものには「data」を使用しました。fromキーを使用して、バックアップしたい1つ以上のディレクトリを定義します:パスは絶対パスまたは設定ファイルのパスに対する相対パスとして指定できます。一方、toキーを使用して、ロケーションのための1つまたは複数のターゲットまたはバックエンドを指定し、再び名前で参照します。各宛先または「バックエンド」を「backends」セクションで定義します。

この例では、私たちは「localrepo」と呼ばれるバックエンドを1つだけ定義しました(場所と同様に、バックエンド名は小文字で定義する必要があります)。typeキーの値を「local」に設定することで、バックエンドがローカルファイルシステム上に存在するresticリポジトリであることを指定しました(resticは多くのストレージプラットフォームをサポートしていることはご存じの通りです;他には、Backblaze、S3、SFTPなどがあります)。pathキーを使ってresticリポジトリのパスを指定し、最後にkeyを使用してリポジトリのパスワードを報告しました(設定ファイルに平文のパスワードを入れることは危険かもしれません。この振る舞いの代替手段については後ほど見ていきます)。

バックアップを開始する

さて、バックアップを初めて実行する場合、すべてが準備完了であることを確認するために、autoresticのcheckコマンドを使用できます。このコマンドは、自動的に定義されたバックエンドを初期化しますので、事前にresticリポジトリを作成する必要はありません。

sudo autorestic check

バックアップを開始するには、backup コマンドを使うことができます:

sudo autorestic backup -va

上記のように、-vオプションを使ってautoresticを呼び出し、詳細モードで実行するようにし、-aを使ってすべての既存の場所のバックアップを行うよう指示しました。複数の場所を定義した場合、そのうちの一部だけをバックアップしたい場合は、カンマ区切りの名前のリストを-lオプションに引数として渡すことができます。例:

autorestic backup -v -l data

resticオプションの指定

autoresticの設定ファイルでは、各ロケーションごと、またはグローバルにresticに渡すオプションを指定できます。resticに渡すべきオプションは、optionsキーの値として提供されます。バックアップおよび忘却コマンドのために渡すオプションを、backup、forget、およびallキーを使用して、それぞれ指定することができます。例を挙げてみましょう。「data」ロケーションのバックアップを行う際に、すべての「.txt」拡張子のファイルを除外したいとします。その場合、以下のように記述します:

version: 2
locations:
  data:
    from:
      - /data
    to: 
      - localrepo
    options:
      backup:
        exclude:
          - '*.txt'

backends:
  localrepo:
    type: local
    path: /mnt/restic_repo
    key: repositorypassword

resticの「forget」コマンドは、--keepオプションで指定したポリシーに基づいて、リポジトリから古いスナップショットを削除するために使用されます。これらのオプションを提供するために、forgetキーの下にそれらを指定します。たとえば、常に最新の10個のスナップショットを保持し、それ以前のものを削除したい場合は、--keep-last=10を使用します。

version: 2
locations:
  data:
    from:
      - /data
    to: 
      - localrepo
    options:
      backup:
        exclude:
          - '*.txt'
      forget:
        keep-last: 10

backends:
  localrepo:
    type: local
    path: /mnt/restic_repo
    key: repositorypassword

「忘れる」オプションは、forget コマンドで autorestic を呼び出すときに適用されます。

autorestic forget -va

私たちは、forgetキーをロケーション定義に直接使用することによって、各バックアップの後に「forget」コマンドが自動的に実行されるようにautoresticを設定できます。このキーの値は、スナップショットを忘れたいだけの場合はtrueに、忘れたスナップショットに関連するデータをリポジトリから削除したい場合はpruneに設定できます。以下はその例です:

version: 2
locations:
  data:
    from:
      - /data
    to: 
      - localrepo
    forget: prune
    options:
      backup:
        exclude:
          - '*.txt'
      forget:
        keep-last: 10

backends:
  localrepo:
    type: local
    path: /mnt/restic_repo
    key: repositorypassword

これまで設定したオプションは「データ」場所にのみ有効です。複数の場所がある場合、すべての場所に特定のオプションを適用したい場合は、グローバルセクションを設定することができます。例えば:

version: 2
global:
  backup:
    exclude:
      - '*.txt'
  forget:
    keep-last: 10

locations:
  data:
    from:
      - /data
    to: 
      - localrepo

backends:
  localrepo:
    type: local
    path: /mnt/restic_repo
    key: repositorypassword

ロケーション固有のオプションは、グローバルセクションで設定されたものを上書きします。この戦略は、例外を指定したい場合に便利です。

バックエンドのパスワードを提供する代替手段

前の例では、設定ファイル内で「localrepo」バックエンドのパスワードを直接指定しました。代わりに、autoresticを起動する際に定義できる環境変数の値としてパスワードを設定することができます。または、設定ファイルと同じディレクトリに配置する必要がある専用ファイル「.autorestic.env」に保存することも可能です。変数が特定のバックエンドに自動的に関連付けられるためには、次の構文を使用して定義します。

AUTORESTIC_<BACKEND-NAME>_<VARIABLE_NAME>

したがって、「localrepo」バックエンドのパスワードを設定するには、次のように書きます。

AUTORESTIC_LOCALREPO_RESTIC_PASSWORD="repositorypassword"

この戦略を使用して追加情報を提供することもできます。例えば、リモートのBackblazeバックエンドを使用する場合、アカウントIDとアカウントキーの両方を提供できます。「backblaze」というバックアップを定義したと仮定すると、次のように書きます:

AUTORESTIC_BACKBLAZE_B2_ACCOUNT_ID="123"
AUTORESTIC_BACKBLAZE_B2_ACCOUNT_KEY="456"

もう一つの代替案は、resticのネイティブな--password-commandオプションを使用することです。このオプションを使用することで、標準出力にパスワードを返すコマンドを提供できます。この戦略を使用することで、例えば、以下のように外部ファイルからパスワードを読み取ることができます:

version: 2
locations:
  data:
    from:
      - /data
    to: 
      - localrepo
    options:
      all:
        password-command: cat /root/.password
      backup:
        exclude:
          - '*.txt'
      forget:
        keep-last: 10

backends:
  localrepo:
    type: local
    path: /mnt/restic_repo

私たちは「すべて」セクションのオプションを使用したので、バックアップコマンドまたは忘却コマンドを実行しても常に渡されます。

オートレスティックフック

Autoresticは、以下のフックを使用して特定のタイミングでカスタムコマンドを実行することを可能にします:

  • 事前検証
  • 前
  • 後
  • 失敗
  • 成功

prevalidate フックは、他のすべての処理の前に、さまざまなチェックが実行される前に実行されます(たとえば、autorestic は、ロケーションに関連付けられたソースディレクトリが存在するかをチェックします);それに対して、before フックはチェックの後に実行されますが、バックアップが開始される前に実行されます。after フックは、バックアップが完了した後に常に実行され、終了ステータスに関係なく実行されます(バックアップが全く開始できない場合、つまり「prevalidate」または「before」フックでエラーが発生した場合はスキップされます)。最後に、failure および success フックに関連付けられたコマンドは、バックアップが成功裏に実行された後または失敗した後にそれぞれ呼び出されます。

以下の例では、バックアップが成功した場合にntfy.shサービスを使ってプッシュ通知を送信します。

version: 2
locations:
  data:
    from:
      - /data
    to: 
      - localrepo
    options:
      all:
        password-command: cat /root/.password
      backup:
        exclude:
          - '*.txt'
      forget:
        keep-last: 10
    hooks:
      success:
        - curl -d "backup executed succesfully!" ntfy.sh/lxcfg

backends:
  localrepo:
    type: local
    path: /mnt/restic_repo

フックの間に、いくつかの事前定義された変数に格納された追加情報にアクセスできます。以下はその例です:

  • AUTORESTIC_SNAPSHOT_ID
  • AUTORESTIC_PARENT_SNAPSHOT_ID
  • 自己RESTIC_FILES_ADDED
  • 自動RESTIC_FILES_CHANGED
  • AUTORESTIC_FILES_UNMODIFIED
  • 自動的な場所

結論

このチュートリアルでは、autoresticラッパーを使用してResticバックアップをどのようにオーケストレートし整理するかを見ました。autoresticを使用することで、yaml構成ファイルを作成して設定することにより、複数の場所を複数のバックエンドにバックアップできます。最も一般的に使用されるLinuxディストリビューションにautoresticをインストールする方法と、場所およびバックエンドを構成する方法を見ました。また、バックアップを開始する方法と、autoresticから提供されるフックにカスタムコマンドを追加する方法も学びました。autoresticについてもっと知りたい場合は、公式ドキュメントを参照してください。

関連記事: