server.conf.yamlファイルを変更して統合サーバーを設定する

IBM® App Connect Enterprise 統合サーバーは、設定 server.conf.yaml ファイルのプロパティを変更することで構成できます。 変更する必要がある server.conf.yaml ファイルの場所は、独立統合サーバー、または統合ノードによって管理されている統合サーバーのどちらを構成するかによって異なります。

始める前に

コマンド環境のセットアップで説明するように、コマンド環境をセットアップする。

このタスクの概要

統合サーバーを作成する際、'server.conf.yamlファイルにプロパティを設定し、統合サーバーと関連リソースの動作を設定する。 例えば、REST 管理ポートおよび HTTPS ポートを設定できます。 または、統合サーバーのトレースレベル、アクティビティログ、 JVM、および統計データのレポート設定を構成できます。 メッセージ・フローを通過するすべてのメッセージを記録するように統合サーバーを構成し、記録されたこれらのメッセージを使用して単体テストを生成することもできます。

独立した統合サーバーの場合、'server.conf.yaml設定ファイルは、'mqsicreateworkdirコマンドを使用して統合サーバーの作業ディレクトリを作成するときに、自動的に作成されます。 server.conf.yaml ファイルは、指定された作業ディレクトリー <work directory>/server.conf.yaml のルートに作成されます。

統合サーバーを変更するコマンドを使用した場合、統合サーバーの作業ディレクトリーの下に overrides ディレクトリーが作成されます。 このoverridesディレクトリには、コマンドによって設定されるプロパティ値を含む、追加の server.conf.yaml コンフィギュレーション・ファイルが含まれている。例えば、 <work directory>/overrides/server.conf.yaml。 この'overrides/server.conf.yamlファイルのプロパティの値は、統合サーバーの'server.conf.yamlファイル(<work directory>/server.conf.yaml)で設定した値を上書きします。

あるプロパティーが、統合サーバーの server.conf.yaml ファイル内に設定されていて、overrides ディレクトリー内にも設定されている (/overrides/server.conf.yaml) 場合、overrides ディレクトリー内に設定されているプロパティー値が使用されます。 したがって、統合サーバーが期待される設定を使用していない場合、overrides ディレクトリの 'server.conf.yamlファイルにある期待されるプロパティ値が、コマンドによって上書きされているかどうかを確認します。 コマンドによる設定を手動で上書きするには、overridesディレクトリの'server.conf.yamlファイルのプロパティを編集するか、overridesディレクトリからエントリーを削除して、ベースとなる'server.conf.yamlファイルを修正する。

統合ノードによって管理されている統合サーバーの場合、各サーバーには、統合ノードの node.conf.yaml 構成ファイルの共通設定をオーバーライドする独自の server.conf.yaml 構成ファイルがあります。 統合ノードを作成すると、'node.conf.yamlファイルは'$MQSI_WORKPATH/components/<Node name>/node.conf.yamlにある。

統合ノードを変更するコマンドを使用した場合、変更は統合ノードのオーバーライド node.conf.yaml ファイルに保存されます。 このファイルは、コマンドラインを使って統合ノードを作成するで説明したように、'$MQSI_WORKPATH/components/<Node name>/overrides/node.conf.yamlにある。 統合ノードの管理対象統合サーバーを作成すると、専用の server.conf.yaml ファイルにサーバー固有の設定が作成されます。 サーバー固有のファイルは '$MQSI_WORKPATH/components/<Node name>/servers/<Server name>/server.conf.yaml にある。

コマンドを使用してこの統合サーバーを変更すると、変更は $MQSI_WORKPATH/components/<Node name>/servers/<Server name>/overrides/server.conf.yaml に保存されます。 この'overrides/server.conf.yamlファイルのプロパティの値は、'<Node name>/servers/<Server name>/server.conf.yamlファイルで設定した値を上書きする。

手順

  1. 統合サーバーがまだ存在していない場合は、 統合サーバーの作成の手順に従って作成できます。
  2. YAML エディターを使用して、 server.conf.yaml ファイルを開きます。

    IBM App Connect Enterprise ツールキットに組み込まれているYAMLエディタを使用して、ファイルを編集できます。 アプリケーション開発ビューでファイルをダブルクリックするか、ファイルを右クリックして'で開く > YAMLエディタ選択する。 プレーンテキストエディターを使ってファイルを編集する場合、タブ文字 (YAML では無効) を含めず、ファイルの内容を検証するために YAML バリデーションツールを使います。

  3. ファイル内で変更する必要があるプロパティーを変更します。 すべてのプロパティはYAMLファイルに記述されています。
    例えば、以下のプロパティを変更することができる。
    • RestAdminListenerセクションで、'Portプロパティに、統合サーバーとの主な通信方法である REST 管理ポートで使用する値を設定します。 (デフォルト値は 7600)。
    • ResourceManagers / HTTPConnectorセクションで、'ListenerPortに値を設定し、HTTPInputノードを使用しているフローにメッセージを送信できるようにする。 (デフォルト値は 7800)。
    • ResourceManagers / JVMセクションで、フローデバッガを使用できるように、'jvmDebugPortに値を設定する。 例えば、このプロパティーを 6511 に設定します。

    また、' server.conf.yamlファイルの 'RecordedMessageManagerセクションにプロパティを設定することで、メッセー ジフローを通過するすべてのメッセージを記録するように、統合サーバーを設 定することもできる。 メッセージ・フローで記録されたメッセージからテストを生成する で説明するように、これらの記録されたメッセージを使用して、フローのユニット・テストを生成することができます。

  4. 変更内容を server.conf.yaml ファイルに保存します。

    server.conf.yamlファイルでプロパティを設定した後に、統合サーバーを変更するコマンドを実行すると、統合サーバーの作業ディレクトリの下に overrides ディレクトリが作成されます。 このoverridesディレクトリには、もう一つの server.conf.yaml コンフィギュレーション・ファイルが含まれている。このファイルには、コマンドによって設定されるプロパティ値が含まれている。例えば、 <work directory>/overrides/server.conf.yaml。 この 'overrides/server.conf.yamlファイルのプロパティの値は、統合サーバーの 'server.conf.yamlファイル (<work directory>/server.conf.yaml) で設定した値を上書きします。コマンドの結果を手動で上書きするには、overrides ディレクトリの 'server.conf.yamlファイルでプロパティを編集するか、overrides ディレクトリからエントリを削除して、ベースとなる 'server.conf.yamlファイルを変更します。

  5. 保護されたリソース (データベースなど) に接続するときに統合サーバーが使用するセキュリティー資格情報を指定します。
    • App Connect Enterprise ボールトに暗号化された形式で保管されている資格情報を使用して、保護されたリソースに接続するように独立統合サーバーを構成できます。 mqsicredentials コマンドまたは管理用 REST API を使用して、セキュリティ認証情報を構成できます。 ステップ 1で作成した統合サーバーの作業ディレクトリーを指定します。 暗号化された認証情報は、統合サーバーのデータ保管庫に保存されます。このデータ保管庫は、mqsivault コマンドを使用して構成できます。 詳細については、暗号化されたセキュリティ認証情報の設定を参照してください。 例えば、統合サーバーのボールトを作成するには、以下のように指定します。
      mqsivault --work-dir c:\myaceworkdir --vault-key vaultKey --create
      セキュリティー資格情報を構成するには、以下のように指定します。
      mqsicredentials --work-dir c:\myaceworkdir --vault-key vaultkey --create --credential-type jdbc --credential-name secID --username iibuser --password password

      資格情報の種類に関する詳細については、 「資格情報の種類」 を参照してください。

    • あるいは、 mqsisetdbparms コマンドを使用することもできます。 次の例に示すように、'-wパラメーターを使用して、ステップ1で作成した統合サーバーの作業ディレクトリを指定します。
      mqsisetdbparms -w c:\myaceworkdir -n jdbc::secID -u iibuser -p password

      このコマンドを実行すると、ユーザーIDとパスワードは IBM App Connect Enterprise の認証情報ストアに安全に保存されます。 コマンド mqsisetdbparms の使用方法の詳細については、 mqsisetdbparms コマンドを参照してください。

  6. オプション: '統合サーバーのワークディレクトリの 'runフォルダに BAR ファイルを追加することで、統合サーバーの起動時に実行するアプリケーションを設定することができます。 詳細については、 mqsibar コマンドを参照してください。
  7. 統合サーバーを再始動します。 server.conf.yaml ファイルに設定したプロパティーは、統合サーバーの始動時に有効になります。 これらのプロパティーを再び変更した場合は、後続の変更を有効にするために、統合サーバーの再始動が必要です。 詳細については、 「統合サーバーの開始」 を参照してください。

    統合サーバーの再起動に失敗した場合、YAMLの解析エラーが失敗の原因になっていないか確認してください。 独立統合サーバーの場合、構文解析エラーは stderr ログに報告されます。 統合ノードによって管理される統合サーバーの場合、YAML 構文解析エラーは統合サーバーの console.txt ファイルに報告されます。 詳細については、 標準システムログを参照してください。