Administración de complementos personalizados en Amazon OpenSearch Service

Para instalar un complemento personalizado

1. Inicie sesión en la consola de Amazon OpenSearch Service en https://console.aws.amazon.com/aos/home.

2. En el panel de navegación izquierdo, elija Paquetes.

3. Seleccione Importar paquete.

4. En Nombre, ingrese un nombre único y fácil de identificar para el complemento.

5. (Opcional) En la descripción, proporciona cualquier detalle útil sobre el paquete o su propósito.

6. En Tipo de paquete, elija Complemento.

7. En Origen del paquete, ingrese la ruta o busque el archivo ZIP del complemento en Amazon S3.

8. Para la versión del motor OpenSearch, elija la versión de OpenSearch compatible con el complemento.

9. Para el cifrado de paquetes, elija si desea personalizar la clave de cifrado del paquete. De forma predeterminada, OpenSearch Service cifra el paquete de complementos con una Clave propiedad de AWS. En su lugar, puede usar una clave administrada por el cliente.

10. Seleccione Importar.

Instalación de un complemento personalizado mediante la AWS CLI

1. Cree un nuevo paquete para su complemento personalizado ejecutando el siguiente comando create-package, asegurándose de cumplir con los siguientes requisitos:

   • La ubicación del bucket y la clave debe apuntar al archivo .zip del complemento en un bucket de S3 de la cuenta en la que está ejecutando los comandos.

   • El bucket de S3 debe estar en la misma región en la que se está creando el paquete.

   • Solo se admiten archivos .zip para los paquetes ZIP-PLUGIN.

   • El contenido del archivo .zip debe seguir la estructura de directorios esperada por el complemento.

   • El valor de --engine-version debe estar en el formato OpenSearch_{MAJOR}.{MINOR}. Por ejemplo: OpenSearch_2.17.

   Reemplace los valores de marcador de posición con su información:

   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. (Opcional) Vea el estado de la operación create-package, incluidos los resultados de validación y las vulnerabilidades de seguridad, usando el comando describe-packages. Reemplace los valores de marcador de posición con su información:

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

   El comando devuelve información similar a la siguiente:

   {
       "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"
       }]
   }

   nota

   Durante la operación create-package, Amazon OpenSearch Service verifica el valor ZIP-PLUGIN para la compatibilidad de la versión, las extensiones de complemento compatibles y las vulnerabilidades de seguridad. Las vulnerabilidades de seguridad se escanean mediante el servicio Amazon Inspector. Los resultados de estas verificaciones se muestran en el campo ErrorDetails de la respuesta de la API.

3. Utilice el comando associate-package para asociar el complemento al dominio de OpenSearch Service que elija utilizando el ID de paquete del paquete creado en el paso anterior.

   sugerencia

   Si tiene varios complementos, puede usar el comando associate-packages para asociar múltiples paquetes a un dominio en una sola operación.

   Reemplace los valores de marcador de posición con su información:

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

   nota

   El complemento se instala y desinstala utilizando un proceso de implementación azul/verde.

4. (Opcional) Use el comando list-packages-for-domain para ver el estado de la asociación. El estado de la asociación cambia a medida que el flujo de trabajo avanza de ASSOCIATING a ACTIVE. El estado de la asociación cambia a ACTIVE cuando se completa la instalación del complemento y el complemento está listo para su uso.

   Reemplace los valores de marcador de posición con su información.

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

Para actualizar un complemento personalizado mediante la AWS CLI

• Ejecute el siguiente comando. Reemplace los valores de marcador de posición con su información.

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

Para actualizar un dominio de OpenSearch Service con complementos personalizados a una versión posterior de OpenSearch mediante la AWS CLI.

1. Use el comando create-package para crear un nuevo paquete para su complemento especificando la nueva versión de OpenSearch.

   Asegúrese de que el nombre del paquete sea el mismo para el complemento en todas las versiones del motor. Si se cambia el nombre del paquete, se produce un error en el proceso de actualización del dominio durante la implementación azul/verde.

2. Actualice su dominio a una versión superior siguiendo los pasos que se indican en Actualización de los dominios de Amazon OpenSearch Service.

   Durante este proceso, Amazon OpenSearch Service desasocia la versión anterior del paquete de complementos e instala la nueva versión mediante una implementación azul/verde.

Desinstalar y ver el estado de disociación de un complemento personalizado

1. Deshabilita el complemento en todos los índices. Esto debe hacerse antes de disociar el paquete de complementos.

   Si intenta desinstalar un complemento antes de deshabilitarlo en cada índice, el proceso de implementación azul/verde permanecerá atascado en el estado Processing.

2. Ejecute el siguiente comando para desinstalar el complemento. Reemplace los valores de marcador de posición con su información.

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

3. (Opcional) Ejecute el comando list-packages-for-domain para ver el estado de la disociación.