Instalación de complementos de terceros en Amazon OpenSearch Service - Amazon OpenSearch Service
Requisitos previosInstalación de complementos de tercerosPasos a seguir a continuación

Instalación de complementos de terceros en Amazon OpenSearch Service

Amazon OpenSearch Service admite complementos de terceros de socios seleccionados. Estos complementos pueden mejorar su configuración de OpenSearch con características adicionales, como analizadores personalizados, tokenizadores o capacidades de cifrado. Siga las instrucciones específicas de instalación y configuración proporcionadas por los desarrolladores de terceros para garantizar una integración adecuada con su dominio de OpenSearch Service.

nota

Debe obtener y mantener licencias válidas directamente de los desarrolladores de terceros. Algunos proveedores podrían no habilitar sus complementos en todas las Regiones de AWS, por lo que debe consultar con el proveedor del complemento sobre su disponibilidad.

Los siguientes complementos de terceros están disponibles para su uso con OpenSearch Service:

  • Complemento de cifrado Portal26 (Titanium-Lockbox): Utiliza cifrado certificado NIST FIPS 140-2 para cifrar datos mientras se indexan. Incluye soporte Bring Your Own Key (BYOK), que le permite administrar sus claves de cifrado para mayor seguridad. Este complemento es proporcionado por Portal26 y requiere OpenSearch versión 2.15 o superior.

  • Concordancia de nombres (RNI): Coincide nombres, organizaciones, direcciones y fechas en más de 24 idiomas, lo que mejora la seguridad y el cumplimiento normativo. Este complemento es proporcionado por Babel Street y requiere OpenSearch versión 2.15 o superior.

Requisitos previos

Antes de instalar un complemento de terceros, realice los siguientes pasos:

  • Obtenga los archivos de configuración y licencia del complemento y cárguelos en un bucket de Amazon S3. El bucket debe estar en la misma Región de AWS que el dominio.

  • Un complemento de terceros es un tipo de complemento personalizado. Asegúrese de que el dominio cumpla con los requisitos previos para complementos personalizados.

Instalación de complementos de terceros

Para asociar un complemento de terceros con un dominio de OpenSearch Service, primero debe cargar tres paquetes separados: el paquete de licencia, el paquete de configuración y el paquete del complemento.

  • Paquete de licencia: incluye la información de licencia o metadatos asociados con el complemento, en formato .json o .xml.

  • Paquete de configuración: contiene los archivos de configuración del complemento, los recursos de soporte y la configuración. Estos archivos definen cómo se comporta o se integra el complemento con OpenSearch.

  • Paquete del complemento: contiene el binario compilado del complemento, que es el código ejecutable que OpenSearch ejecuta. Este es el núcleo de la funcionalidad del complemento.

Después de cargar los paquetes, puede asociar el complemento y la licencia con un dominio compatible.

Para asociar un complemento de terceros a un dominio, primero importe la licencia y la configuración del complemento como paquetes.

Para instalar un complemento de terceros

  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. En primer lugar, importe el paquete de licencias. Seleccione Importar paquete.

  4. En Tipo de paquete, elija Licencia.

  5. En Origen del paquete, ingrese la ruta al archivo JSON o XML de la licencia en Amazon S3.

  6. Seleccione Importar. El paquete aparece en la pestaña Licencias de la página Paquetes.

  7. Ahora, importe la configuración del complemento. Seleccione nuevamente Importar paquete.

  8. En Tipo de paquete, elija Configuración.

  9. Para Origen del paquete, ingrese la ruta al archivo ZIP de la configuración del complemento en Amazon S3.

  10. Seleccione Importar.

  11. Por último, importe el propio complemento. Seleccione Importar paquete.

  12. En Tipo de paquete, elija Complemento.

  13. En Origen del paquete, ingrese la ruta del archivo ZIP del complemento en Amazon S3.

  14. Seleccione la versión del motor de búsqueda OpenSearch compatible con el complemento.

  15. Seleccione Importar.

Para asociar un complemento de terceros a un dominio

  1. Ahora, asocie la licencia y la configuración del complemento al dominio. En el panel de navegación izquierdo, seleccione Dominios.

  2. Elija el nombre del dominio para abrir su configuración de clúster.

  3. Vaya a la pestaña Complementos.

  4. Elija Asociar paquetes y seleccione los paquetes de complementos, licencias y configuración que acaba de importar.

  5. Elija Seleccionar.

  6. Elija Siguiente. Revise los paquetes que desea asociar y elija Asociar.

Primero, use el comando create-package para crear un paquete nuevo que contenga la licencia del complemento. La S3Key debe apuntar a un archivo .json o .xml en Amazon S3 que incluya el texto de la licencia o los metadatos.

aws opensearch create-package \
  --package-name plugin-license-package \
  --package-type PACKAGE-LICENSE \
  --package-source S3BucketName=my-bucket,S3Key=licenses/my-plugin-license.json

Use el comando create-package nuevamente para crear un paquete que contenga la configuración del complemento. La S3Key debe apuntar a un archivo .zip en Amazon S3 que cumpla con la estructura de directorios esperada por el complemento.

aws opensearch create-package \
  --package-name plugin-config-package \
  --package-type PACKAGE-CONFIG \
  --package-source S3BucketName=my-bucket,S3Key=path/to/package.zip

Use nuevamente el comando create-package para crear un paquete que contenga el complemento en sí. La S3Key debe apuntar al archivo .zip del complemento en Amazon S3.

aws opensearch create-package \
  --package-name plugin-package \
  --package-type ZIP-PLUGIN \
  --package-source S3BucketName=my-bucket,S3Key=path/to/package.zip

Finalmente, use el comando associate-package para vincular el complemento del socio, la licencia y la configuración a un dominio compatible, especificando los ID de paquete de cada uno. Especifique el ID del complemento como un requisito previo para los demás paquetes; esto significa que debe asociarse al dominio antes que los otros paquetes.

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

Pasos a seguir a continuación

Cuando la asociación se complete, usted podrá habilitar el complemento en índices específicos o configurarlo según sus necesidades. Para aplicar la funcionalidad del complemento de terceros a índices específicos, modifique la configuración del índice durante su creación o actualice índices existentes. Por ejemplo, si su complemento de terceros incluye un analizador personalizado, haga referencia a este en la configuración del índice.

Para aplicar las características del complemento de manera uniforme en varios índices, use plantillas de índice que incluyan las configuraciones del complemento. Consulte siempre la documentación del complemento para comprender cómo configurar sus características en su entorno de OpenSearch.