舰队注册令牌

编辑

舰队注册令牌(在舰队 API 文档中称为enrollment API key)是一个 Elasticsearch API 密钥,用于将一个或多个 Elastic Agent 注册到舰队中。注册令牌将 Elastic Agent 注册到特定代理策略中,该策略定义代理要收集的数据。您可以根据需要多次使用此令牌。它将一直有效,直到您将其撤销。

注册令牌用于 Elastic Agent 和舰队服务器之间的初始通信。在 Elastic Agent 发出初始连接请求后,舰队服务器会向 Elastic Agent 传递两个 API 密钥。

  • 输出 API 密钥

    此 API 密钥用于将数据发送到 Elasticsearch。它具有将代理策略指定的所有数据导入所需的最低权限。如果 API 密钥无效,Elastic Agent 将停止将数据导入 Elasticsearch。

  • 通信 API 密钥

    此 API 密钥用于与舰队服务器通信。它只有与舰队服务器通信所需的权限。如果 API 密钥无效,舰队服务器将停止与 Elastic Agent 通信。

创建注册令牌

编辑

创建注册令牌并使用它们将 Elastic Agent 注册到特定策略中。

当您使用舰队 UI 添加代理或创建新策略时,舰队会自动为您创建一个注册令牌。

创建注册令牌

  1. 在 Kibana 中,转到 管理 → 舰队 → 注册令牌
  2. 单击 创建注册令牌。命名您的令牌并选择一个代理策略。

    请注意,您指定的令牌名称必须唯一,以避免与任何现有 API 密钥冲突。

    Enrollment tokens tab in Fleet
  3. 单击 创建注册令牌
  4. 在令牌列表中,单击 显示令牌 图标以查看令牌密钥。

    Enrollment tokens tab with Show token icon highlighted

通过此令牌注册的所有 Elastic Agent 将使用所选策略,除非您将其分配或注册到其他策略。

要了解如何安装 Elastic Agent 并将其注册到舰队中,请参阅 安装 Elastic Agent

您可以使用舰队 API 获取注册令牌列表。有关更多信息,请参阅 Kibana 舰队 API

撤销注册令牌

编辑

您可以撤销不再希望用于将 Elastic Agent 注册到舰队中代理策略的注册令牌。撤销注册令牌实际上会使代理用于与舰队服务器通信的 API 密钥无效。

撤销注册令牌

  1. 在舰队中,单击 注册令牌
  2. 在列表中找到要撤销的令牌,然后单击 撤销令牌 图标。

    Enrollment tokens tab with Revoke token highlighted
  3. 单击 撤销注册令牌。您将无法再使用此令牌注册 Elastic Agent。但是,当前已注册的代理将继续运行。

    要重新注册您的 Elastic Agent,请使用活动的注册令牌。

请注意,撤销注册令牌后不会立即将其删除。删除操作会在 Elasticsearch xpack.security.authc.api_key.delete.retention_period 设置中指定的持续时间过期后自动发生(有关详细信息,请参阅 使 API 密钥无效 API)。

在注册令牌被删除之前

  • 当您创建注册令牌时,令牌名称可能无法重复使用。
  • 令牌将继续显示在舰队 UI 中。
  • GET /api/fleet/enrollment_api_keys API 请求将继续返回令牌。已撤销的注册令牌被标识为 "active": false