在 Amazon OpenSearch 服务中管理自定义插件

安装自定义插件

1. 在https://console.aws.amazon.com/aos/家中登录亚马逊 OpenSearch 服务控制台。

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

3. 选择 Import package（导入软件包）。

4. 对于名称，输入唯一且易于识别的插件名称。

5. （可选）对于描述，提供有关程序包或其用途的所有有用详细信息。

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

7. 对于程序包来源，输入路径或浏览到 Amazon S3 中的插件 ZIP 文件。

8. 对于OpenSearch 引擎版本，请选择插 OpenSearch 件支持的版本。

9. 对于程序包加密，选择是否为程序包自定义加密密钥。默认情况下，S OpenSearch ervice 使用加密插件包。 AWS 拥有的密钥您也可以使用客户托管型密钥。

10. 选择导入。

要安装自定义插件，请使用 AWS CLI

1. 运行以下 create-package 命令为自定义插件创建新程序包，确保满足以下要求：

   • 存储桶和密钥位置必须指向您运行命令的账户中 S3 存储桶的插件 .zip 文件。

   • S3 存储桶必须位于所创建程序包的同一区域。

   • ZIP-PLUGIN 程序包仅支持 .zip 文件。

   • .zip 文件的内容必须遵循插件预期的目录结构。

   • --engine-version 的值必须采用格式 OpenSearch_{MAJOR}.{MINOR}。例如：OpenSearch_2.17。

   placeholder values用您自己的信息替换：

   aws opensearch create-package \
       --package-name package-name \
       --region region \
       --package-type ZIP-PLUGIN \
       --package-source S3BucketName=amzn-s3-demo-bucket,S3Key=s3-key \
       --engine-version opensearch-version

2. （可选）使用 describe-packages 命令查看 create-package 操作的状态，包括任何验证和安全漏洞调查发现。placeholder values用您自己的信息替换：

   aws opensearch describe-packages \
       --region region  \
       --filters '[{"Name": "PackageType","Value": ["ZIP-PLUGIN"]}, {"Name": "PackageName","Value": ["package-name"]}]'

   命令返回类似于下文的信息：

   {
       "PackageDetailsList": [{
           "PackageID": "pkg-identifier",
           "PackageName": "package-name",
           "PackageType": "ZIP-PLUGIN",
           "PackageStatus": "VALIDATION_FAILED",
           "CreatedAt": "2024-11-11T13:07:18.297000-08:00",
           "LastUpdatedAt": "2024-11-11T13:10:13.843000-08:00",
           "ErrorDetails": {
               "ErrorType": "",
               "ErrorMessage": "PluginValidationFailureReason : Dependency Scan reported 3 vulnerabilities for the plugin: CVE-2022-23307, CVE-2019-17571, CVE-2022-23305"
           },
           "EngineVersion": "OpenSearch_2.15",
           "AllowListedUserList": [],
           "PackageOwner": "OWNER-XXXX"
       }]
   }

   注意

   在create-package操作过程中，Amazon Serv OpenSearch ice 会检查该ZIP-PLUGIN值的版本兼容性、支持的插件扩展和安全漏洞。使用 Amazon Inspector 服务扫描安全漏洞。这些检查的结果显示在 API 响应的 ErrorDetails 字段中。

3. 使用 ass ociate-package 命令使用上一步中创建的软件包的软件包 ID 将插件与您选择的 OpenSearch 服务域关联起来。

   提示

   如果您有多个插件，则可改用 associate-packages 命令，通过单次操作将多个程序包关联至某个域。

   placeholder values用您自己的信息替换：

   aws opensearch associate-package \
       --domain-name domain-name \
       --region region \
       --package-id package-id

   注意

   使用蓝绿部署过程安装和卸载插件。

4. （可选）使用list-packages-for-domain命令查看关联的状态。随着工作流程从 ASSOCIATING 到 ACTIVE 的进展，关联状态随之变化。插件安装完成后，其状态将更改为“活动”，此时插件已可投入使用。

   将 placeholder values 替换为您自己的信息。

   aws opensearch list-packages-for-domain \
       --region region \
       --domain-name domain-name

要更新自定义插件，请使用 AWS CLI

• 运行如下命令。将 placeholder values 替换为您自己的信息。

  aws opensearch update-package \
      --region region \
      --package-id package-id \
      --package-source S3BucketName=amzn-s3-demo-bucket,S3Key=s3-key \
      --package-description description

要将带有自定义插件的 OpenSearch 服务域升级到更高版本的 OpenSearch使用 AWS CLI

1. 使用 create-package 命令为您的插件创建一个新软件包，指定新 OpenSearch 版本。

   确保所有引擎版本的插件程序包名称保持一致。更改软件包名称会导致域升级过程在 blue/green 部署期间失败。

2. 按照 升级 Amazon OpenSearch Service 域 中的步骤将域升级至更高版本。

   在此过程中，Amazon Serv OpenSearch ice 会解除先前版本的插件包的关联，并使用 blue/green 部署来安装新版本。

卸载自定义插件和查看其解除关联状态

1. 在每个索引中禁用插件。这必须在解除插件程序包的关联之前完成。

   如果您在从每个索引中禁用插件之前尝试将其卸载，则 blue/green 部署过程仍处于该Processing状态。

2. 运行以下命令卸载插件。将 placeholder values 替换为您自己的信息。

   aws opensearch dissociate-package \
       --region region \
       --package-id plugin-package-id \
       --domain-name domain name
   

3. （可选）运行list-packages-for-domain命令以查看解除关联的状态。