Overview
このガイドでは、配置プロセスの最初のステップである、 AWSシークレット マネージャーで配置されたワークスペースのシークレットを設定する方法を学習できます。これらのシークレットは、クラウド配置に必要なリソースの認証とアクセスに使用されます。
シークレットシンタックスとオプション
次の構文を使用して CLI でシークレットを設定すると、 AWS Secrets Manager にシークレットが保存されます。
agentengine secret set NAME VALUE [--description <text>] [--sync] [--project-scope | --workspace-scope] [--org-id <id>] [--project-id <id>] [--workspace-id <id>]
次の表は、一部またはすべての配置に必要なシークレット値を示しています。
シークレット | 説明 |
|---|---|
| MongoDBデプロイの接続文字列。このキーはすべての配置に必要です。 |
LM キー | LM プロバイダー認証情報の秘密キー。使用可能なキーは、 |
| MongoDB AI認証情報の秘密キー。このキーは、 |
| 任意。メモリサーバーが書き込むMongoDBデータベース名。デフォルトは |
Tip
agentengine atlas setup を実行すると、CLI は MONGODB_URI と VOYAGE_API_KEY のシークレットを自動的に設定します。
他のシークレットを構成する場合は、シークレット名が次の要件を満たしていることを確認してください。
大文字、数字、アンダースコアのみを使用する
AGENTIC_PLATFORM_で値を開始しないでください。このプレフィックスはプラットフォームにインジェクションされた変数で予約されているためです。次の予約名は使用しないでください。
RUNNER_MODE、APP_ID、ORG_ID、GROUP_ID、AER_ENDPOINT、TOOL_ENDPOINT最大 128 文字を使用する
agent.yamlartifact_repositoriesファイルでsecret agentengine secret setエントリが宣言されている場合は、同じ命名ルールで を使用して各エントリの 値を設定します。詳細については、「 プライベート アーティファクト リポジトリ 」を参照してください。
コマンド フラグ
シークレットを設定するときは、次の任意フラグを使用できます。
Flag | 説明 |
|---|---|
| 人間が判読できるシークレットの説明。 |
| シークレットを設定すると、シークレットを配置に同期します。 |
| プロジェクト内のすべてのワークスペースで共有されている、プロジェクトスコープのシークレットを対象とします。これがデフォルトのです。 |
| プロジェクト スコープのシークレットではなく、ワークスペース スコープのシークレットを対象とします。 |
| 特定の組織IDを直接ターゲットにします。 |
| 特定のプロジェクトID を直接ターゲットにします。 |
| 特定のワークスペースID を直接ターゲットにします。 |
シークレットを削除する
AWS Secrets Manager からシークレットを永続的に削除するには、次の構文を使用します。
agentengine secret delete NAME [--yes] [--project-scope | --workspace-scope] [--org-id <id>] [--project-id <id>] [--workspace-id <id>]
確認を求める前に、CLI はターゲット組織、プロジェクト、およびワークスペース スコープのシークレットについては、 ワークスペース をサーバーから検索します。確認プロンプトには名前と ID が表示されるため、ローカル ファイル内の値ではなく、解決された宛先が表示されます。名前検索が失敗した場合、プロンプトにはIDのみが表示されます。
スクリプトの確認プロンプトをスキップするには、--yes フラグを使用します。 CLI は引き続きターゲットを出力します。 --yes フラグを指定しない場合、シークレットが削除される代わりに、非インタラクティブ環境ではコマンドは失敗します。
警告
シークレットの削除を元に戻すことはできません。シークレットを再度設定するまで、シークレットを読み取る配置は成功しません。
シークレットの制限
プラットフォームは、シークレットに対して次の制限を強制します。
スコープ | Limit |
|---|---|
プロジェクトごと | 100 |
ワークスペースごと | 100 |
シークレット制限を超えると、リクエストはRESOURCE_LIMIT_EXCEEDED メッセージとともに 400 Bad Request エラーを返します。
パブリック プレビュー中に適用されるすべての制限を確認するには、 「 MongoDB Atlas Agent の制限 」を参照してください。
Atlas ネットワークアクセスの設定
がMONGODB_URI Atlas クラスターを指している場合は、agentengine atlas setup コマンドを実行します。 CLI は、Atlas Agent Engine データプレーンのIPアドレスをクラスターのIP アクセス リストに自動的に追加し、配置されたエージェントがクラスターに接続できるようにします。
構成例
次の例は、CLI からMongoDB URI、Anthropi APIキー、Voyage APIキーを設定する方法を示しています。これらのシークレットを設定するには、ターミナルから次のコマンドを実行します。
agentengine secret set MONGODB_URI 'mongodb+srv://example.mongodb.net' agentengine secret set ANTHROPIC_API_KEY sk-ant-api-test-key agentengine secret set VOYAGE_API_KEY sk-voy-api-test-key
次に、次のコマンドを実行して、実行中のすべての配置にシークレットを同期します。
agentengine secret sync
あるいは、次の例に示すように、--sync フラグを使用して、1 つのコマンドでシークレットを設定して同期することもできます。
agentengine secret set MONGODB_URI 'mongodb+srv://example.mongodb.net' --sync
次のステップ
シークレットをプロビジョニングした後、agent.yaml ファイルでどのシークレットが各ツールにアクセスできるかを宣言します。詳細については、 エージェント契約リファレンス の「 エージェント YAML スキーマ 」を参照してください。
クラウド配置を準備するには、エージェントイメージをビルドします。詳細については、 「エージェントイメージの構築」ガイドを参照してください。