Hot Upgrade (Relup)

このプラグインは、実行中のEMQXノードに対して.relup形式のコード変更指示を適用し、オペレーターがVMを再起動せずにパッチリリースを展開できるようにします。

オペレーターは各ノードでemqx ctl relup ... CLIを使って操作します。クラスター全体への展開はオペレーターの責任であり（オーケストレーション機能は組み込まれていません）。

使用タイミング

Hot Upgradeは以下の場合に適しています：

• 適用したいホップがemqx ctl relup list-supported-pathsでリストされている（宣言された{from, target}ホップのみサポート）。
• 次のノードに進む前にターゲットノードを検証できる。
• data/のバックアップがある。適用済みホップのインプレースロールバックはありません（ロールバック参照）。

これらを満たせない場合は、通常のローリング再起動を行ってください。

オペレーターのワークフロー

1. プラグインのインストール

以下のDownloadセクションからEMQXバージョンに合ったtarballをダウンロードし、ダッシュボード（またはREST API／CLI）から他のプラグインと同様にインストールします。

2. アップグレードパスのサポート確認

emqx ctl relup list-supported-paths

出力にはこのプラグインバージョンのpriv/relup/にバンドルされた{from, target}ホップが表示されます。ホップが無い場合、そのパスのHot Upgradeは利用できません。通常の再起動ベースのアップグレードに戻ってください。

3. 各ノードにターゲットリリースを配置

各ノードで、EMQXプロセスが読み取れるパスに以下の2ファイルをコピーします：

• emqx-enterprise-<TargetVsn>-<os>-<arch>.tar.gz：EMQXターゲットリリースのtarball
• <tarball>.sha256：sha256ダイジェスト。標準のsha256sum形式（<digest> <filename>）が受け入れられます。

4. アップグレードのトリガー

各ノードで以下を実行します：

emqx ctl relup upgrade <TarballPath> [--force]

ハンドラーは以下を行います：

• <TarballPath>.sha256と実際のダイジェストを照合し、不一致の場合は展開を拒否。
• data/patches/に*.beamファイルがある場合は続行を拒否。このディレクトリはvm.args -paでコードパスの先頭に追加されるため、アップグレードターゲットのモジュールより優先されます。ターゲットリリースにホットパッチ済みの修正が含まれている場合、古いbeamファイルが読み込まれる可能性があります。パッチファイルを先に削除するか、ターゲットリリース上に適用済みの状態を維持する場合のみ--forceを指定してください。
• tarballを展開し、releases/emqx_varsからREL_VSNを読み取る。
• priv/relup/*.relupの対応する{from, target}ホップを検索し、宣言されたコード変更指示とアップグレード後のコールバックを実行。

5. ノードの検証

次の状態を確認してから次に進みます：

• emqx ctl statusでノードが稼働中であること。
• <RootDir>/relup/currentがターゲットバージョンと一致し、<RootDir>/relup/<TargetVsn>/にbin/、erts-*/、lib/、releases/が存在すること。

次回のemqx startまたはrestart時に、bin/emqxラッパーがrelup/currentを検出し、デプロイ済みツリー（新しいERTS、新しいbinスクリプト、新しいlib）にexecします。元の<RootDir>はdata/、etc/、log/、plugins/の管理を継続します。

6. 成功後のクリーンアップ

クラスター全体がターゲットバージョンに揃ったら、配置したtarballとその.sha256ファイルを手動で削除してください。プラグインはソースパスを追跡しないため、プラグイン側での状態管理はありません。

アップグレード履歴

各ノードはemqx_relup_logテーブル（ディスクバック、ローカルコンテンツ）に独自の監査履歴を保持します。履歴はプラグインアンインストール後も残り、再インストールで再接続されます。

CLIで確認またはクリア可能です：

emqx ctl relup logs           # 最近のアップグレード試行を表示
emqx ctl relup logs-clear     # このノードのログ行を全削除

ロールバック

適用済みホップのインプレースロールバックはありません。Hot UpgradeはライブVMに対してcode_changesを実行し、post_upgrade_callbacksでディスク上のデータが変更されている可能性があるため、このプラグインでは元に戻すことをサポートしていません。

実用的なフォールバック方法：

• 次回再起動前に、アップグレードが成功したが新コードに問題があり、ディスク上のデータが旧リリースと互換性がある場合：

  rm <RootDir>/relup/current
  # 必要に応じて: rm -rf <RootDir>/relup/<TargetVsn>/
  emqx restart

  ラッパーは元の<RootDir>/bin/emqxツリーにフォールバックします。これはブートパスのみ回復し、アップグレード時のVM内ライブ状態は既に失われています。

• それ以外の場合は、アップグレード前にバックアップしたdata/（mnesia、設定など）から復元し、旧EMQXリリースを再インストールしてください。この点を考慮してアップグレードウィンドウを計画してください。

ホップの作成（開発者向けメモ）

新しいホップを追加するには、必要な各リリースに対して：

1. priv/relup/<from>-to-<to>.relupを追加し、ホップのcode_changesとpost_upgrade_callbacksを宣言します。プラグインソースのpriv/relup/README.mdにスキーマ、サポートされる命令、アップグレード後コールバックの契約が記載されています。特に、新しいEMQXのemqx_post_upgradeにpr_NNNNN_*コールバックを追加する場合、relupホップはコールバック呼び出し前にそのモジュールをリロードするか、このプラグインにemqx_post_upgrade_<TargetVsn>.erlとしてコールバックを同梱する必要があります。
2. このプラグインのVERSIONを更新し、再公開します。

プラグインはアプリ起動時にすべてのpriv/relup/*.relupを検証し、形式不正なエントリは警告ログを出してスキップします。致命的エラーにはなりません。

Download

各EMQXリリース用のtarball：

EMQX Version	Plugin Version	Package
6.1.2	1.0.0	emqx_relup-1.0.0.tar.gz
6.1.3	1.0.0	emqx_relup-1.0.0.tar.gz