テストでLink Agentを使用しなくなった場合は、mablアプリ、mabl CLI、またはmabl APIからLink Agentをシャットダウンできます。この記事では、Link Agentをシャットダウンする方法、複数のトンネルを提供しているエージェントから1つのトンネルを削除する方法、および短期間の環境用に作成したトンネルをクリーンアップする方法について説明します。
Link Agentを一旦シャットダウンすると、mablアプリから再度起動することはできません。ホストへのパッチ適用など、一時的にエージェントをサービスから外すことが目的の場合は、代わりにメンテナンスモードを使用してください。テスト環境のトラフィックのLink経由でのルーティングを停止するには、テスト環境でのmabl Linkの無効化を参照してください。
Link Agentをシャットダウンする前に
ワークスペース > ネットワークのトンネルテーブルを確認してください。トンネルがmabl環境に関連付けられており、このエージェントがそのトンネルの最後のエージェントである場合は、環境の設定を更新して、別のトンネルを使用するか、トンネルを使用しないように変更してください。更新しないと、これらの環境のテストが失敗するようになります。
実行中のテストを先に完了させる
すでにエージェントを通じて実行中のテストを中断せずにエージェントをシャットダウンするには、先にエージェントをメンテナンスモードにします。エージェントは新しい接続の受け付けを停止し、現在の接続を完了させます。
- リンクエージェントテーブルで、エージェントの管理するメニューを開き、メンテナンスを開始を選択します。
- メンテナンスを開始で確定します。
- エージェントのステータスが、接続の完了中を示す完了処理中から、接続がなくなったことを示す処理完了に変わるまで待ちます。
エージェントに処理完了と表示されたら、次のセクションの説明に従ってシャットダウンします。代わりにサービスに戻すには、管理する > メンテナンスを終了しますを選択します。
Link Agentのシャットダウン
- ワークスペース > ネットワークに移動します。会社トンネルを提供するエージェントの場合は、会社ダッシュボードのNetworkingページを使用します。
- リンクエージェントテーブルで、エージェントの管理するメニューを開き、シャットダウンを選択します。
- シャットダウンで確定します。
エージェントが停止し、別のエージェントがそのトンネルを提供するまで、そのエージェントを必要とするテストは失敗します。
ワークスペーストンネルのエージェントをシャットダウンできるのはワークスペースの所有者のみ、会社トンネルのエージェントをシャットダウンできるのは会社の管理者のみです。
mabl CLIまたはmabl APIを使って、Link Agentをシャットダウンすることもできます。
-
mabl CLI:
mabl link-agents terminate {agent-id}コマンドを使用します。 - mabl API:terminate link agentエンドポイントを使用します。
Link Agentが複数のトンネルを提供している場合、そのうちの1つをシャットダウンしても、他のトンネルは実行を続けます。バージョン3.0より前のLink Agentは動作が異なり、いずれかのトンネルをシャットダウンすると、エージェント全体と、そのエージェントが提供するすべてのトンネルがシャットダウンされます。
Link Agentから1つのトンネルを削除する
複数のトンネルを提供しているエージェントで1つのトンネルの提供を停止するには、Link Agent設定ファイルからそのトンネルのエントリを削除してファイルを保存します。エージェントはそのトンネルでの新しい接続の受け付けを停止し、現在の接続を完了させるため、実行中のテストは中断されません。その後、トンネルは、mablアプリからシャットダウンするか、エージェントが再起動するまで待機します。
短期間の環境用トンネルのクリーンアップ
プルリクエストごとのプレビュー環境など、一時的な環境用にLink Agentを起動する場合は、環境がなくなったときにトンネルを削除します。
mabl link-agents delete {tunnel-name}
このコマンドは、そのワークスペーストンネル上のすべてのエージェントをシャットダウンし、トンネルを削除して、同じ名前の新しいエージェントを15分間ブロックします。
KubernetesベースのLink Agentの終了
mablアプリでKubernetesベースのLink Agentをシャットダウンすると、指定された数のレプリカを維持するため、数秒以内にKubernetes Deploymentによって代わりのLink Agentが起動されます。同様に、PodベースのLink Agentは、再起動ポリシーに基づいて再起動を試みます。
KubernetesベースのLink Agentを停止するには、次のkubectl deleteコマンドを使用します。
- PodベースのLink Agent:
kubectl delete pod mabl-link-agent -n {YOUR-NAMESPACE} - DeploymentベースのLink Agent:
kubectl delete deployment mabl-link-agent-deployment -n {YOUR-NAMESPACE}