Skip to content

EMQX Backup Sync ​

このプラグインは、既存のデータバックアップAPIを使用して、プライマリEMQXクラスターからセカンダリEMQXクラスターへ選択されたバックアップデータを定期的に同期します。

セカンダリクラスターはプライマリクラスターに対してバックアップファイルのエクスポートを呼び出し、そのファイルをダウンロードしてローカルにアップロードし、インポートします。選択された設定ルートはEMQXの既存の設定インポートのセマンティクスに従ってインポートされます。選択されたMnesiaテーブルセットはスナップショットとしてインポートされるため、セカンダリクラスターにのみ存在するレコードは削除されます。選択されていないルートやテーブルセットは変更されません。

設定 ​

各セカンダリクラスターにプラグインをインストールして起動してください。プライマリクラスターにはこのプラグインのインストールは不要で、セカンダリクラスターからアクセス可能なダッシュボードのデータバックアップAPIが必要です。

hocon
primary {
  base_url = "https://primary.example.com:18083/api/v5"
  api_key = "sync-key"
  api_secret = "sync-secret"
  ssl {
    enable = true
    server_name_indication = "primary.example.com"
    verify = "verify_peer"
    cacertfile = "/etc/emqx/certs/primary-ca.pem"
    certfile = ""
    keyfile = ""
  }
}

sync {
  interval = "5m"
  root_keys = [
    "connectors",
    "actions",
    "sources",
    "rule_engine",
    "listeners",
    "schema_registry"
  ]
  table_sets = [
    "banned",
    "builtin_authn",
    "builtin_authz"
  ]
  timeout = "30s"
  retain_remote_backup = false
  retain_backup_after_import = true
}

設定されたAPIキーはプライマリクラスターのデータバックアップエンドポイントへのアクセスが許可されている必要があります。primary.api_keyおよびprimary.api_secretは直接設定するか、file://パス(例:file:///etc/emqx/backup-sync-api-key)として指定できます。

サポートされているsync.root_keysの値はconnectors、actions、sources、rule_engine、listeners、schema_registry、authentication、およびauthorizationです。

ルールは一般的にコネクター、アクション、ソース、スキーマレジストリオブジェクトに依存します。rule_engineを依存関係なしで同期すると、インポートが失敗したり不完全なランタイム動作を引き起こす可能性があります。これらの依存するルートは、セカンダリクラスターに既に存在しない限りsync.root_keysに含めてください。

デフォルトでは、同期にはbanned、builtin_authn、builtin_authzのテーブルセットも含まれます。これらの選択されたテーブルセットはセカンダリクラスター上で置き換えられます。設定のみの同期が必要な場合は、sync.table_sets = []に設定してください。サポートされているsync.table_setsの値はbanned、builtin_authn、builtin_authz、builtin_retainer、psk、およびmtです。プライマリのデータバックアップAPIは、APIキーで呼び出した場合にdashboard_usersやapi_keysを含みません。

CLI ​

セカンダリノード上で以下のコマンドを使用してローカルの同期ワーカーを確認できます。

bash
emqx ctl backup_sync status

このコマンドはローカルノード、ヘルス状態、ワーカー状態、選択されたコアノード、次回の同期予定時刻、および非機密の同期設定を表示します。

ダウンロード ​

各EMQXリリースのタールボール:

EMQXバージョンプラグインバージョンパッケージ
6.3.00.1.3emqx_backup_sync-0.1.3.tar.gz (sha256)
6.3.10.1.3emqx_backup_sync-0.1.3.tar.gz (sha256)
6.3.20.1.3emqx_backup_sync-0.1.3.tar.gz (sha256)
6.3.30.1.4emqx_backup_sync-0.1.4.tar.gz (sha256)