使用 API 密钥授予访问权限

编辑

使用 API 密钥授予访问权限编辑

您可以使用 API 密钥来授予对 Elasticsearch 资源的访问权限,而不是使用用户名和密码。您可以设置 API 密钥在特定时间过期,并且可以明确地使它们失效。任何具有 manage_api_keymanage_own_api_key 集群权限的用户都可以创建 API 密钥。

Metricbeat 实例通常将收集到的数据和监控信息都发送到 Elasticsearch。如果您将两者发送到同一个集群,则可以使用相同的 API 密钥。对于不同的集群,您需要为每个集群使用一个 API 密钥。

出于安全原因,我们建议每个 Metricbeat 实例使用唯一的 API 密钥。您可以在每个用户处创建所需的任意数量的 API 密钥。

在为 Metricbeat 创建 API 密钥之前,请查看授予用户访问受保护资源的权限

创建用于发布的 API 密钥编辑

要创建用于将数据写入 Elasticsearch 的 API 密钥,请使用 创建 API 密钥 API,例如

POST /_security/api_key
{
  "name": "metricbeat_host001", 
  "role_descriptors": {
    "metricbeat_writer": { 
      "cluster": ["monitor", "read_ilm", "read_pipeline"],
      "index": [
        {
          "names": ["metricbeat-*"],
          "privileges": ["view_index_metadata", "create_doc", "auto_configure"]
        }
      ]
    }
  }
}

API 密钥的名称

授予的权限,请参阅授予用户访问受保护资源的权限

有关发布事件所需的权限列表,请参阅创建发布用户

返回值将类似于以下内容

{
  "id":"TiNAGG4BaaMdaH1tRfuU", 
  "name":"metricbeat_host001",
  "api_key":"KnR6yE41RrSowb0kQ0HWoA" 
}

此 API 密钥的唯一 ID

生成的 API 密钥

您现在可以在您的 metricbeat.yml 配置文件中使用此 API 密钥,例如

output.elasticsearch:
  api_key: TiNAGG4BaaMdaH1tRfuU:KnR6yE41RrSowb0kQ0HWoA 

格式为 id:api_key(如 创建 API 密钥 返回的那样)

创建用于监控的 API 密钥编辑

要创建用于将监控数据发送到 Elasticsearch 的 API 密钥,请使用 创建 API 密钥 API,例如

POST /_security/api_key
{
  "name": "metricbeat_host001", 
  "role_descriptors": {
    "metricbeat_monitoring": { 
      "cluster": ["monitor"],
      "index": [
        {
          "names": [".monitoring-beats-*"],
          "privileges": ["create_index", "create"]
        }
      ]
    }
  }
}

API 密钥的名称

授予的权限,请参阅授予用户访问受保护资源的权限

有关发送监控数据所需的权限列表,请参阅创建监控用户

返回值将类似于以下内容

{
  "id":"TiNAGG4BaaMdaH1tRfuU", 
  "name":"metricbeat_host001",
  "api_key":"KnR6yE41RrSowb0kQ0HWoA" 
}

此 API 密钥的唯一 ID

生成的 API 密钥

您现在可以在您的 metricbeat.yml 配置文件中使用此 API 密钥,例如

monitoring.elasticsearch:
  api_key: TiNAGG4BaaMdaH1tRfuU:KnR6yE41RrSowb0kQ0HWoA 

格式为 id:api_key(如 创建 API 密钥 返回的那样)

了解有关 API 密钥的更多信息编辑

有关更多信息,请参阅 Elasticsearch API 密钥文档