複数の Connector Windows エージェントを 1 台のマシンに展開する

Windowsエージェントのバージョン 1.2.0 以降、1台のWindowsホスト上に複数のエージェントをインストールできるようになりました。 Windowsエージェントのバージョン 1.2.0 以上を使用するには、サーバーに Microsoft.NET >= 3.5 がインストールされている必要があります。

Satellite コネクタ（ クラウド エンドポイント）では、同じWindowsホスト上で複数のエージェントを実行することはサポートされていません。これは、クラウドエンドポイントのインジェストが、エージェントを実行しているWindowsホストそのものであるためです。クラウドエンドポイントと、1つのホスト上で複数のWindowsエージェントを実行することは、相互に排他的な機能である。 Windows エージェントでクラウドエンドポイントを使用する必要がある場合は、Windows ホストごとに 1 つのエージェントをインストールすることをお勧めします。

考慮事項

Windows Agent のサービス名は、バージョン 1.2.0 で satelliteconnectorservice.exe から SatelliteConnectorService に更新されました。この変更のため、削除したいエージェントに付属しているアンインストールスクリプトを使用する必要があります。
バージョン 1.2.0 では、単一の Windows ホストにインストールされた複数の Windows エージェントを区別するために、エージェント設定ファイルに SATELLITE_CONNECTOR_INSTANCE_NAME という新しいパラメータが導入された。このパラメータはサービス名に付加され、 - で区切られる。複数の Windows エージェントをインストールするには、インストールまたはアンインストールスクリプトを呼び出すときに設定ファイルを指定する必要があります。
Windowsエージェントは、Windowsホスト上のノードプロセスとして実行される。 IBM Cloud コンソールと IBM Cloud コマンドラインインターフェイス（CLI）のいずれにおいても、ノードのプロセスIDはコネクタ名に追加され、 . で区切られます。
Windows エージェントの 1.2.0 より前のバージョンでは、インストールまたはアンインストールスクリプトに設定ファイルを指定できませんでした。その代わりに、スクリプトは自動的に同じディレクトリからファイル config.json を取り出し、それを使って1つのWindowsエージェントをインストールまたはアンインストールした。
Windowsエージェント1台には、少なくとも4 vCPU が必要で、4GBを推奨する。このセットアップでは複数のエージェントを扱うことができるが、4番目のエージェント以降はパフォーマンスが著しく低下する。したがって、複数のエージェントを実行するには、少なくとも8 vCPU と 8 GB を推奨する。
同じコネクタに属する複数のエージェントを実行しても、何のメリットもない。ベストプラクティスは、コネクタごとに1人のエージェントを配置することである。
複数のWindowsエージェントをインストールするには、各エージェントに対して 25MB、メモリを確保する必要がある。
エージェント間でトラフィックを処理すると、エージェント1台あたり約70 MBのメモリ使用量と約15%のCPU使用率となり、帯域幅はエージェント1台あたり150～200 Mbpsに達します。これらの数値は、 IBM が実施した「 Satellite Connector Windowsエージェント」の内部パフォーマンステストに基づいています。

複数のWindowsエージェントのインストール

1つのホストに複数のエージェントを展開するには、 configFile パラメータを使用する必要があります。

CLI から、次のコマンドを実行して、エージェント「 .zip 」（ZIP アーカイブ）ファイルをダウンロードします。

ibmcloud sat agent attach --platform windows

出力例。

Downloading agent setup tools for windows...
OK
Satellite connector agent for windows was successfully returned /var/folders/17/y8wr4y_x1tb4yf__g3wr6g8m0000gp/T/windows_satellite_connector_4097559421.zip

PowerShell で以下のコマンドを実行し、 .zip の sha512sum を検証する。

Get-FileHash -Algorithm SHA512 -Path c:\windows_satellite_connector_1420916628.zip

PowerShell で以下のコマンドを実行し、 .zip ファイルの内容を展開する。

Expand-Archive -Path 'C:\path\to\windows_satellite_connector_4097559421.zip' -DestinationPath ‘C:\path\to\extract'

次のセクションの手順を完了し、解凍した設定ファイルを更新します。

multi_instance_config.json ファイルを編集して、Connector の詳細を含める。

{
  "SATELLITE_CONNECTOR_ID": "<connector_id>",
  "SATELLITE_CONNECTOR_IAM_APIKEY": "<api_key>",
  "SATELLITE_CONNECTOR_TAGS": "<tags>",
  "SATELLITE_CONNECTOR_INSTANCE_NAME": "<instance_name>",
  "LOG_LEVEL": "<log_level>",
  "PRETTY_LOG": <true|false>
}

設定ファイルに Connector の詳細と認証情報を入力します。ファイル名は config.json にしないこと。 SATELLITE_CONNECTOR_INSTANCE_NAME は必須で、文字で始まり、 (a-zA-Z)、数字 (0-9) および _ のみを含むことができ、全長は50文字未満でなければならない。
PowerShell でインストール・スクリプトを実行する。
```
./install.ps1 -configFile multi_instance_config.json
```

Windows Server上で動作しているエージェントを表示します。 PowerShell で以下のコマンドを実行する。

Get-Service -Name SatelliteConnectorService* | Format-Table -AutoSize

Status  Name                                  DisplayName
------  ----                                  -----------
Running SatelliteConnectorService             SatelliteConnectorService
Running SatelliteConnectorService-connector_1 SatelliteConnectorService-connector_1
Running SatelliteConnectorService-connector_2 SatelliteConnectorService-connector_2

Windows Server上で実行されているノードプロセスを表示します。 PowerShell で以下のコマンドを実行する。

get-process | Where-Object {$_ -match 'node'}

NPM(K) PM(M) WS(M) CPU(s)   Id SI ProcessName
------ ----- ----- ------   -- -- -----------
    24 61.05 40.44   0.89 1796  0 node
    39 10.43 24.29   0.11 3436  0 node
    39 10.74 29.70   0.17 4288  0 node
    24 61.60 39.86   0.70 5720  0 node
    24 61.44 40.64   0.81 5924  0 node
    39 10.63 29.81   0.17 7932  0 node

connector_1 の詳細を入手する。

ibmcloud sat connector get --connector-id U2F0ZWxsaXRlQ29ubmVjdG9yOiJjdnNkYzkwMjFpNnNlcnJxdTJlZyI

OK
ID:                    U2F0ZWxsaXRlQ29ubmVjdG9yOiJjdnNkYzkwMjFpNnNlcnJxdTJlZyI
Name:                  connector_1
CRN:                   crn:v1:staging:public:satellite:us-south:a/1ae4eb57181a46ceade48465196706a7:U2F0ZWxsaXRlQ29ubmVjdG9yOiJjdnNkYzkwMjFpNnNlcnJxdTJlZyI::
Managed From:          Dallas (us-south)
Resource Group ID:     60735c4daed84fcea7d3fe99c298c9b3
Resource Group Name:   Default
State:                 created
Created Date:          2025-04-11 03:43:16 -0500 (48 minutes ago)

コネクタに属するエージェントを表示する connector_1.

ibmcloud sat agent ls --connector-id U2F0ZWxsaXRlQ29ubmVjdG9yOiJjdnNkYzkwMjFpNnNlcnJxdTJlZyI

OK
Name                               Release                                               Tags
sat-link-e2e-wi/connector_1.1796   20250410-5f291315c59db895783cf54411765942806802ac_W   connector_1

connector_2 の詳細を入手する。

ibmcloud sat connector get --connector-id U2F0ZWxsaXRlQ29ubmVjdG9yOiJjdnNkYzlzMjF0OWFsMjQ2YXZjMCI

OK
ID:                    U2F0ZWxsaXRlQ29ubmVjdG9yOiJjdnNkYzlzMjF0OWFsMjQ2YXZjMCI
Name:                  connector_2
CRN:                   crn:v1:staging:public:satellite:us-south:a/1ae4eb57181a46ceade48465196706a7:U2F0ZWxsaXRlQ29ubmVjdG9yOiJjdnNkYzlzMjF0OWFsMjQ2YXZjMCI::
Managed From:          Dallas (us-south)
Resource Group ID:     60735c4daed84fcea7d3fe99c298c9b3
Resource Group Name:   Default
State:                 created
Created Date:          2025-04-11 03:43:19 -0500 (50 minutes ago)

コネクタに属するエージェントを表示する connector_2.

ibmcloud sat agent ls --connector-id U2F0ZWxsaXRlQ29ubmVjdG9yOiJjdnNkYzlzMjF0OWFsMjQ2YXZjMCI

OK
Name                               Release                                               Tags
sat-link-e2e-wi/connector_2.5924   20250410-5f291315c59db895783cf54411765942806802ac_W   connector_2

複数のWindowsエージェントのアンインストール

複数の Windows エージェントをアンインストールするには、次のコマンドを実行してください。

.\uninstall.ps1 -configFile config_connector1.json

このコマンドは、Windows エージェントを configFile から SATELLITE_CONNECTOR_INSTANCE_NAME とともにアンインストールします。

複数のWindowsエージェントのアップデート

複数の Windows エージェントを更新するには、エージェントをアンインストールし、config ファイルを更新し、更新された config ファイルを使用してエージェントを再度インストールします。

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

install.ps1 スクリプトを使用して単一のエージェントのみをインストールするには、以下の手順を確認してください。

configFile パラメータを指定しない。これにより、Agent < 1.2.0 の下位互換性が保証されます。
設定ファイル名は config.json でなければならない。
設定ファイル config.json には SATELLITE_CONNECTOR_INSTANCE_NAME を含めてはならない。

1つのホストに複数のエージェントを展開するには、 configFile パラメータを使用する必要があります。

CLIから以下のコマンドを実行して、エージェント .zip ファイルをダウンロードします。

ibmcloud sat agent attach --platform windows

出力例。

Downloading agent setup tools for windows...
OK
Satellite connector agent for windows was successfully returned /var/folders/17/y8wr4y_x1tb4yf__g3wr6g8m0000gp/T/windows_satellite_connector_4097559421.zip

PowerShell で以下のコマンドを実行し、 .zip の sha512sum を検証する。

Get-FileHash -Algorithm SHA512 -Path c:\windows_satellite_connector_1420916628.zip

PowerShell で以下のコマンドを実行し、 .zip ファイルの内容を展開する。

Expand-Archive -Path 'C:\path\to\windows_satellite_connector_4097559421.zip' -DestinationPath ‘C:\path\to\extract'

次のセクションの手順を完了し、解凍した設定ファイルを更新します。

config.json を編集し、コネクタの詳細を入力します。

{
  "SATELLITE_CONNECTOR_ID": "<connector_id>",
  "SATELLITE_CONNECTOR_IAM_APIKEY": "<api_key>",
  "SATELLITE_CONNECTOR_TAGS": "<tags>",
  "LOG_LEVEL": "<log_level>",
  "PRETTY_LOG": <true|false>
}

Windowsホスト上でインストールコマンドを実行する。
```
./install.ps1
```

コネクタの詳細を確認してください。

ibmcloud sat connector get --connector-id U2F0ZWxsaXRlQ29ubmVjdG9yOiJjdnNkbjZmMjFyOTJxdTgyZ3BzZyI

OK
ID:                    U2F0ZWxsaXRlQ29ubmVjdG9yOiJjdnNkbjZmMjFyOTJxdTgyZ3BzZyI
Name:                  connector
CRN:                   crn:v1:staging:public:satellite:us-south:a/1ae4eb57181a46ceade48465196706a7:U2F0ZWxsaXRlQ29ubmVjdG9yOiJjdnNkbjZmMjFyOTJxdTgyZ3BzZyI::
Managed From:          Dallas (us-south)
Resource Group ID:     60735c4daed84fcea7d3fe99c298c9b3
Resource Group Name:   Default
State:                 created
Created Date:          2025-04-11 04:06:33 -0500 (19 minutes ago)

コネクタに属するエージェントを表示します。

ibmcloud sat agent ls --connector-id U2F0ZWxsaXRlQ29ubmVjdG9yOiJjdnNkbjZmMjFyOTJxdTgyZ3BzZyI

OK
Name                   Release                                               Tags
sat-link-e2e-wi.5720   20250410-5f291315c59db895783cf54411765942806802ac_W   connector

単一のWindowsエージェントのアンインストール

1つのエージェントをアンインストールするには、次のコマンドを実行してください。

.\uninstall.ps1

単一のWindowsエージェントの更新

Windowsシングルエージェントを更新するには、エージェントをアンインストールし、configファイルを更新し、更新されたconfigファイルを使用してエージェントを再度インストールします。

FAQ

既存のシングルWindowsエージェントのインストールにマルチWindowsエージェントを追加できますか？: はい、 1.2.0 以上のバージョンの Windows エージェントの ZIP ファイルをダウンロードし、既存の単一の Windows エージェントのインストールとは別のディレクトリに解凍してから、 config.json という名前ではない設定ファイル内で SATELLITE_CONNECTOR_INSTANCE_NAME を設定してください。その後、 install.ps1 -configFile <agent-config-file.json> を実行してインストールしてください。
バージョン >= 1.2 で update-service.ps1 が見当たらないのはなぜですか？: update-service.ps1 、アンインストールに続いて新規インストールが必要だったので、削除することにした。 Windowsエージェントを更新する必要がある場合は、エージェントをアンインストールし、設定ファイルを更新して、再度インストールしてください。
WindowsホストにインストールされているWindowsエージェントのバージョンはどれですか？: Windows Server にエージェントをインストールしたディレクトリには、 version.txt という名前のファイルがあり、エージェントのバージョンが含まれています。ディレクトリに version.txt という名前のファイルがない場合、バージョンは <= 1.1.6 となる。
ダウンロードしたエージェントのバージョンは？: Windows Agent ZIP ファイルを ibmcloud sat agent attach --platform windows コマンドでダウンロードし、 Expand-Archive -Force -Path "$filename" -DestinationPath "." コマンドで解凍すると、エージェントバージョンを含む version.txt というファイルが存在する。