付録N.8 オートスケール連携スクリプト
JP1/Baseではオートスケール機能と連携した運用に必要となる設定や操作をバッチ処理としてまとめたスクリプト(オートスケール連携スクリプト)を提供しています。
(1) ファイル構成
オートスケール連携スクリプトは,マネージャーまたはエージェントで実行する「スクリプトファイル」,スクリプトの実行に必要な変数を定義した「スクリプト定義ファイル」,スクリプトが内部処理で使用する「内部ファイル」で構成されます。
なお,スクリプトファイルは,Windowsの場合PowerShellスクリプト,Linuxの場合シェルスクリプトです。
スクリプトファイル名 |
適用ホスト |
説明 |
---|---|---|
|
エージェント |
スケールアウト時にエージェントホストで実行するスクリプトとそのモデルファイルです。エージェントの初期セットアップを実施して,マネージャーにJP1イベントでスケールアウトを通知します。 |
|
マネージャー |
スケールアウト時にマネージャーホストで実行するスクリプトとそのモデルファイルです。追加されたホストをマネージャーの監視対象に追加します。 |
|
マネージャー |
スケールイン時にマネージャーホストで実行するスクリプトとそのモデルファイルです。削除されたホストを,マネージャーの監視対象から削除します。 |
定義ファイル名 |
適用ホスト |
説明 |
---|---|---|
jbsas_setup_agent.ini jbsas_setup_agent.ini.model |
エージェント |
エージェントホストが実行するスクリプトファイル(jbsas_setup_agent)が使用するシェル変数を定義したファイルとそのモデルファイルです。 |
jbsas_setup_manager.ini jbsas_setup_manager.ini.model |
マネージャー |
マネージャーホストが実行するスクリプトファイル(jbsas_add_agentまたはjbsas_del_agent)が使用するシェル変数を定義したファイルとそのモデルファイルです。 |
ファイル名 |
適用ホスト |
説明 |
---|---|---|
|
共通(マネージャーおよびエージェント) |
スクリプトファイルが内部処理で使用する関数をまとめたファイルとそのモデルファイルです。 |
jbsas_hosts |
マネージャー |
監視中のエージェントホストの情報を管理するためのファイルです。 |
(2) 格納先ディレクトリ
オートスケール連携スクリプトのファイルはすべて次のディレクトリに格納されます。
- Windowsの場合
-
インストール先フォルダ\tools\cloud\
- Linuxの場合
-
/opt/jp1base/tools/cloud/
(3) スクリプトファイル
スクリプトファイルの処理内容については,「付録N.3 スケールアウト時に監視対象に追加する」および「付録N.4 スケールイン時に監視を解除する」を参照してください。
スクリプトファイルは編集する必要はありません。任意にカスタマイズすることもできますが,追加・変更した処理部分に関しては,サポートサービスの対象外となるため注意してください。
JP1/Base 11-00から上書きインストールした場合,スクリプトファイル(jbsas_add_agent.ps1など)は上書きされません。モデルファイル(jbsas_add_agent.ps1.modelなど)をスクリプトファイル名でコピーして置き換えて使用してください。
(4) スクリプト定義ファイル
- 形式
変数名1=変数値1 [変数名2=変数値2] :
- 記述内容
-
-
変数名,変数値,および「=」の前後にスペースおよびタブを入れないでください。
-
Linuxの場合,変数値に空白を含む場合は「"」で囲んでください。
-
- 定義の反映時期
-
スクリプトファイル実行時に読み込まれます。
- 設定パラメーター
-
jbsas_setup_agent.iniファイルおよびjbsas_setup_manager.iniファイルで設定するパラメーターについて,次の表に示します。
表N‒6 jbsas_setup_agent.iniファイルの設定パラメーター 変数名
変数値(既定値)
設定要否
説明
ManagerHostName
Manager
○
マネージャーホスト名を指定します。
ホスト名に使用できる文字および文字数については,関連製品(JP1/IMまたはJP1/PFM)のマニュアルを参照してください。
JP1EventID
1011
△
マネージャーに送信するJP1イベントのイベントIDを指定します。
指定できる範囲は,0〜1FFF,7FFF8000〜7FFFFFFFです。
JP1EventMsg
- Windowsの場合
-
Agent host ($AgentHostName) has scale-out.
- Linuxの場合
-
"Agent host ($AgentHostName) has scale-out."
△
マネージャーに送信するJP1イベントのメッセージを指定します。
メッセージは,1,023バイト以内の文字列で指定してください。
既定値の$AgentHostNameにはエージェントホスト名が出力されます。
表N‒7 jbsas_setup_manager.iniファイルの設定パラメーター 変数名
変数値(既定値)
設定要否
説明
JbsrtDistribByScaleIn
NO
△
スケールイン時に構成定義情報を更新するかどうかを指定します。
- YESを指定した場合
-
構成定義ファイルから対象ホストを削除して,構成定義を配布します。対象ホストはすぐに構成定義情報の下位ホストから削除されます。
なお,通信の遅延によって監視が大幅に遅れるおそれがあるため,運用上の特別な理由がないかぎり,YESは指定しないでください。YESを指定する場合は,目安としてスケールインの対象となるホスト数が1時間当たり20台以下になるよう運用してください。
- NOを指定した場合
-
処理性能を優先した指定です。構成定義ファイルから対象ホストを削除して,構成定義は配布しません。次回スケールアウト時に構成定義情報が更新されます。
JP1PFMAgentAlarmTableList_W
"PFM Windows Template Alarms [CPU] 09.00","PFM Windows Template Alarms [MEM] 09.00","PFM Windows Template Alarms [DSK] 09.00"
△
エージェントにバインドするWindows用のアラームテーブル名です。
複数指定する場合は,コンマ区切りで指定してください。
JP1PFMAgentAlarmTableList_L
"PFM UNIX Template Alarms [CPU] 09.00","PFM UNIX Template Alarms [MEM] 09.00","PFM UNIX Template Alarms [DSK] 09.00"
△
エージェントにバインドするLinux用のアラームテーブル名です。
複数指定する場合は,コンマ区切りで指定してください。
EC2_HOMEPath※
指定なし
○
Amazon EC2 API Toolsのインストール先パスを指定します。
JAVA_HOMEPath※
指定なし
○
Java(JRE)のインストール先パスを指定します。
EC2_URL※
指定なし
○
AWSのリージョンのURLを指定します。
AWS_ACCESS_KEY※
指定なし
○
AWSのアクセスキー文字列を指定します。
AWS_SECRET_KEY※
指定なし
○
AWSのシークレットアクセスキー文字列を指定します。