在 Amazon OpenSearch Service 中安装第三方插件 - Amazon OpenSearch Service
先决条件安装第三方插件后续步骤

在 Amazon OpenSearch Service 中安装第三方插件

Amazon OpenSearch Service 支持来自精选合作伙伴的第三方插件。这些插件可通过自定义分析器、分词器或加密功能等附加特性增强您的 OpenSearch 配置。遵循第三方开发者提供的具体安装和配置说明，以确保与您的 OpenSearch Service 域正确集成。

注意

您必须直接从第三方开发人员处获取并保持有效的许可证。某些提供商可能并未在所有 AWS 区域 启用插件，因此请向插件提供商确认可用性。

以下第三方插件可与 OpenSearch Service 配合使用：

  • Portal26 加密插件（Titanium-lockbox）：采用 NIST FIPS 140-2 认证加密技术，在数据索引过程中实时加密。该插件包含自带密钥（BYOK）支持，可让您管理加密密钥以增强安全性。该插件由 Portal26 提供，需要 OpenSearch 版本 2.15 或更高版本。

  • 名称匹配（RNI）：匹配 24 种以上语言的名称、组织、地址和日期，从而提升安全性和合规性。该插件由 Babel Street 提供，需要 OpenSearch 版本 2.15 或更高版本。

先决条件

在安装第三方插件之前，请执行以下步骤：

  • 已获取插件配置和许可文件，并将其上传至 Amazon S3 存储桶。存储桶必须与域位于同一 AWS 区域。

  • 第三方插件是一种自定义插件。确保域满足自定义插件的先决条件。

安装第三方插件

要将第三方插件与 OpenSearch Service 域关联，必须先上传三个单独的程序包：许可证程序包、配置程序包和插件程序包。

  • 许可证程序包涵盖与插件相关联的许可信息或元数据，格式为 .json 或 .xml。

  • 配置程序包涵盖插件配置文件以及支持资产和设置。这些文件定义插件的行为方式或与 OpenSearch 的集成方式。

  • 插件程序包涵盖已编译的插件二进制文件，这是 OpenSearch 运行的可执行代码。这是插件功能的核心部分。

上传两个程序包后，即可将插件和许可证与兼容的域相关联。

要将第三方插件与域关联，请先将插件许可证和配置作为程序包导入。

安装第三方插件

  1. 登录到位于 https://console.aws.amazon.com/aos/home 的 Amazon OpenSearch Service 控制台。

  2. 在左侧导航窗格中，选择程序包。

  3. 首先，导入许可证程序包。选择导入程序包。

  4. 对于程序包类型，选择许可证。

  5. 对于程序包来源，输入 Amazon S3 中许可证 JSON 或 XML 文件的路径。

  6. 选择导入。程序包显示在程序包页面的许可证选项卡上。

  7. 现在，导入插件配置。再次选择导入软件包。

  8. 对于程序包类型，选择配置。

  9. 对于程序包来源，输入 Amazon S3 中插件配置 ZIP 文件的路径。

  10. 选择导入。

  11. 最后，导入插件本身。选择导入程序包。

  12. 对于程序包类型，选择插件。

  13. 对于程序包来源，输入 Amazon S3 中插件 ZIP 文件的路径。

  14. 选择该插件支持的 OpenSearch 引擎版本。

  15. 选择导入。

将第三方插件与域关联

  1. 现在，将插件许可证和配置与域关联。在左侧导航窗格中，选择 Domains（域）。

  2. 选择域的名称，以打开其集群配置。

  3. 导航到插件选项卡。

  4. 选择关联软件包，然后选择刚导入的插件、许可证和配置程序包。

  5. 选定选择。

  6. 选择下一步。查看要关联的程序包，并选择关联。

首先，使用 create-package 命令创建包含插件许可证的新程序包。S3Key 必须指向 Amazon S3 中包含许可文本或元数据的 .json 或 .xml 文件。

aws opensearch create-package \
  --package-name plugin-license-package \
  --package-type PACKAGE-LICENSE \
  --package-source S3BucketName=my-bucket,S3Key=licenses/my-plugin-license.json

再次使用 create-package 命令创建包含插件配置的程序包。S3Key 必须指向 Amazon S3 中符合插件预期目录结构的 .zip 文件。

aws opensearch create-package \
  --package-name plugin-config-package \
  --package-type PACKAGE-CONFIG \
  --package-source S3BucketName=my-bucket,S3Key=path/to/package.zip

再次使用 create-package 命令创建包含插件本身的程序包。S3Key 必须指向 Amazon S3 中的插件 .zip 文件。

aws opensearch create-package \
  --package-name plugin-package \
  --package-type ZIP-PLUGIN \
  --package-source S3BucketName=my-bucket,S3Key=path/to/package.zip

最后，使用 associate-package 命令，通过指定每个域的程序包 ID，将合作伙伴插件、许可证和配置关联到兼容的域。将插件 ID 指定为其他程序包的先决条件，这意味着插件 ID 必须先与域关联，然后再关联其他程序包。

aws opensearch associate-packages \
  --domain-name my-domain \
  --package-list '[{"PackageID": "plugin-package-id"},{"PackageID": "license-package-id","PrerequisitePackageIDList":["plugin-package-id"]},{"PackageID":"config-package-id","PrerequisitePackageIDList":["plugin-package-id"]}]'

后续步骤

当关联完成后，您可以根据需求在特定索引上启用该插件或进行相应配置。要将第三方插件功能应用于特定索引，请在创建索引时修改索引设置，或更新现有索引。例如，如果您的第三方插件包含自定义分析器，请在索引设置中进行引用。

要在多个索引中一致地应用插件功能，则使用包含插件配置的索引模板。请务必查阅插件文档，以了解如何根据 OpenSearch 环境配置其功能。