概述
OpenSearch Provider 提供与 Amazon OpenSearch Serverless 的原生集成，允许 Keep 用户实时查询、监控和写入文档。这支持操作和安全用例的可观测性和事件驱动告警。
主要功能：
- 读写支持：支持查询和写入 OpenSearch Serverless 集合的文档。
- AWS IAM 认证：使用 AWS IAM 凭据（访问密钥/密钥或实例角色）进行认证。
连接 Provider
要使用 Keep 连接 OpenSearch，您需要：
- 具有 OpenSearch Serverless (AOSS) 权限的 AWS 账户。
- AOSS 中配置的集合和索引。
- AWS IAM 凭据（永久或临时）。
所需的 AWS IAM 权限（范围）
为了正常运作，OpenSearch provider 需要以下 IAM 范围：
必填范围
iam:SimulatePrincipalPolicy- 描述：需要检查 IAM 身份是否有权访问 AOSS API。
- 别名：需要测试接下来 3 个范围的访问权限。
- 必填：是
aoss:APIAccessAll- 描述：需要向 OpenSearch Serverless 发出 API 调用。
- 别名：访问服务器无限制 API
- 必填：是
aoss:ListAccessPolicies- 描述：需要列出所有数据访问策略。
- 别名：策略列表访问
- 必填：是
aoss:GetAccessPolicy- 描述：需要检查每个策略的读/写范围。
- 别名：策略读取访问
- 必填：是
aoss:CreateIndex- 描述：需要创建索引。
- 文档：AOSS API Docs
- 别名：创建索引
- 必填：是
aoss:ReadDocument- 描述：需要从 OpenSearch 集合读取文档。
- 文档：AOSS API Docs
- 别名：读取文档
- 必填：是
aoss:WriteDocument- 描述：需要在 OpenSearch 集合中索引或更新文档。
- 文档：AOSS API Docs
- 别名：写入文档
- 必填：是
::: note iam:SimulatePrincipalPolicy、aoss:APIAccessAll、aoss:ListAccessPolicies、aoss:GetAccessPolicy，需要从您的 IAM 控制台添加到 Keep 使用的 IAM 身份。 其他两个策略是需要从 aws serverless dashboard 添加的数据访问策略。 请阅读 readme 以获取分步设置：README :::
认证配置
要向 OpenSearch Serverless 进行认证，请提供以下信息：
- AWS Access Key（必填）：您的 AWS 访问密钥。
- AWS Access Key Secret（必填）：您的 AWS 访问密钥密码。
- Region（必填）：托管 OpenSearch 集合的 AWS 区域。
- Domain Endpoint（必填）：您的 AOSS 集合端点的完整域名 URL。
设置集成
步骤：
- 分配 IAM 权限：授予您的 IAM 用户/角色
aoss:CreateIndex、aoss:ReadDocument和aoss:WriteDocument对目标集合的权限。 - 配置 Keep Provider：在 Keep 平台中提供访问密钥、密码、区域和集合端点。
查询 OpenSearch
Keep 支持使用 _search 端点进行标准 OpenSearch 查询：
- index：要查询的 OpenSearch 索引名称。
- query：有效的 OpenSearch 查询 DSL 对象。
示例
json
{
"query": {
"match_all": {}
},
"size": 1
}写入 OpenSearch
您可以使用 _notify 功能将文档推送到 OpenSearch 集合。
- index：要写入文档的索引名称。
- document：表示文档主体的 Python 字典。
- id：文档的 ID