预配 Cloud 密钥

Overview

在本指南中，您可以学习；了解如何执行部署进程中的第一步：在 AWS Secrets 经理中为已部署的工作区设置密钥。这些密钥用于验证和访问权限云部署所需的资源。

密钥事务语法和选项

使用以下语法在CLI中设立密钥，CLI 会将密钥保存在 AWS Secrets 经理中：

agentengine secret set NAME VALUE [--description <text>] [--sync] [--project-scope | --workspace-scope] [--org-id <id>] [--project-id <id>] [--workspace-id <id>]

下表列出了部分或全部部署所需的密钥值：

密钥	说明
`MONGODB_URI`	MongoDB 部署的连接字符串。所有部署都需要此密钥。
法学硕士密钥	LLM提供商凭证的私钥。可用的键包括 `ANTHROPIC_API_KEY`、`OPENAI_API_KEY`、`GEMINI_API_KEY` 和 `CEREBRAS_API_KEY`。您必须至少设立其中一个值。
`VOYAGE_API_KEY`	您的 Voyage AI凭证的私钥。如果在 `agent.yaml`文件中将 `features.memory`设立为 `true`，则需要此密钥。所有 TypeScript代理部署都需要它。
`MONGOMEM_DB_NAME`	可选。内存服务器写入内容的MongoDB 数据库名称。默认为 `mdb_memory_<project-id>`。设置此密钥以自定义用于内存存储的数据库名称。

提示

如果运行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.yaml文件声明了 artifact_repositories 条目，请使用具有相同命名规则的 agentengine secret set 来设立每个条目的 secret 值。要学习；了解更多信息，请参阅私有工件存储库。

命令标志

设置密钥时，可以使用以下可选标志：

标记	说明
`--description`	人类可读的密钥描述。
`--sync`	设置密钥后将其同步到部署中。
`--project-scope`	针对项目范围的密钥，在项目中的所有工作区之间共享。这是默认。
`--workspace-scope`	以工作区范围的密钥而不是项目范围的密钥为目标。
`--org-id <id>`	直接针对特定组织ID 。
`--project-id <id>`	直接针对特定项目ID 。
`--workspace-id <id>`	直接针对特定的工作区ID 。

删除密钥

使用以下语法从 AWS Secrets 经理永久删除密钥：

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

如果超过密钥限制，请求将返回 400 Bad Request 错误和 RESOURCE_LIMIT_EXCEEDED 消息。

要查看公开预览版期间应用的所有限制，请参阅MongoDB Atlas助手引擎限制。

配置Atlas网络访问

如果 MONGODB_URI 指向Atlas 集群，运行agentengine atlas setup 命令。 CLI会自动将Atlas Agent Engine 数据平面IP地址添加到集群的IP访问列表，以便部署的代理可以连接到集群。

有关Atlas设置的更多信息，请参阅设置Atlas资源页面。

配置示例

以下示例展示了如何从CLI配置MongoDB URI、Anthropic 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 标志在单个命令中设立和同步密钥，如以下示例所示：

agentengine secret set MONGODB_URI 'mongodb+srv://example.mongodb.net' --sync

后续步骤

预配密钥后，请在 agent.yaml文件中声明每个工具可以访问权限哪些密钥。要学习；了解更多信息，请参阅代理合同参考中的代理 YAML 模式。

要为云部署做好准备，构建代理映像。要学习；了解更多信息，请参阅《构建代理映像》指南。