mabl CLIからLink Agentを実行できます。Javaも、別途のダウンロードも必要ありません。mabl Linkを試す場合、短時間の作業のためにトンネルを立ち上げる場合、またはターミナルから個人Linkトンネルを実行する場合に使用してください。この記事では、CLIでLink Agentを起動する方法と、コマンドラインからLink Agentを管理する方法について説明します。
常時稼働し、ホストの起動とともに開始されるLink Agentが必要な場合は、代わりにWindowsインストーラー、LinuxおよびmacOSインストーラー、またはDockerイメージを使用してください。Link Agentのセットアップを参照してください。
開始する前に
- mabl CLIのバージョン2.135.0以降をインストールします。
-
mabl auth loginでサインインするか、mabl auth activate-keyでAPIキーを有効にします。個人トンネルを開始するには、自分のアカウントでサインインする必要があります。 - コンピューターがサポートされているプラットフォームであり、Link Agentの要件に記載されたアドレスに到達できることを確認します。
Link Agentの起動
CLIからLink Agentを起動する方法は、サービスを提供する対象に応じて3つあります。
- コマンドラインでトンネル名を指定する: ワークスペーストンネルまたは会社トンネルを1つ提供します。
- 設定ファイルを渡す: 複数のトンネルを提供したり、プロキシや接続フィルターのオプションを設定したりします。
- 個人トンネルを開始する: 自分のクラウド実行をこのコンピューター経由でルーティングします。
どの方法で起動した場合も、エージェントは初回の実行時にトンネルを実行するコンポーネントをダウンロードし、以降の実行のために保持します。トンネルの準備ができると、CLIは次のような行を表示します。
Tunnel qa-env-01 is connected to mabl. Press Ctrl-C to stop.
エージェントは、停止するまで実行され続けます。停止するにはCtrl-Cを押します。エージェントは処理中の接続が完了するのを待ってから終了するため、エージェント経由で実行中のテストが途中で切断されることはありません。
コマンドラインでのトンネル名の指定
ワークスペーストンネルにサービスを提供するには、トンネル名を指定します。
mabl link-agents start --tunnel qa-env-01
エージェントは、デフォルトのワークスペースのトンネルにサービスを提供します。別のワークスペースを使用するには、--workspace-id {workspace-id}を追加します。代わりに会社トンネルにサービスを提供するには、--company-id {company-id}を追加します。
設定ファイルの使用
CLIは、他のLink Agentインストールと同じ設定ファイルの形式を受け付けます。そのため、このコンピューター上のファイルにトンネル、プロキシ設定、接続フィルターを定義し、毎回オプションを入力する代わりに--configで渡すことができます。個人トンネルでは設定ファイルを使用せず、--configと--personalを組み合わせることはできません。
mabl link-agents start --config /path/to/config.yaml
設定ファイルには複数のトンネルを記述でき、1つのエージェントがそれらすべてにサービスを提供します。エージェントは、CLIのサインインではなく、ファイル内のAPIキーを使用します。コマンドラインのオプションはファイルよりも優先されます。エージェントは実行中にファイルを監視するため、再起動せずにトンネルを追加または削除できます。
CLIのLink Agentは、mabl、all、upstream、noneのプロキシモードをサポートしています。プロキシ自動設定 (PAC) と、オペレーティングシステムのプロキシ設定に従う機能はサポートしていません。ネットワークでどちらかが必要な場合は、他のインストール方法を使用してください。
個人トンネルの開始
自分のクラウド実行をこのコンピューター経由でルーティングするには、個人トンネルを開始します。
mabl link-agents start --personal
個人トンネルはコンピューターによって識別されるため、トンネル名は不要で、--tunnel、--workspace-id、--company-id、--configと組み合わせることはできません。
ターミナルを使わずに、mablデスクトップアプリから個人トンネルを開始することもできます。
- mablアプリのメニューバーから、Edit > Link tunnelsに移動します。
- [Personal tunnel] タブで [ON] をクリックします。mablデスクトップアプリから個人トンネルを開始するを参照してください。
個人トンネルをCLIから開始する場合もmablデスクトップアプリから開始する場合も、事前にワークスペースの所有者が個人トンネルを許可している必要があります。個人Linkトンネルを参照してください。
オプション
| オプション | 説明 |
|---|---|
--tunnel {name} |
サービスを提供するトンネル。名前は、英小文字、数字、ダッシュから成る1～24文字です。 |
--workspace-id、-w
|
トンネルを所有するワークスペース。デフォルトは、設定済みのワークスペースです。 |
--company-id |
ワークスペーストンネルの代わりに会社トンネルにサービスを提供します。 |
--config、-c
|
Link Agent設定ファイル (YAMLまたはJSON) へのパス。 |
--personal |
自分の個人トンネルにサービスを提供します。mabl auth loginが必要です。 |
--no-auto-update |
公開されたアップデートをインストールせず、トンネルコンポーネントの現在のバージョンを維持します。 |
--debug |
接続できない、または接続が切れ続けるトンネルを診断するために、より詳細なログを記録します。 |
すべてのオプションについては、mabl CLI コマンドリファレンスを参照してください。
ログの確認
エージェントはログをターミナルに出力するとともにファイルにも書き込み、起動時にログディレクトリを表示します。このディレクトリには、エージェント用のlink-agentログと、サービスを提供するトンネルごとのlink-workerログが保存されます。トンネルについてmablに問い合わせる際は、両方を添付してください。
コマンドラインからのLink Agentの管理
CLIでは、インストール方法にかかわらずLink Agentを管理できます。
| コマンド | 動作 |
|---|---|
mabl link-agents list |
最近チェックインしたLink Agentを、ステータス、ホスト、バージョンとともに一覧表示します。 |
mabl link-agents maintenance start {id} |
エージェントをメンテナンスモードにします。エージェントは新しい接続の受け付けを停止し、現在の接続が完了するのを待ちます。待機時間を制限するには、--drain-timeout {seconds}を追加します。 |
mabl link-agents maintenance end {id} |
エージェントのメンテナンスモードを解除します。 |
mabl link-agents terminate {id} |
Link Agentをシャットダウンします。 |
エージェントのIDは、mabl link-agents listまたはSettings > Networkingで確認できます。メンテナンスモードを使用するタイミングについては、Link Agentのメンテナンスとアップデートを参照してください。
トンネルがネットワーク内のサービスに到達できることを確認するには、mabl link-agents testコマンドを使用します。Link接続のテストと診断を参照してください。