intra-mart Accel Platform 設定ファイルリファレンス 第33版 2023-10-01

ネットワーク設定

概要

intra-mart Accel Platform を分散環境で利用する場合のクラスタリングを行うための設定です。

モジュール
コアモジュール
フォーマットファイル(xsd)
WEB-INF/schema/network-agent-config.xsd
設定場所
WEB-INF/conf/network-agent-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<network-agent-config
    xmlns="http://intra-mart.co.jp/system/service/client/config/network-agent-config"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://intra-mart.co.jp/system/service/client/config/network-agent-config ../schema/network-agent-config.xsd">
  <id>clusterId</id>
  <bind-port>5200</bind-port>
  <port-range>2</port-range>
  <preferIPv4Stack>true</preferIPv4Stack>

  <TCP>
    <initial-hosts>
      <host address="127.0.0.1"/>
    </initial-hosts>
  </TCP>
</network-agent-config>

リファレンス

クラスタリングID

タグ名 id
クラスタリングを構成するグループの一意のIDです。
Webアプリケーション毎に一意となるIDを設定してください。

【設定項目】

<network-agent-config>
  <id>clusterId</id>
</network-agent-config>

必須項目
複数設定 ×
設定値・設定する内容 Webアプリケーション毎に一意のIDを設定します。
単位・型 文字列 (xxxxxxx)
省略時のデフォルト値 なし
親タグ network-agent-config

注意

Webアプリケーション間で同じIDが設定されている場合、予期しないエラーが発生する可能性があります。
必ず、Webアプリケーション毎に一意となるIDを指定してください。

ポート番号

タグ名 bind-port
Web Application Server 間で通信を行う際に利用するポート番号を指定します。

【設定項目】

<network-agent-config>
  <bind-port>5200</bind-port>
</network-agent-config>

必須項目
複数設定 ×
設定値・設定する内容 利用するポート番号を設定します。
単位・型 数値 (1024 - 65535)
省略時のデフォルト値 なし
親タグ network-agent-config

ポートレンジ

タグ名 port-range
bind-portで指定されたポート番号が既に使用されている場合に代替えとして利用するポート番号のレンジを指定します。
例えば、bind-portに5200、port-rangeに2が設定されており、5200番ポートが既に利用されている場合は5201番ポートを利用します。

【設定項目】

<network-agent-config>
  <port-range>2</port-range>
</network-agent-config>

必須項目
複数設定 ×
設定値・設定する内容 利用するポート番号のレンジを設定します。
単位・型 数値 (0 - )
省略時のデフォルト値 なし
親タグ network-agent-config

プロトコルバージョン設定

タグ名 preferIPv4Stack
通信を行う際のプロトコルバージョンを指定します。
trueを設定するとIPv4 ソケットを使用して通信を行います。

【設定項目】

<network-agent-config>
  <preferIPv4Stack>true</preferIPv4Stack>
</network-agent-config>

必須項目
複数設定 ×
設定値・設定する内容
false IPv6 ソケットを使用して通信を行います。
true IPv4 ソケットを使用して通信を行います。
単位・型 真偽値 (true/false)
省略時のデフォルト値 なし
親タグ network-agent-config

注意

intra-mart Accel Platform では、IPv6をサポートしていないため、必ずtrueを設定してください。

最大通信スレッド数

タグ名 max-threads
サーバ間通信に利用するスレッドの最大数を指定します。
最大通信スレッド数についての詳細は「サービス仕様書 分散環境の構築 サーバ間通信で利用するスレッド数の設定」を参照してください。

【設定項目】

<network-agent-config>
  <max-threads>10</max-threads>
</network-agent-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 サーバ間通信を行うスレッドの最大スレッド数
単位・型 数値
省略時のデフォルト値 10 (マルチキャスト設定を行っている場合は 8)
親タグ network-agent-config

到達確認/再送用最大通信スレッド数

タグ名 max-oob-threads
到達確認や再送などの通信に利用するスレッドの最大数を指定します。
到達確認/再送用最大通信スレッド数についての詳細は「サービス仕様書 分散環境の構築 サーバ間通信で利用するスレッド数の設定」を参照してください。

【設定項目】

<network-agent-config>
  <max-oob-threads>8</max-oob-threads>
</network-agent-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 通信内容の到達確認や再送を行うスレッドの最大スレッド数
単位・型 数値
省略時のデフォルト値 8
親タグ network-agent-config

ユニキャスト設定

タグ名 TCP
この設定を行うとユニキャストでの通信を行います。

【設定項目】

<network-agent-config>
  <TCP>
    ...
  </TCP>
</network-agent-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 ユニキャストでの通信を行う際に必要になる設定をします。
単位・型 なし
省略時のデフォルト値 なし
親タグ network-agent-config

注意

この設定を行った場合、マルチキャストの設定(UDP)は行えません。

マルチキャスト設定

タグ名 UDP
この設定を行うとマルチキャストでの通信を行います。

【設定項目】

<network-agent-config>
  <UDP>
    ...
  </UDP>
</network-agent-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 マルチキャストでの通信を行う際に必要になる設定をします。
単位・型 なし
省略時のデフォルト値 なし
親タグ network-agent-config

注意

この設定を行った場合、ユニキャストの設定(TCP)は行えません。

初期起動ホスト設定

タグ名 initial-hosts
intra-mart Accel Platform を初期起動時のサーバのホストアドレスを設定します。
初期起動ホストはクラスタリングを行う際に通信を行う起点として動作します。
後から起動したサーバはこの初期起動ホストに指定されているサーバと通信を行い、クラスタグループ内のメンバーを取得します。

【設定項目】

<network-agent-config>
  <TCP>
    <initial-hosts>
      ...
    </initial-hosts>
  </TCP>
</network-agent-config>

必須項目
複数設定 ×
設定値・設定する内容 初期起動時するサーバのホストアドレスを設定します。
単位・型 なし
省略時のデフォルト値 なし
親タグ TCP

ホストアドレス設定

タグ名 host
Web Application Server のサーバアドレスを指定します。

【設定項目】

<network-agent-config>
  <TCP>
    <initial-hosts>
      <host address="127.0.0.1"/>
    </initial-hosts>
  </TCP>
</network-agent-config>

必須項目
複数設定
設定値・設定する内容 サーバアドレスを設定します。
単位・型 文字列 (xxx.xxx.xxx.xxx)
省略時のデフォルト値 なし
親タグ initial-hosts

【属性】

属性名 説明 必須 デフォルト値
address サーバアドレスを指定します。 なし

コラム

  • 「address」属性にはホスト名を設定することも可能です。
  • ホスト名に紐づくIPアドレスが変わった場合はAPサーバを再起動してください。
<TCP>
 <initial-hosts>
   <host address="app0-host"/>
   <host address="app1-host"/>
   <host address="app2-host"/>
 </initial-hosts>
</TCP>

マルチキャストアドレス

タグ名 mcast-address
通信時に使用するマルチキャストアドレスを指定します。

【設定項目】

<network-agent-config>
  <UDP>
    <mcast-address>228.10.10.10</mcast-address>
  </UDP>
</network-agent-config>

必須項目
複数設定 ×
設定値・設定する内容 マルチキャストアドレスを設定します。
単位・型 文字列 (xxx.xxx.xxx.xxx)
省略時のデフォルト値 なし
親タグ UDP

コラム

  • <mcast-address>にはホスト名を設定することも可能です。
  • ホスト名に紐づくIPアドレスが変わった場合はAPサーバを再起動してください。
<UDP>
  <mcast-address>app0-host</mcast-address>
</UDP>

マルチキャストポート番号

タグ名 mcast-port
通信時に使用するマルチキャストアドレスのポート番号を指定します。

【設定項目】

<network-agent-config>
  <UDP>
    <mcast-port>45588</mcast-port>
  </UDP>
</network-agent-config>

必須項目
複数設定 ×
設定値・設定する内容 マルチキャストアドレスのポート番号を設定します。
単位・型 数値 (1024 - 65535)
省略時のデフォルト値 なし
親タグ UDP

初期起動ホスト数

タグ名 initial-members
intra-mart Accel Platform を初期起動時のサーバ台数を指定します。

【設定項目】

<network-agent-config>
  <UDP>
    <initial-members>1</initial-members>
  </UDP>
</network-agent-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 初期起動時のサーバ台数を設定します。
単位・型 数値 (0 - )
省略時のデフォルト値 なし
親タグ UDP