Runtime Manager エージェントのインストールまたは更新

logo cloud disabled logo hybrid active logo server active logo rtf disabled

Runtime Manager エージェントは Mule Runtime Engine (Mule) を Runtime Manager に登録します。Mule を登録した後は、登録された特定の環境と Anypoint Platform ビジネスグループ内で Runtime Manager によって管理できます。単一の Mule を複数の Runtime Manager ビジネスグループまたは環境には登録できません。

エージェントを接続するコンソールの種別に応じたパラメータを使用して、​amc_setup​ コマンドでエージェントをインストールして設定します。

amc_setup​ を実行すると、エージェントは指定された設定オプションで ​$MULE_HOME/conf/mule-agent.yml​ を作成します。

最初のインストール後は、以下を行うことができます。

  • amc_setup​ を再実行してエージェントの設定を変更する、またはエージェントのバージョンを更新する。

  • mule-agent.yml​ を修正してエージェントの設定を変更する。

    JMX 監視の外部サービスへの拡張など、一部の設定オプションは ​amc_setup​ では使用できません。これらは手動で ​mule-agent.yml​ ファイルに追加する必要があります。​mule-agent.yml でのエージェント設定の更新​を参照してください。

$MULE_HOME​ は、Mule をインストールした場所を指定する環境変数です。 次の手順では、Mac または Linux 用のパスを使用しています。Windows を使用している場合は、​$MULE_HOME​ パスを ​%MULE_HOME%​ に置き換えてください。

要件と制限事項

  • 単一の Mule Runtime Engine を複数の Runtime Manager ビジネスグループまたは環境には登録しないでください。

  • Mule を Runtime Manager に複数回登録しないでください。

  • 古い ​Mule Management Console (MMC)​ と Runtime Manager の両方に Mule Runtime Engine を登録しないでください。

    Mule が MMC で管理されている場合は、​amc_setup​ を実行する前に MMC から登録を解除してください。

    MuleSoft サポートは、MMC から Runtime Manager への移行に役立つ移行スクリプトを提供しています。

互換性

使用している Mule Runtime Manager のバージョンをサポートしている Runtime Manager エージェントのバージョンが必要です。互換性については、​Runtime Manager エージェントのリリースノート​で確認してください。

Mule 3.7.x 以前と API ゲートウェイバージョン 2.x 以前には、外部の分析ツールへのデータのエクスポートをサポートしない旧バージョンの Runtime Manager エージェントが含まれています。これらのバージョンを使用している場合は、エージェントの最新バージョンをダウンロードして更新してください。

前提条件

  • Enterprise ライセンスが最新であること。

  • Mule 3.6.0 以降および API ゲートウェイ 2.1 以降が動作していること。

  • エージェントをダウンロードする場合は、Enterprise サポートアカウントが必要です。

Mule インストールからのエージェントのインストール

エージェントは、Mule Runtime Engine のインストールにバンドルされています。

ツールをインストールするには、次の手順を実行します。

  1. Mule をダウンロードしてインストールします​。

  2. 環境に応じたパラメータを指定して ​$MULE_HOME/bin/amc_setup​ を実行します。

    amc_setup パラメータ​を参照してください。

.zip ファイルからエージェントをインストールします。

使用しているソフトウェア配布に含まれているバージョン以外のエージェントが必要な場合は、サポートポータルからダウンロードしてください。

サポートポータルからのエージェントのダウンロード

Mule Runtime Engine と Runtime Manager との互換性については、対応する ​Runtime Manager エージェントのリリースノート​で確認してください。

エージェントをダウンロードするには、次の手順を実行します。

  1. MuleSoft ヘルプセンター​を開きます。

  2. [Support (サポート)]​ タイルをクリックします。

  3. 右上にある ​[Login (ログイン)]​ をクリックし、自分の Anypoint Platform 認証情報を使用してログインします。

    エージェントのダウンロードには Enterprise サポートアカウントが必要です。
  4. MuleSoft サポートページで ​[Downloads (ダウンロード)]​ タブをクリックします。

  5. [Mule Agent (Mule エージェント)]​ をクリックします。

  6. エージェントを探して選択し、[Action (アクション)] 列で ​[Download (ダウンロード)]​ をクリックします。

エージェントのインストール

ダウンロードした .zip ファイルからエージェントをインストールするには、次の手順を実行します。

  1. Mule または API ゲートウェイランタイムを停止します。

  2. ダウンロードした ​agent-setup-VERSION.zip​ ファイルを ​$MULE_HOME/bin​ に展開します。

    確認メッセージが表示されたら、競合するファイルをすべて上書きします。

  3. 環境に応じたパラメータを指定して ​$MULE_HOME/bin/amc_setup​ を実行します。

    amc_setup パラメータ​を参照してください。

  4. Mule または API ゲートウェイランタイムを再起動します。

エージェントを更新する

以前のバージョンの ​amc_setup​ でエージェントをインストールしてある場合は、エージェントを更新して、現在のエージェント設定を ​$MULE_HOME/conf/mule-agent.yml​ に保持できます。

mule-agent.yml​ ファイルを保持する場合は、以下の変更が適用されます。

既存の Runtime Manager エージェントを更新する手順は、次のとおりです。

  1. Mule または API ゲートウェイランタイムを停止します。

  2. ダウンロードした ​agent-setup-VERSION.zip​ ファイルを ​$MULE_HOME/bin​ に展開します。

  3. 確認メッセージが表示されたら、競合するファイルをすべて上書きします。

  4. $MULE_HOME/bin/amc_setup -U​ を実行します。

    -U​ パラメータを使用して ​amc_setup​ を実行する場合は、コマンドラインで他のパラメータを指定することはできません。

  5. Mule または API ゲートウェイランタイムを再起動します。

Runtime Manager エージェントをアップグレードする場合は、Anypoint Monitoring エージェントのアンインストールスクリプトを実行してから、Anypoint Monitoring エージェントを再インストールする必要もあります。 「Anypoint Monitoring エージェントの更新」​を参照してください。

エージェントを更新するときの処理

エージェントを更新すると、​amc_setup​ スクリプトは以下の処理を行います。

  • エージェントの現在のバージョンをバックアップします。

    • $MULE_HOME/server-plugins/mule-agent-plugin​ を ​$MULE_HOME/tools/mule-agent-backup.zip​ にアーカイブします。

    • カスタムモジュール (通常は ​$MULE_HOME/server-plugins/mule-agent-plugin/lib/modules​ にあります) を ​$MULE_HOME/tools/mule-agent-modules-backup.zip​ にアーカイブします。

  • $MULE_HOME/server-plugins/mule-agent-plugin/lib​ 内のエージェントライブラリを更新します。

  • 現在の ​$MULE_HOME/conf/mule-agent.yml​ 設定ファイルを保持します。

  • $MULE_HOME/server-plugins/mule-agent-plugin/lib/modules​ のモジュールは変更しません。

    このディレクトリには、エージェントに追加された (エージェントの配布には含まれていない) カスタムモジュールが入っています。

  • デフォルトのエージェントトラストストア名を ​truststore.jks​ から ​anypoint-truststore.jks​ に変更します (バージョン 1.11.0 または 2.1.4 以降への更新)。

エージェントをロールバックする

エージェントの更新時に問題が発生するなどしてエージェントをロールバックする必要がある場合は、​mule-agent-backup.zip​ ファイルから以前のバージョンに復元します。 この ZIP ファイルには、エージェントのライブラリ、設定ファイル、コンパイルされたクラスが含まれます。

エージェントをロールバックする手順は、次のとおりです。

  1. Mule または API ゲートウェイランタイムを停止します。

  2. mule-agent-plugin​ ディレクトリに移動します。

    cd $MULE_HOME/server-plugins/mule-agent-plugin

  3. mule-agent-plugin​ ディレクトリにいることを確認します。

    pwd

  4. 既存のエージェントファイルを削除します。

    rm -r *

  5. バックアップ ZIP ファイルを ​mule-agent-plugin​ フォルダにコピーします。

    cp $MULE_HOME/tools/mule-agent-backup.zip .

  6. バックアップ ZIP ファイルから以前のバージョンのエージェントを復元します。

    unzip mule-agent-backup.zip

  7. バックアップ ZIP ファイルを削除します。

    rm mule-agent-backup.zip

  8. Mule または API ゲートウェイランタイムを再起動します。

エージェントのアンインストール

エージェントをアンインストールするには、次の手順を実行します。

  1. Mule または API ゲートウェイランタイムを停止します。

  2. 次のファイルを削除します。

    $MULE_HOME/conf/mule-agent.jks
    $MULE_HOME/conf/mule-agent.yml
  3. Mule または API ゲートウェイランタイムを再起動します。

amc_setup パラメータ

amc_setup​ のパラメータを指定することにより、以下を行うことができます。

使用できるオプションを見るには、​./amc_setup --help​ を実行します。

パラメータ 説明

--help

コマンドのヘルプをコマンドラインに表示します。

-U

--update

既存の ​mule-agent.yml​ 設定ファイルを保持したままエージェントを更新します。

-U​ を使用して以前のバージョンのエージェントを更新する場合は、コマンドラインで他のパラメータを指定することはできません。

-E

--encrypt

既存の ​mule-agent.yml​ ファイルでパスワードを暗号化します。

このオプションのみを使用してパスワードを暗号化します。 詳細は、​既存の mule-agent.yml ファイルでのパスワードの暗号化​を参照してください。

--decrypt

たとえばマスタパスワードを変更する前に、既存の ​mule-agent.yml​ ファイルでパスワードを復号化します。

このオプションのみを使用してパスワードを復号化します。 詳細は、​マスタパスワードを更新する​と​プレーンテキストでの mule-agent.yml のパスワードの表示​を参照してください。

--mule-home

mule-home-directory

$MULE_HOME​ ディレクトリの場所を指定します。

インストールスクリプトを ​$MULE_HOME/bin​ 以外の場所から実行した場合は、このオプションを使用します。

amc_setup​ スクリプトは、​--mule-home​ で指定されたディレクトリに対して相対的な ​../conf​ から ​mule-agent.yml​ ファイルを読み込みます。たとえば、​--mule-home​ の値が ​/tmp/Mule/bin​ であれば ​amc_setup​ は ​mule-agent.yml​ を ​/tmp/Mule/conf​ から読み込みます。

--skip-gateway-clientid

API ゲートウェイの ​client_id​ と ​client_secret​ の設定をスキップします。

-I

--insecure

暗号化されていない REST 接続を使用するようにエージェントを設定します。

非セキュア接続チャネル​を参照してください。

このオプションは、​$MULE_HOME/conf/mule-agent.yml​ の内容を置き換えます。

-S

--secure

オンプレミス管理コンソールと TLS 接続を確立するようにエージェントを設定します。

セキュア接続チャネル​を参照してください

このオプションは、​$MULE_HOME/conf/mule-agent.yml​ の内容を置き換えます。

-H

--hybrid

token

server-name

Anypoint Platform PCE または MuleSoft が管理するクラウドベースの Anypoint Platform のどちらかと接続するようにエージェントを設定します。

  • token​ は、base64 でエンコードされた文字列で、Mule を Runtime Manager に登録するビジネスグループと環境を正確に指定します。

  • server-name​ はインスタンス名で、Runtime Manager コンソールでこの Mule を識別します。

    この名前は、ビジネスグループの環境内で一意である必要があります。

-P

--proxy

proxy-host

proxy-port

proxy-user

proxy-password

接続に登録するときに使用するプロキシ設定を指定します。

-R

--region

region

デプロイ先のリージョンを指定します。使用できるリージョンは ​prod​、​eu1​、​us_gov​ です。

クラウドベースの Runtime Manager を使用した Mule の登録

logo cloud disabled logo hybrid active logo server disabled logo rtf disabled

Anypoint Platform Runtime Manager のクラウドベースコンソールを使用して Mule を登録するには、以下が必要です。

  • Anypoint Platform の特定のビジネスグループ用の特定の環境を識別する有効な登録トークン

  • Runtime Manager コンソールで Mule を識別するインスタンス名

Mule を登録するには、次の手順を実行します。

  1. Runtime Manager の左側のメニューで ​[Servers (サーバ)]​ をクリックします。

  2. [Add Server (サーバを追加)]​ ボタンをクリックします。

  3. サーバの一意な名前を入力します。

    サーバ名には最大 60 文字の英数字 (a-z, A-Z、0-9)、ピリオド (.)、ハイフン (-)、アンダースコア (_) を含めることができますが、スペースやその他の特殊文字は含めることができません。 Runtime Manager では、サーバ名で Unicode 文字がサポートされています。

    サーバ名は環境内で一意である必要がありますが、同じ組織が異なる環境に存在している場合は、同じサーバ名を使用できます。

    Runtime Manager により、​amc_setup​ コマンドが生成されます。 このコマンドには、指定したサーバ名 (​server-name​) と環境に Mule を登録するために必要な登録トークン (​token​) が含まれます。 登録トークンには、組織 ID と現在の環境が含まれます。

    [Add Server (サーバを追加)] ウィンドウの amc_setup コマンド
    Figure 1. 矢印は、​[Add Server (サーバを追加)]​ ウィンドウの ​amc_setup​ コマンドを示しています。
  4. [Copy command (コマンドをコピー)]​ をクリックしてコマンドをコピーします。

  5. ターミナルウィンドウで次の操作を実行します。

    1. 登録する Mule インスタンスの ​$MULE_HOME/bin​ ディレクトリに変更します。

    2. mule-agent.yml​ ファイルでパスワードを暗号化する場合、​AGENT_VAR_master_password​ 環境変数をマスタパスワードに設定します。

      export AGENT_VAR_master_password=myPassword

    3. コマンドラインにコマンドを貼り付けます。

    4. amc_setup​ コマンドラインで他のパラメータを指定します。

      amc_setup パラメータ​を参照してください。

      amc_setup​ コマンドの例を次に示します。

      ./amc_setup -H myToken myMuleServer --proxy myProxy-host myProxy-port myProxy-user myProxy-password

amc_setup​ コマンドは ​$MULE_HOME/conf/mule-agent.yml​ ファイルを生成します。

mule-agent.yml ファイルの例

暗号化されたパスワードを含めて、​-H​ オプションによって生成された ​mule-agent.yml​ ファイルの例を次に示します。

transports:
  rest.agent.transport:
    enabled: false
  websocket.transport:
    consoleUri: wss://mule-manager.anypoint.mulesoft.com:443/mule
    handshake:
      enabled: true
      body:
globalConfiguration:
  security:
    keyStorePassword: "![PBEWITHSHA1ANDDESEDE,WdPmAQMIC8Atr5iK4phjmbZbs9XFLLiH1eDhA7AmnpKUaPDhp40OB4uKZ6JUMW44]"
    keyStoreAlias: agent
    keyStoreAliasPassword: "![PBEWITHSHA1ANDDESEDE,WdPmAQMIC8Atr5iK4phjmbZbs9XFLLiH1eDhA7AmnpKUaPDhp40OB4uKZ6JUMW44]"
  authenticationProxy:
    endpoint: https://data-authenticator.anypoint.mulesoft.com:443
  proxyConfiguration:
    password: '![PBEWITHSHA1ANDDESEDE,VIs82yFDp66lnsL/Rss8q8js/zPDQ8+HJpdNepdZtA9obeDj5u+z4HIocsbLvXow]'

Anypoint Platform PCE Runtime Manager を使用した Mule の登録

logo cloud disabled logo hybrid disabled logo server active logo rtf disabled

Anypoint Platform Private Cloud Edition (Anypoint Platform PCE) を使用すると、すべての Runtime Manager サービスは、MuleSoft が管理するクラウド環境ではなくオンプレミスで実行されます。

PCE Runtime Manager で Mule を登録するには、次の手順を実行します。

  1. Anypoint Platform PCE アカウントにログインします。

  2. プラットフォームの DNS エントリが正しくセットアップされていることを確認します。

    DNS or IP (DNS または IP)​ を参照してください。

  3. Mule を登録するビジネスグループと環境を選択します。

  4. 選択した環境の左側のメニューで ​[Servers (サーバ)]​ をクリックします。

  5. [Add Server (サーバを追加)]​ ボタンをクリックします。

    Runtime Manager は、Mule を環境に登録するために使用する ​token​ および ​server-name​ と共に ​amc_setup​ コマンドを生成します。

    登録トークンには、組織の ID と現在の環境が含まれます。

  6. [Copy (コピー)]​ をクリックしてこのコマンドをコピーします。

  7. ターミナルウィンドウで、登録する Mule インスタンスの ​$MULE_HOME/bin​ ディレクトリに変更します。

  8. コマンドラインにコマンドを貼り付けます。

  9. インスタンス名 ​server-name​ を、Runtime Manager コンソールで Mule の表示ラベルとして使用する一意のインスタンス名に変更します。

  10. amc_setup​ コマンドラインで他のパラメータを指定します。

    amc_setup パラメータ​を参照してください。

  11. Runtime Manager が Mule インスタンスを管理するのに使用するサービスの URL を指定するパラメータをコマンドラインに付加します。

    PCE Runtime Manager の amc_setup パラメータ​を参照してください。

    amc_setup​ コマンドの例を次に示します。

    ./amc_setup -H myToken myMuleServer -A +http://$DOCKER_IP_ADDRESS:443/hybrid/api/v1+ -W "wss://AnypointPlatformHost:8889/mule" -C https://AnypointPlatformHost/accounts -F https://AnypointPlatformHost/apiplatform

amc_setup​ コマンドは ​$MULE_HOME/conf/mule-agent.yml​ ファイルを生成します。

PCE Runtime Manager の amc_setup パラメータ

Anypoint Platform PCE Runtime Manager を使用した Mule の登録で必要な追加のパラメータを下表に示します。これらのパラメータは、​./amc_setup -H token server-name​ コマンドに追加します。

これらのパラメータは、REST API 接続を設定する ​-I​ パラメータや ​S​ パラメータとは一緒に使用しないでください。

パラメータ 説明

-A

--amc-host

amc-host

Runtime Manager のローカルインスタンスのサービスの場所を示す URL を指定します (例: https://10.0.0.1:443/hybrid/v1​)。

サービスが使用可能かどうかは、​AMC_HOST/​hybrid/v1 でテストできます。

-W

--mcm-host

mcm-host

MCM のローカルインスタンスのサービスの場所を示す URL を指定します (例: wss://10.0.0.2:8889/mule​)。

サービスが使用可能かどうかは、​MCM_HOST/​mule でテストできます。

-C

--cs-host

core-services-host

アクセス管理のローカルインスタンスのサービスの場所を示す URL を指定します (例: https://10.0.0.3:443/accounts​)。

サービスが使用可能かどうかは、core-services-host​/accounts でテストできます。

-D

--contract-caching-service-host

contract-caching-service-host

コントラクトキャッシュサービスのローカルインスタンスのサービスの場所を示す URL を指定します (例: https://10.0.0.4:8080​)。

-F

--api-platform-host

api-platform-host

API Manager のローカルインスタンスのサービスの場所を示す URL を指定します (例: https://10.0.0.5:443/apiplatform​)。

サービスが使用可能かどうかは、​API_PLATFORM_HOST/​apiplatform でテストできます。

-Z

--auth-proxy-host

auth-proxy-host

認証プロキシのサービスの場所を示す URL を指定します (例:`https://10.0.0.3:8080`​)。

既存の mule-agent.yml ファイルでのパスワードの暗号化

エージェントを Runtime Manager に登録するときに ​AGENT_VAR_master_password​ 環境変数を設定しなかった場合、後から ​mule-agent.yml​ ファイルで次のパスワードを暗号化できます。

  • keystorePassword​: mule-agent.jks​ ファイルにアクセスするために使用するキーストアパスワード

  • keystoreAliasPassword​: mule-agent.jks​ ファイルにアクセスするために使用するキーストアの別名パスワード

  • password​: プロキシサーバに対する認証に使用するパスワード

前提条件

  • Runtime Manager エージェントバージョン 2.4.17

    以前のバージョンのエージェントを更新するには、​エージェントを更新する​を参照してください。

パスワードを暗号化する

mule-agent.yml​ ファイルのパスワードを暗号化する手順は、次のとおりです。

  1. AGENT_VAR_master_password​ 環境変数をマスタパスワードに設定します。

    export AGENT_VAR_master_password=myPassword

  2. 暗号化ユーティリティを実行します。

    $MULE_HOME/bin/amc_setup --encrypt

    暗号化ユーティリティでは、​mule-agent.yml​ ファイルの ​keystorePassword​ 項目、​keystoreAliasPassword​ 項目、​password​ 項目のパスワードが暗号化されたパスワードに置き換えられます。たとえば、次のようになります。

    globalConfiguration:
      security:
        keyStorePassword: '![PBEWITHSHA1ANDDESEDE,Fe4kl2UBnGRoyh7H2v9lq+QSG7Pe6ZP8k34xmZEHmcAb1jABAwPLk2xWrGtSt1iE]'
        keyStoreAlias: agent
        keyStoreAliasPassword: '![PBEWITHSHA1ANDDESEDE,EtqRDPq7UTxDHzZGpOGazfcveEi832Pqm1mqhlwYRGLZGh9NSNXie6nAZr09b3iT]'
      authenticationProxy:
        endpoint: https://data-authenticator.anypoint.mulesoft.com:443
      proxyConfiguration:
        password: '![PBEWITHSHA1ANDDESEDE,VIs82yFDp66lnsL/Rss8q8js/zPDQ8+HJpdNepdZtA9obeDj5u+z4HIocsbLvXow]'

暗号化されたパスワードは、先頭が ​!​ で角括弧 ​[ ]​ で囲まれます。

パスワードを更新して再暗号化する

mule-agent.yml​ ファイルの暗号化されたパスワードを更新する手順は、次のとおりです。

  1. mule-agent.yml​ を編集します。

  2. 暗号化されたパスワードを新しいプレーンテキストのパスワードに置き換えます。

  3. AGENT_VAR_master_password​ 環境変数を設定します。

    export AGENT_VAR_master_password=myPassword

  4. 暗号化ユーティリティを実行します。

    $MULE_HOME/bin/amc_setup --encrypt

プレーンテキストでの mule-agent.yml のパスワードの表示

mule-agent.yml​ のパスワードをプレーンテキストで表示するには、復号化ユーティリティを実行します。

$MULE_HOME/bin/amc_setup --decrypt

このコマンドにより、プレーンテキストのパスワードが含まれる ​mule-agent.yml​ ファイルの内容が出力されます。

マスタパスワードを更新する

マスタパスワードを更新する手順は、次のとおりです。

  1. 復号化ユーティリティを実行します。

    $MULE_HOME/bin/amc_setup --decrypt

  2. AGENT_VAR_master_password​ 環境変数を新しいマスタパスワードに設定します。

    export AGENT_VAR_master_password=myNewPassword

  3. 暗号化ユーティリティを実行します。

    $MULE_HOME/bin/amc_setup --encrypt

Was this article helpful?

💙 Thanks for your feedback!