バックアップ

Composia は Rustic を通じてバックアップを自動化します。バックアップとリストアのタスクはエージェント上で実行され、コントローラーがランタイム設定を生成します。

アーキテクチャ

バックアップには Rustic インフラストラクチャサービスが必要です。リポジトリには infra.rustic を持つサービスを 1 つだけ宣言する必要があります:

name: rustic
nodes:
  - main
infra:
  rustic:
    compose_service: rustic
    profile: default
    data_protect_dir: /data-protect

Rustic compose サービスは rustic バイナリを実行する通常の Docker コンテナです。エージェントの {StateDir}/data-protect を data_protect_dir に設定されたパスにマッピングするボリュームが必要です。

コントローラー設定

controller:
  backup:
    default_schedule: "0 2 * * *"
  rustic:
    main_nodes:
      - "main"
    maintenance:
      forget_schedule: "0 1 * * Sun"
      prune_schedule: "0 3 * * Sun"

サービスデータ保護

composia-meta.yaml の data_protect でバックアップ対象を定義します:

data_protect:
  data:
    - name: db
      backup:
        strategy: database.pgdumpall
        service: postgres
      restore:
        strategy: database.pgimport
        service: postgres
    - name: uploads
      backup:
        strategy: files.copy_after_stop
        include:
          - ./uploads
      restore:
        strategy: files.copy
        include:
          - ./uploads

データ戦略

データアクションフィールド

include パスの種類

パスは以下を参照できます:

• サービスパス: サービスディレクトリ内のファイルまたはディレクトリ。-v で読み取り専用として Rustic コンテナに bind-mount されます。
• 名前付きボリューム: Docker ボリューム名。-v で読み取り専用として Rustic コンテナに bind-mount されます（一時コンテナ不要）。

バックアップスケジュール

保護されたデータ項目のスケジュールバックアップを有効にします:

backup:
  data:
    - name: db
      provider: rustic
      enabled: true
      schedule: "0 2 * * *"
    - name: uploads
      enabled: true
      schedule: "0 3 * * Sun"

schedule が設定されている場合、コントローラーは定期的な backup タスクをスケジュールします。サービスエントリが独自のスケジュールを指定していない場合、コントローラーの backup.default_schedule がフォールバックとして使用されます。

バックアップの実行方法

バックアップタスクはエージェント上で以下のステップを実行します:

1. レンダリング: コントローラーからサービスバンドルと Rustic バンドルをダウンロード。コントローラーが生成した .composia-backup.json を読み取ります。
2. バックアップ: ランタイム設定の各データ項目について:
   • files.*: data-protect の下に空のステージングディレクトリを作成し、各 include パスまたはボリュームに対して -v bind mount を追加し、サービスとデータ項目を識別するタグを付けて docker compose run -v ... rustic backup を実行します。データはエージェントの state ディレクトリにコピーされません。
   • database.pgdumpall: docker compose exec <service> pg_dumpall を実行し、SQL ダンプを data-protect の下のステージングファイルに書き込み、そのステージングディレクトリに対して docker compose run rustic backup を実行します。
   • 結果（スナップショット ID）をコントローラーに報告します。
3. すべての項目がバックアップされたらタスクが完了します。

バックアップ成果物は Rustic スナップショット ID で識別されます。タグには後続のリストアや forget 操作用に composia-service:<name> と composia-data:<name> が含まれます。

リストア

Web UI のバックアップページから、または CLI でリストアをトリガーします:

composia backup restore --wait --follow --timeout 30m main <backup-id>

The first argument is the target node. Use --wait --follow to block until the restore finishes and stream task logs.

リストアプロセス:

1. レンダリング: サービスバンドルと Rustic バンドルをダウンロード。.composia-restore.json を読み取ります。
2. リストア: 各項目について:
   • files.copy / files.copy_after_stop: リストアターゲットをクリーンアップし（ターゲットは存在している必要があります）、data-protect の下に空のステージングディレクトリを作成し、各ターゲットパスまたは Docker ボリュームをステージングツリーに bind-mount し、docker compose run -v ... rustic restore <snapshot_id> <staging_dir> を実行します。復元されたデータはターゲットの場所に直接書き込まれます — リストア後のコピーステップは不要です。
   • files.copy_after_stop: さらにリストア前に compose プロジェクトを停止し、リストア後に再起動します。
   • database.pgimport: docker compose run rustic restore <snapshot_id> をステージングディレクトリに実行し、復元された SQL ダンプで docker compose exec <service> psql を実行します。

files.* のリストアターゲット（サービスパス）はエージェント上に既に存在している必要があります（ファイル/ディレクトリの bind-mount セマンティクスを判断するために使用されます）。Docker ボリュームターゲットはリストア前にクリアされます。

Rustic メンテナンス

メンテナンスタスクは Rustic インフラストラクチャサービスを使用します:

• rustic_init: docker compose run rustic init を実行して Rustic リポジトリを初期化します。Rustic セットアップごとに 1 回使用します。
• rustic_forget: タグフィルター付きで docker compose run rustic forget を実行します。サービス、データ項目、またはリポジトリ全体にスコープを設定できます。
• rustic_prune: docker compose run rustic prune を実行して参照されていないデータを削除します。

Web UI または CLI からメンテナンスをトリガーします:

composia rustic init --wait --follow main
composia rustic forget --service my-app --data uploads --yes --wait --follow main
composia rustic prune --yes --wait --follow main

Use --wait --follow when you want the CLI to wait for the maintenance task and stream logs.

関連項目

• サービス設定 — データ保護とバックアップスケジュール。
• 移行 — バックアップを通じてデータを保持したままノード間でサービスを移動。