管理 Amazon OpenSearch Service 中的自定义插件

安装自定义插件

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

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

3. 选择导入程序包。

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

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

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

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

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

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

10. 选择导入。

使用 AWS CLI 安装自定义插件

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

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

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

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

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

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

   将占位符值替换为您自己的信息：

   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 操作的状态，包括任何验证和安全漏洞调查发现。将占位符值 替换为您自己的信息：

   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 OpenSearch Service 会检查 ZIP-PLUGIN 值的版本兼容性、支持的插件扩展以及安全漏洞。使用 Amazon Inspector 服务扫描安全漏洞。这些检查的结果显示在 API 响应的 ErrorDetails 字段中。

3. 使用 associate-package 命令，通过上一步所创建程序包的包 ID，将插件关联到您选择的 OpenSearch Service 域。

   提示

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

   将占位符值 替换为您自己的信息：

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

   注意

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

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

   将占位符值替换为您自己的信息。

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

使用 AWS CLI 更新自定义插件

• 运行以下命令。将占位符值替换为您自己的信息。

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

使用 AWS CLI，将带有自定义插件的 OpenSearch Service 域升级至更高版本的 OpenSearch

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

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

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

   在此过程中，Amazon OpenSearch Service 会解除旧版本插件程序包的关联，并通过蓝绿部署方式安装新版本。

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

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

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

2. 运行以下命令卸载插件。将占位符值替换为您自己的信息。

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

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