

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 在 Amazon OpenSearch 服务中安装第三方插件
<a name="plugins-third-party"></a>

Amazon OpenSearch 服务支持选定合作伙伴提供的第三方插件。这些插件可以通过自定义分析器、分词器或加密功能等其他功能来增强您的 OpenSearch 设置。按照第三方开发人员提供的特定安装和配置说明进行操作，以确保与您的 OpenSearch 服务域正确集成。

**注意**  
您必须直接从第三方开发人员处获取并保持有效的许可证。某些提供商可能无法完全启用其插件 Amazon Web Services 区域，因此请向插件提供商查询可用性。

以下第三方插件可用于 S OpenSearch ervice：
+ **Portal26 加密插件（Titanium-lockbox）**：采用 NIST FIPS 140-2 认证加密技术，在数据索引过程中实时加密。该插件包含自带密钥（BYOK）支持，可让您管理加密密钥以增强安全性。该插件由 [Portal26](https://portal26.ai/) 提供，需要 OpenSearch 版本 2.15 或更高版本。
+ **名称匹配（RNI）**：匹配 24 种以上语言的名称、组织、地址和日期，从而提升安全性和合规性。该插件由 [Babel Stre](https://www.babelstreet.com/) et 提供，需要 OpenSearch 版本 2.15 或更高版本。

**Topics**
+ [先决条件](#prerequisites-partner-plugins)
+ [安装第三方插件](#third-party-partner-plugins-install)
+ [后续步骤](#third-party-partner-plugins-next)

## 先决条件
<a name="prerequisites-partner-plugins"></a>

在安装第三方插件之前，请执行以下步骤：
+ 已获取插件配置和许可文件，并将其上传至 Amazon S3 存储桶。存储桶必须与域 Amazon Web Services 区域 相同。
+ 第三方插件是一种自定义插件。确保域满足自定义插件的[先决条件](custom-plugins.md#custom-plugin-prerequisites)。

## 安装第三方插件
<a name="third-party-partner-plugins-install"></a>

要将第三方插件与 OpenSearch 服务域关联，必须先上传三个单独的软件包：*许可证*包、*配置*包和*插件*包。
+ **许可证**程序包涵盖与插件相关联的许可信息或元数据，格式为 .json 或 .xml。
+ **配置**程序包涵盖插件配置文件以及支持资产和设置。这些文件定义了插件的行为方式或与 OpenSearch之集成的方式。
+ **插件**包包含已编译的插件二进制文件，即 OpenSearch 运行的可执行代码。这是插件功能的核心部分。

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

### 控制台
<a name="third-party-partner-plugins-console"></a>

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

**安装第三方插件**

1. 在[https://console.aws.amazon.com/aos/家](https://console.amazonaws.cn/aos/home)中登录亚马逊 OpenSearch 服务控制台。

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

1. 首先，导入许可证程序包。选择 **Import package（导入软件包）**。

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

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

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

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

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

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

1. 选择**导入**。

1. 最后，导入插件本身。选择 **Import package（导入软件包）**。

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

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

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

1. 选择**导入**。

**将第三方插件与域关联**

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

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

1. 导航到**插件**选项卡。

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

1. 选定**选择**。

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

### CLI
<a name="third-party-partner-plugins-cli"></a>

首先，使用 [create-package](https://docs.amazonaws.cn/cli/latest/reference/opensearch/create-package.html) 命令创建包含插件许可证的新程序包。`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](https://docs.amazonaws.cn/cli/latest/reference/opensearch/create-package.html) 命令创建包含插件配置的程序包。`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](https://docs.amazonaws.cn/cli/latest/reference/opensearch/create-package.html) 命令创建包含插件本身的程序包。`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}}
```

最后，使用 ass [ociate-package 命令通过为每个域指定软件包](https://docs.amazonaws.cn/cli/latest/reference/opensearch/associate-package.html)，将合作伙伴插件、许可证和配置链接到兼容的域。 IDs 将插件 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}}"]}]'
```

## 后续步骤
<a name="third-party-partner-plugins-next"></a>

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

要在多个索引中一致地应用插件功能，则使用包含插件配置的[索引模板](https://opensearch.org/docs/latest/im-plugin/index-templates/)。请务必查阅插件文档，了解如何为您的 OpenSearch 设置配置其功能。