コンテンツにスキップ

PlaidLinkエージェント

外部からのアクセスを許可していないリモートシステムのデータにアクセスしたり、そこでプロセスを実行したりする必要が生じることがあります。ファイアウォールの内側にあるエンタープライズ環境では、これが一般的です。PlaidCloudでは、PlaidLinkを使用することで、ファイアウォールの内側にあるリモートシステムや、PlaidCloudからの直接アクセスが望ましくないシステムにアクセスできます。

PlaidLinkはエージェントベースのシステムです。ファイアウォールの内側などの制限された領域にあるシステムに、リモートユーザーであるエージェントをインストールします。エージェントは、セキュアなHTTPS WebSocket接続を介して外向きの通信を開始し、PlaidCloudに接続します。通常のWeb接続と同様に暗号化されて安全であり、多くの場合、標準外のポートを開放する必要はありません。アクセスを得る前に、エージェントはエージェント識別子を送信して自身を識別する必要があります。その後の認証に成功すると、エージェントには承認された操作へのアクセスが許可されます。

PlaidLinkはWindows、Unix、Linuxの各システムにインストールでき、権限の低いユーザーで実行することもできます。Windowsシステムでは、PlaidLinkをWindowsサービスとして動作させ、サービスパネルから完全に制御できます。LinuxまたはUnixシステムでは、デーモンプロセスとして実行できます。

PlaidLinkは、スタンドアロンのDockerコンテナーまたはKubernetesポッドとして実行することもできます。

エージェントを管理するには:

  1. Analyzeを開きます
  2. 「Tools」を選択します
  3. 「PlaidLinkエージェント」をクリックします

PlaidLinkエージェントテーブルが表示され、利用可能なエージェントの一覧の表示、変更、認証情報の取得ができます。

エージェントを作成するには:

  1. Analyzeを開きます
  2. 「Tools」を選択します
  3. 「PlaidLinkエージェント」をクリックします
  4. 「PlaidLinkエージェントを追加」をクリックします
  5. 必須フィールドに入力します
  6. 「作成」をクリックします
  7. エージェントが処理を実行するために必要なリソースにアクセスできるよう、エージェントを必要なセキュリティグループに割り当てます
  8. エージェントが処理を実行するために必要なドキュメントにアクセスできるよう、エージェントを必要なドキュメントアカウントに割り当てます

エージェントの認証情報の取得

Section titled “エージェントの認証情報の取得”

リモートシステムでPlaidLinkエージェントを設定するには、セキュリティを維持するために、まずエージェントの識別情報を取得する必要があります。この情報には、公開鍵と秘密鍵の両方が含まれます。

これらのキーを取得するには:

  1. Analyzeを開きます
  2. 「Tools」を選択します
  3. 「PlaidLinkエージェント」をクリックします
  4. 編集アイコンをクリックします

公開鍵と秘密鍵の値を表示できるフォームが開きます。

秘密鍵とRPC構成を表示ボタンは、エージェントを編集できるメンバーにのみ表示されます。その他のメンバーには公開鍵のみが表示されます。

エージェントの認証情報の再生成

Section titled “エージェントの認証情報の再生成”

セキュリティを維持するために、公開鍵と秘密鍵を定期的に再生成し、リモートシステムの設定を更新することをお勧めします。

認証情報を再生成するには:

  1. Analyzeを開きます
  2. 「Tools」を選択します
  3. 「PlaidLinkエージェント」をクリックします
  4. 再生成アイコンをクリックします

認証情報を再生成した後は、新しいエージェントの認証情報と同じ方法(上記を参照)で取得できます。

エージェントの有効化と無効化

Section titled “エージェントの有効化と無効化”

エージェントを無効にするには:

  1. Analyzeを開きます
  2. 「Tools」を選択します
  3. 「PlaidLinkエージェント」をクリックします
  4. 「Active」チェックボックスをオフにします

接続は環境ごとに異なる構成を保持できるため、プロジェクトの環境を切り替えると、そのプロジェクトが使用するすべての接続が一度に切り替わります。エージェントも同じ切り替えに追従させることができます。

各エージェントには、次の2つの設定があります。

  • Agent Group — 互いに代わりを務めるエージェントが共有する名前です。グループ内のエージェントは同じ作業の代替であり、環境ごとに1つずつ用意します。
  • このエージェントが担当する環境 — このエージェントが対応する接続環境です。エージェントのPlaidLink構成にある環境と一致している必要があります。

ステップが指定するエージェントは、引き続き特定の1つです。ワークフローの実行時に、PlaidCloudはそのエージェントが属するグループを調べ、プロジェクトの現在の環境に対応するメンバーを選択します。そのため、デフォルト環境からQAに移したプロジェクトでは、ステップを編集しなくても、リモートステップがQAのマシンで実行されます。

Financeという名前のグループに、Defaultに対応するエージェントとQAに対応するエージェントが1つずつある場合、ステップがどちらを指定していても、プロジェクトに合致するほうで実行されます。Defaultに戻したプロジェクトは、ステップがQAのエージェントを指定している場合でも、Defaultのエージェントで実行されます。

エージェントを環境に割り当てるには:

  1. Analyzeを開きます
  2. 「Tools」を選択します
  3. 「PlaidLinkエージェント」をクリックします
  4. エージェントを開きます
  5. 「Agent Group」を、そのエージェントの代替と共有する名前に設定し、「このエージェントが担当する環境」を、そのエージェントが作業を実行する環境(QAなど)に設定します
  6. そのエージェントを実行しているマシンで、PlaidLink構成ファイルに一致する環境名を設定します。詳しくは、以下のエージェントマシンとの一致を参照してください

エージェントをグループから外すと、グループが対応する範囲が狭まるため、グループに追加するのと同じくらい影響があります。デフォルト環境に対応していたエージェントのグループをクリアすると、その環境で実行されているプロジェクトは解決先がなくなり、次の実行で失敗します。グループからメンバーを外す前に、その環境を同じグループの別のメンバーに移してください。グループが対応する範囲を変更する保存を行うたびに、新しい対応範囲が通知されます。

環境は接続と共有されるため、ここに表示される環境名は、接続の構成時に使用するものと同じです。接続の作成と管理を参照してください。

ここで設定する環境は、そのマシンのPlaidLinkサービスに設定されている環境と一致している必要があります。PlaidLinkは、構成ファイルで指定された環境に対応する特定のキューをサブスクライブします。そのため、エージェントのレコードがQAになっていても、マシンがまだデフォルト環境用に設定されている場合、エージェントは作業の送信先とは別のキューで待機することになります。ステップは待機した後、エージェントがジョブを取得していないと報告して失敗します。

PlaidLink構成ファイルのenvironmentsブロックで、そのエージェントのエントリに設定します。

environments:
- name: QA
agent_id: <agent identifier>

nameは、PlaidCloudに表示される環境名です。省略した場合、エージェントはデフォルト環境に対応します。変更後はPlaidLinkサービスを再起動してください。

PlaidLinkは、1つのサービスのインストールで複数のエージェントを動作させられるように設計されています。この合理化されたインストール方式により、1回のインストールで、複数のワークスペースのエージェントや、タスク実行の権限レベルが異なるエージェントを扱えます。

複数のエージェントを有効にするには、PlaidLink構成ファイルにエージェントの認証情報を追加するだけです。

1つのPlaidLinkサービスで複数のエージェントを実行する場合と同様に、複数のPlaidLinkサービスを実行することもできます。

これは、システムベースのセキュリティの使用状況や、ネットワーク境界をまたぐ通信を妨げるネットワークアクセス制限によっては、必要になることがあります。

コンピュート、メモリ、ディスクの要件

Section titled “コンピュート、メモリ、ディスクの要件”

PlaidLinkサービスは非常に軽量で、動作に必要なコンピュートとメモリは最小限です。大量のデータを処理する場合は、コンピュートリソース、特にメモリを増やす必要が生じることがあります。

通常、エージェントはCPUの5%とメモリ200MBで問題なく動作します。負荷の高いデータ操作では、CPU 1つ全体と4GB以上のRAMを割り当てることをお勧めします。Kubernetesのような動的なリソース割り当てシステムでは、エージェントが予約済みリソースではなくバースト可能なリソースにアクセスできれば問題ありません。

エージェントに必要なディスク容量も最小限です。大量のデータを転送する際、エージェントの操作はディスク容量をデータバッファーとして使用します。通常の操作では、8GBの容量で十分です。負荷の高いデータ操作では、想定されるデータ量に応じてディスクを拡張することをお勧めします。CPUの速度、ネットワークの速度、データ量などの複数の要因に左右されるため、決まった容量はありません。ただし、20GBから始めて、そこから調整するのがよいでしょう。

PlaidLinkエージェントは、必要な設定を最小限に抑えて動作するように設計されています。標準のHTTPSネットワークトラフィックを許可する以外に、特別なVPNやネットワーク設定は必要ありません。エージェントは、通常のWebブラウザーベースのトラフィックと同じプロトコルで通信します。

エージェントサービスは常にPlaidCloudとの通信を開始するため、ファイアウォールでインバウンドアクセスを設定する必要はありません。