Gestión de complementos personalizados en Amazon OpenSearch Service

Para instalar un complemento personalizado

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

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 OpenSearch del motor, elige la OpenSearch versión compatible con el plugin.

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 un Clave propiedad de AWS. En su lugar, puede usar una clave administrada por el cliente.

10. Seleccione Importar.

Para instalar un complemento personalizado mediante el 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.

   Sustitúyalo por tu propia información: 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. (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. Sustitúyalo por su propia información: placeholder values

   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 create-package operación, Amazon OpenSearch Service comprueba el ZIP-PLUGIN valor para comprobar la compatibilidad de versiones, las extensiones de complementos 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. Usa el comando associate-package para asociar el complemento al dominio de OpenSearch servicio que elijas 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.

   Sustitúyalo placeholder values por tu propia 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) Utilice el list-packages-for-domaincomando 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.

   Sustituya placeholder values por su propia información.

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

Para actualizar un complemento personalizado mediante el AWS CLI

• Ejecute el comando siguiente. Sustituya placeholder values por su propia 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 servicio con complementos personalizados a una versión posterior OpenSearch mediante el AWS CLI

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

   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 blue/green implementación.

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

   Durante este proceso, Amazon OpenSearch Service desasocia la versión anterior del paquete de complementos e instala la nueva versión mediante un blue/green despliegue.

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 intentas desinstalar un complemento antes de deshabilitarlo en todos los índices, el proceso de blue/green implementación permanece estancado en ese estado. Processing

2. Ejecute el siguiente comando para desinstalar el complemento. Sustituya placeholder values por su propia información.

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

3. (Opcional) Ejecuta el list-packages-for-domaincomando para ver el estado de la disociación.