Overview
このガイドでは、CLI からビルドされたエージェントを本番環境にデプロイする方法を学習できます。配置する前に、必ずエージェントイメージをビルドしてください。
コマンドシンタックスとオプション
配置を管理するには、次のコマンドを使用します。
配置の開始
ビルドしエージェントを配置するには、次の構文を使用します。
agentengine deploy [--auto] [--build-id <id>] [--version <version>] [--workspace-id <id>] [--project-id <id>] [--org-id <id>] [--base-url <url>] [--context <name>] [--no-wait] [--timeout <duration>] [--workspace <name>] [--all] [--json] [--yes]
このコマンドは、最後に成功したビルドまたはビルドIDを指定した場合は特定のビルドの配置を開始します。コマンドは、配置が succeeded、failed、または rolled_back のステータスになるまで、またはタイムアウト値に達するまで、5 秒ごとに配置ステータスをポーリングします。
重要
ファイルシステム アクセス
エージェントを配置した後、ローカル ファイルは /tmp または /scratch ディレクトリの下にのみ書き込まれます。ランタイム環境では書き込みができない可能性があるため、/var やホスト ディレクトリなどの他のパスは使用しないでください。
コマンド フラグ
ビルドを配置する際には、次の任意フラグを使用できます。
Flag | 説明 |
|---|---|
| エージェントをビルドし、ビルドによってトリガーされる配置を監視します。このフラグは、単一エージェント プロジェクトにのみ適用されます。このフラグを使用すると、2 つのコマンドを個別に実行中のではなく、1 つのステップでビルドと配置を行います。 |
| 配置するビルドID 。デフォルトでは 、コマンドはワークスペースの最後の成功したビルドを配置します。このフラグは、 |
| この宣言された |
| プラットフォーム ワークスペースID。デフォルトでは 、CLI は |
| プラットフォームプロジェクトID。デフォルトでは 、CLI は |
| 組織ID。デフォルトでは 、CLI はローカルに保存された認証状態からこの値を読み取ります。 |
| プラットフォームAPIベースURL。 |
|
|
| ステータスをポーリングせずに配置を開始した後、すぐに戻るように CLI に指示します。 |
| 配置が完了するまで待機する最大時間。デフォルトでは 、配置は 30 分後にタイムアウトします。 |
| （MongoDB のみ） ルート |
| （MongoDB のみ） すべてのワークスペースを順番に配置します。このフラグは、 |
| 配置の結果をJSONとして出力します。 |
| 配置コマンドが Atlas 設定を実行するときに、請求された Flex デフォルトと Atlas IPアクセス リストの変更を受け入れます。 |
配置を一覧表示する
ワークスペースのデプロイメント履歴を表示するには、次のコマンドを実行します。
agentengine deploy list [--workspace <name>] [--workspace-id <id>] [--project-id <id>] [--org-id <id>] [--base-url <url>] [--context <name>] [--status <status>] [--limit <n>] [--offset <n>] [--json]
このコマンドは、配置ID、ステータス、実行プログラム、ビルドID、イメージ、作成時間、バージョン、エラーメッセージなど、現在のワークスペースのすべての配置を表示します。
コマンド フラグ
Flag | 説明 |
|---|---|
| （MongoDB のみ） ルート |
| プラットフォーム ワークスペースID。デフォルトでは 、CLI は |
| プラットフォームプロジェクトID。デフォルトでは 、CLI は |
| 組織ID。デフォルトでは 、CLI はローカルに保存された認証状態からこの値を読み取ります。 |
| プラットフォームAPIベースURL。 |
|
|
| 配置ステータスで結果をフィルタリングします。例、 |
| 返される配置の最大数。 |
| スキップする配置の数。 |
| 配置リストをJSONとして出力します。 |
配置ステータスの確認
配置の詳細なステータスを表示するには、次のコマンドを実行します。
agentengine deploy get [<deployment_id>] [-f] [--workspace <name>] [--workspace-id <id>] [--project-id <id>] [--org-id <id>] [--base-url <url>] [--context <name>] [--json]
デフォルトでは 、このコマンドは最新の配置の点インタイムスナップショットを返します。配置IDを指定して、特定の配置を確認します。出力には、配置ステータス、ビルドID、バージョン、イメージ、条件、コンポーネントの準備状況、ライブヘルス情報が含まれます。
コマンド フラグ
Flag | 説明 |
|---|---|
| 配置がターミナル状態に達するまで、サーバー送信イベント（SSE）を使用して配置イベントをリアルタイムでストリーミングします。配置がすでにターミナル状態になっている場合、コマンドはストリームするものがないことを報告します。 |
| （MongoDB のみ） 名前で特定のワークスペースを選択します。 |
| プラットフォーム ワークスペースID。デフォルトでは 、CLI は |
| プラットフォームプロジェクトID。デフォルトでは 、CLI は |
| 組織ID。デフォルトでは 、CLI はローカルに保存された認証状態からこの値を読み取ります。 |
| プラットフォームAPIベースURL。 |
|
|
| 配置ステータスをJSONとして出力します。 |
配置イベント ログの表示
配置の構造化イベントログを表示するには、次のコマンドを実行します。
agentengine deploy logs [<deployment_id>] [-f] [--severity <level>] [--category <category>] [--limit <n>] [--workspace <name>] [--workspace-id <id>] [--project-id <id>] [--org-id <id>] [--base-url <url>] [--context <name>] [--json]
このコマンドは、指定された配置のイベントログを検索し、作成から完了までの各状態移行を示します。配置IDを指定しない場合、コマンドは最新の配置のイベントログを表示します。イベントログを使用して、デプロイメントの動作を追跡し、障害を調査し、予想されるライフサイクルの移行が発生したことを確認できます。
配置が成功しない場合、失敗したコンポーネントのイベントには終了コードと失敗の簡単な理由の両方が含まれます。
注意
--json フラグは、--follow、--severity、または --category フラグと組み合わせることはできません。
コマンド フラグ
Flag | 説明 |
|---|---|
| 配置がターミナル状態に達するまで、新しいイベントをポーリングします。 |
| イベントを重大度レベル : |
| イベントをカテゴリ別にフィルタリングします（例: |
| ページあたりに返されるイベントの最大数。デフォルトは 100 です。 |
| （MongoDB のみ） 名前で特定のワークスペースを選択します。 |
| プラットフォーム ワークスペースID。デフォルトでは 、CLI は |
| プラットフォームプロジェクトID。デフォルトでは 、CLI は |
| 組織ID。デフォルトでは 、CLI はローカルに保存された認証状態からこの値を読み取ります。 |
| プラットフォームAPIベースURL。 |
|
|
| イベントログをJSONとして出力します。 |
配置をキャンセルする
進行中の配置をキャンセルするには、次のコマンドを使用します。
agentengine deploy cancel <deployment_id> [--workspace <name>] [--workspace-id <id>] [--project-id <id>] [--org-id <id>] [--base-url <url>] [--context <name>]
配置がすでにsucceeded、failed、または rolled_back 状態にある場合は、このコマンドはエラーを返します。
コマンド フラグ
Flag | 説明 |
|---|---|
| （MongoDB のみ） ルート |
| プラットフォーム ワークスペースID。デフォルトでは 、CLI は |
| プラットフォームプロジェクトID。デフォルトでは 、CLI は |
| 組織ID。デフォルトでは 、CLI はローカルに保存された認証状態からこの値を読み取ります。 |
| プラットフォームAPIベースURL。 |
|
|
構築の制限
プラットフォームでは、 各プロジェクトに対して次のビルド制限が適用されます。
Limit | 値 |
|---|---|
アクティブなビルドの同時実行 | 10 |
ローリング 24 時間にわたる毎日のビルド | 100 |
ビルド制限を超えると、リクエストはRESOURCE_LIMIT_EXCEEDED メッセージとともに 400 Bad Request エラーを返します。
パブリック プレビュー中に適用されるすべての制限を確認するには、 「 MongoDB Atlas Agent の制限 」を参照してください。
例
次の例は、最後の正常なビルドを配置し、その配置のステータスを確認してキャンセルする方法を示しています。
配置のステータスを確認します。
前のステップの配置IDを使用して、次のコマンドを実行し、配置ステータスを確認します。
agentengine deploy get deploy-9fb9e685
出力は次のようになります。
Deployment: deploy-9fb9e685 Status: in_progress (started 45s ago) Trigger: build Build: bld_01... Version: v0.1.0 (r1) Conditions: Available False NotAvailable — One or more components are not available. Components: Orchestration Engine 0/1 not ready Agent Sandbox 1/1 ready Tool Sandbox 1/1 ready Health: unavailable
次のステップ
エージェントを配置すると、そのパフォーマンスとアクティビティを監視できます。エージェント を監視する方法については、「 監視ガイド 」を参照してください。
Atlas Agent でエージェントを実行中ための最小要件については、 MongoDB Atlas Agent Engine のドキュメントの「 エージェント契約 」セクションを参照してください。