EMQX Enterprise

日本語

简体中文
English

日本語

简体中文
English

Appearance

お問い合わせ
お問い合わせ

プラグイン管理 ​

このページでは、EMQXにおけるプラグインのライフサイクルについて説明し、Dashboard、CLI、REST APIを使用したプラグインのインストール、設定、起動、停止、アンインストール、およびアップグレード方法を解説します。

プラグインのライフサイクル ​

EMQXのプラグインは、主に以下の3つのライフサイクル状態を経ます。

  • インストール済み：プラグインのコードと設定が読み込まれているが、アプリケーションはまだ起動していない状態。
  • 起動済み：プラグインが実行中で、EMQXと積極的に連携している状態。
  • アンインストール済み：プラグインがシステムから完全に削除された状態。

インストール手順 ​

インストール手順は以下の通りです。

  1. プラグインパッケージ（make relコマンドで作成されたtarball）をDashboard、API、またはCLI経由でアップロードします。詳細なインストール手順はInstall and Manage Pluginsを参照してください。
  2. プラグインパッケージはEMQXクラスターの各ノードに転送されます。
  3. 各ノードで以下の処理が行われます：
    • tarballがEMQXルートディレクトリのpluginsサブディレクトリに保存されます（plugins.install_dirオプションで上書きされる場合があります）：$EMQX_ROOT/plugins/my_emqx_plugin-1.0.0.tar.gz
    • 同じディレクトリに展開されます：$EMQX_ROOT/plugins/my_emqx_plugin-1.0.0/
    • 初期設定ファイル（メインプラグインのappからのconfig.hocon）が$EMQX_DATA_DIR/plugins/my_emqx_plugin/config.hoconにコピーされます。
    • Avroスキーマが存在する場合は検証のために読み込まれます。
    • プラグインコードがノードにロードされますが、アプリケーションは起動されません。
    • プラグインはEMQX設定のplugins.statesにdisabledとして登録されます。

TIP

プラグインの状態はEMQX設定のenableフラグ（trueまたはfalse）のみが保存されます。完全なプラグイン設定は各ノードの$EMQX_DATA_DIR/plugins/my_emqx_plugin/config.hoconファイルに保存されています。

設定 ​

インストール後、プラグインの設定はDashboardまたはAPIを通じて更新できます。

  • 新しい設定はAvroスキーマ（存在する場合）に基づいて検証されます。
  • 更新内容はクラスター内の全ノードに配布されます。
  • プラグインのon_config_changed/2コールバック関数が呼び出されます。プラグインが新しい設定を受け入れた場合、設定は$EMQX_DATA_DIR/plugins/my_emqx_plugin/config.hoconに永続化されます。

TIP

on_config_changed/2コールバック関数はアプリケーションが起動していなくても呼び出されます。

TIP

on_config_changed/2コールバック関数はEMQXクラスターの各ノードで呼び出されます。ローカルシステムの状態（例：ネットワークの可用性）に依存した設定検証は避けてください。ノード間で結果が不整合になる可能性があります。代わりにon_health_check/1を使用してランタイムチェックを行い、リソースが利用できない場合は非正常状態を報告してください。

設定ファイルの場所 ​

関連する設定ファイルの場所は2つあります。

  • インストール済みプラグインパッケージ内のバンドルされたデフォルトファイル：

    • Docker環境： /opt/emqx/plugins/my_emqx_plugin-1.0.0/my_emqx_plugin-1.0.0/priv/config.hocon
    • deb/rpm環境： /usr/lib/emqx/plugins/my_emqx_plugin-1.0.0/my_emqx_plugin-1.0.0/priv/config.hocon

  • DashboardやAPI経由で設定が保存された後にEMQXが管理する永続化されたプラグイン設定ファイル：

    • Docker環境： /opt/emqx/data/plugins/my_emqx_plugin/config.hocon
    • deb/rpm環境： /var/lib/emqx/plugins/my_emqx_plugin/config.hocon

priv/config.hoconはパッケージに含まれるデフォルトテンプレートであり、data/plugins/.../config.hoconはEMQXが設定変更を保存した後に使用される永続化された設定ファイルの場所です。

起動 ​

プラグインはDashboard、API、またはCLIから手動で起動します。起動時には以下が行われます。

  • プラグインのアプリケーションが起動されます。
  • プラグインはEMQX設定のplugins.statesにenabledとして登録されます。

プラグインが起動している状態で情報が要求されると、on_health_check/1コールバック関数が呼び出され、プラグインの状態が取得されます。

停止 ​

プラグインを停止すると以下が行われます。

  • プラグインのアプリケーションが停止されます。
  • プラグインはEMQX設定のplugins.statesにdisabledとして登録されます。

プラグインのアプリケーションは停止されますが、コードはノードにロードされたままです。停止したプラグインでも設定は可能です。

アンインストール手順 ​

アンインストール手順は以下の通りです。

  1. プラグインが起動中であれば停止します。
  2. プラグインのコードをノードからアンロードします。
  3. ノードからパッケージファイルを削除します（設定ファイルは保持されます）。
  4. プラグインはEMQX設定のplugins.statesから登録解除されます。

プラグインのアンインストールはDashboardまたはCLIから実行できます。詳細はInstall and Manage Pluginsを参照してください。

クラスター参加時の動作 ​

EMQXノードがクラスターに参加する際、プラグインおよび設定は各ノードのローカルファイルシステムに存在するため、実際にはインストールおよび設定されていない場合があります。

新規ノードは以下の処理を行います。

  • クラスター参加時にグローバルなEMQX設定を取得します。
  • EMQX設定からプラグインの状態（どのプラグインがインストールされているか、どのプラグインが有効か）を把握します。
  • 他のノードからプラグインとその実際の設定を要求します。
  • プラグインをインストールし、有効なプラグインを起動します。

プラグインのインストールと管理 ​

EMQXはDashboard、CLI、APIを通じてプラグインパッケージのインストール、アンインストール、管理をサポートしています。

Dashboard経由でのパッケージインストール ​

プラグインが既にビルドされ、my_emqx_plugin-1.0.0.tar.gzのtarballが用意されているとします。Dashboardから直接コンパイル済みプラグインパッケージをインストールする手順は以下の通りです。

重要なセキュリティアップデート

セキュリティ上の理由から、EMQXはDashboard経由のプラグインインストールに対して明示的な許可を要求するようになりました。

  • インストール開始前に許可を与える必要があります。
  • 許可状態は一時的で、インストール完了後に自動的に取り消されます。
  • クラスター環境では、全ノードで許可を与える必要があります。

  1. CLIで以下のコマンドを実行し、プラグインインストールを明示的に許可します。

    bash
    emqx ctl plugins allow $NAME-$VSN
    • {NAME}：プラグイン名（例：my_emqx_plugin）
    • {VSN}：プラグインのバージョン（例：1.0.0）

    このコマンド実行後、Dashboardからインストールを進められます。

  2. EMQX Dashboardの Management -> Plugins に移動します。

  3. + Install plugin ボタンをクリックし、インストールページを開きます。

  4. プラグインパッケージを選択またはドラッグしてアップロードします。

    plugin-list-empty

  5. Install ボタンをクリックしてインストールを完了します。プラグイン一覧に新しいプラグインが表示されます。

    plugin-list-installed

これでプラグインの起動・停止や設定が可能になります。Dashboardでプラグインをアンインストールするには、プラグイン一覧ページのActions列のMoreメニューからUninstallボタンをクリックしてください。

以前に許可したプラグインの許可を取り消すには、以下のいずれかを実行します。

  1. プラグインをアンインストールする（インストール済みの場合）。
  2. 以下のコマンドで明示的に許可を取り消す。
bash
emqx ctl plugins disallow $NAME-$VSN

CLI経由でのパッケージインストール ​

プラグインが既にビルドされ、my_emqx_plugin-1.0.0.tar.gzのtarballが用意されているとします。CLIから直接コンパイル済みプラグインパッケージをインストールする手順は以下の通りです。

  1. EMQXノード上で、tarballをEMQXのプラグインディレクトリにコピーします。

    $ cp my_emqx_plugin-1.0.0.tar.gz $EMQX_HOME/plugins

  2. プラグインをインストールします。

    $ emqx ctl plugins install my_emqx_plugin-1.0.0

  3. プラグイン一覧を確認します。

    $ emqx ctl plugins list

  4. プラグインを起動・停止します。

    $ emqx ctl plugins start my_emqx_plugin-1.0.0
$ emqx ctl plugins stop my_emqx_plugin-1.0.0

  5. プラグインをアンインストールします。

    $ emqx ctl plugins uninstall my_emqx_plugin-1.0.0

API経由でのパッケージインストール ​

プラグインが既にビルドされ、my_emqx_plugin-1.0.0.tar.gzのtarballが用意されているとします。APIを使用してプラグインをインストールする手順は以下の通りです。

  1. インストールを許可します。以下のコマンドを実行してプラグインのインストールを許可します。

    emqx ctl plugins allow my_emqx_plugin-1.0.0

  2. curlを使用してPOSTリクエストを送信し、プラグインをインストールします。

    $ curl -u $KEY:$SECRET -X POST http://$EMQX_HOST:18083/api/v5/plugins/install -H "Content-Type: multipart/form-data" -F "plugin=@my_emqx_plugin-1.0.0.tar.gz"

  3. プラグイン一覧を確認し、インストールが成功したかを確認します。

    $ curl -u $KEY:$SECRET http://$EMQX_HOST:18083/api/v5/plugins | jq

  4. プラグインを起動・停止します。

    $ curl -s -u $KEY:$SECRET -X PUT "http://$EMQX_HOST:18083/api/v5/plugins/my_emqx_plugin-1.0.0/start"
$ curl -s -u $KEY:$SECRET -X PUT "http://$EMQX_HOST:18083/api/v5/plugins/my_emqx_plugin-1.0.0/stop"

EMQX起動前にプラグインを事前インストールする ​

EMQX起動時にプラグインを即座に利用可能にしたい場合（例：カスタムDockerイメージをビルドする際など）、プラグインパッケージを展開し、事前にEMQXを設定しておくことが可能です。

以下の手順はDockerfileの例ですが、deb/rpmやベアメタルなど他のデプロイ方法でも同様の方法が適用できます。

  1. プラグインtarballをpluginsディレクトリにコピーし展開します。

    dockerfile
    COPY --chown=emqx:emqx my_emqx_plugin-1.0.0.tar.gz /opt/emqx/plugins/my_emqx_plugin-1.0.0.tar.gz

RUN cd /opt/emqx/plugins && \
    mkdir -p my_emqx_plugin-1.0.0 && \
    tar zxf my_emqx_plugin-1.0.0.tar.gz -C my_emqx_plugin-1.0.0

  2. EMQXのベース設定ファイルにプラグインを登録し、起動時に自動的に開始されるようにします。以下をbase.hoconに追記します。

    dockerfile
    RUN cat <<EOF >> /opt/emqx/etc/base.hocon
plugins {
    states = [
        {
            name_vsn = "my_emqx_plugin-1.0.0"
            enable = true
        }
    ]
}
EOF

    enable = trueに設定するとプラグインが自動起動され、enable = falseの場合はインストールのみで起動しません。

プラグインのアップグレード ​

EMQXでは同一プラグインの複数バージョンを同時にインストールすることはできません。

新しいバージョンのプラグインをインストールするには、

  • まず古いバージョンをアンインストールし、
  • その後新しいバージョンをインストールします。

プラグインの設定はインストール間で保持されます。