Instalar plug-ins de terceiros no Amazon OpenSearch Service - Amazon OpenSearch Service
Pré-requisitosInstalar plug-ins de terceirosPróximas etapas

Instalar plug-ins de terceiros no Amazon OpenSearch Service

O Amazon OpenSearch Service é compatível com plug-ins de parceiros selecionados. Esses plug-ins podem aprimorar sua configuração do OpenSearch com atributos adicionais, como analisadores personalizados, tokenizadores ou recursos de criptografia. Siga as instruções específicas de instalação e configuração fornecidas pelos desenvolvedores terceirizados para garantir a integração adequada com o domínio do OpenSearch Service.

nota

Você deve obter e manter licenças válidas diretamente dos desenvolvedores terceirizados. Alguns provedores podem não habilitar seus plug-ins em todos as Regiões da AWS; por isso, verifique a disponibilidade com o provedor do plug-in.

Os seguintes plug-ins de terceiros estão disponíveis para uso com o OpenSearch Service:

  • Plugin de criptografia Portal26 (Titanium-lockbox): usa criptografia certificada pelo NIST FIPS 140-2 para criptografar dados à medida que são indexados. Inclui compatibilidade com Bring Your Own Key (BYOK), que permite que você gerencie suas chaves de criptografia para aumentar a segurança. O plug-in é fornecido pelo Portal26 e requer o OpenSearch versão 2.15 ou acima.

  • Name Match (RNI): verifica a correspondência de nomes, organizações, endereços e datas em mais de 24 idiomas, o que aumenta a segurança e a conformidade. O plug-in é fornecido pela Babel Street e requer o OpenSearch versão 2.15 ou acima.

Pré-requisitos

Antes de instalar um plug-ins de terceiros, realize as seguintes etapas:

  • Obteve a configuração do plug-in e os arquivos de licença e os carregou em um bucket do Amazon S3. O bucket deve estar na mesma Região da AWS que o domínio.

  • Um plug-in de terceiros é um tipo de plug-in personalizado. Certifique-se de que o domínio atenda aos pré-requisitos para plug-ins personalizados.

Instalar plug-ins de terceiros

Para associar um plug-in de terceiros a um domínio do OpenSearch Service, primeiro você deve carregar três pacotes separados: o pacote de licença, o pacote de configuração e o pacote do plug-in.

  • O pacote de licença inclui as informações de licenciamento ou os metadados associados ao plug-in, no formato .json ou .xml.

  • O pacote de configuração contém os arquivos de configuração do plug-in e os ativos e as configurações de apoio. Esses arquivos definem como o plug-in se comporta ou se integra com o OpenSearch.

  • O pacote do plug-in contém o binário do plug-in compilado, que é o código que o OpenSearch executa. Esse é o núcleo da funcionalidade do plug-in.

Depois de carregar ambos os pacotes, você pode associar o plug-in e a licença a um domínio compatível.

Para associar um plug-in de terceiros a um domínio, primeiro importe a licença e a configuração do plug-in como pacotes.

Para instalar um plug-in de terceiros

  1. Faça login no console do Amazon OpenSearch Service em https://console.aws.amazon.com/aos/home.

  2. No painel de navegação à esquerda, selecione Pacotes.

  3. Primeiro, importe o pacote de licença. Escolha Importar pacote.

  4. Em Tipo de pacote, escolha Licença.

  5. Em Origem do pacote, insira o caminho para o arquivo de licença JSON ou XML no Amazon S3.

  6. Escolha Importar. O pacote aparece na guia Licenças da página Pacotes.

  7. Agora, importe a configuração do plugin. Escolha Importar pacote novamente.

  8. Em Tipo de pacote, escolha Configuração.

  9. Em Origem do pacote, insira o caminho até o arquivo ZIP de configuração do plug-in no Amazon S3.

  10. Escolha Importar.

  11. Por fim, importe o plug-in em si. Escolha Importar pacote.

  12. Em Tipo de pacote, escolha Plug-in.

  13. Em Origem do pacote, insira o caminho até o arquivo ZIP do plug-in no Amazon S3.

  14. Selecione a versão do mecanismo do OpenSearch compatível com o plug-in.

  15. Escolha Importar.

Para associar um plug-in de terceiros a um domínio

  1. Agora, associe a licença e a configuração do plug-in ao domínio. No painel de navegação à esquerda, selecione Domínios.

  2. Escolha o nome do domínio para abrir a configuração de cluster.

  3. Navegue até a guia Plug-ins.

  4. Escolha Associar pacotes e selecione os pacotes de plug-in, licença e configuração que você acabou de importar.

  5. Escolha Selecionar.

  6. Escolha Próximo. Revise os pacotes a serem associados e escolha Associar.

Primeiro, use o comando create-package para criar um novo pacote contendo a licença do plug-in. A S3Key deve apontar para um arquivo .json ou .xml no Amazon S3 que inclua o texto ou os metadados da licença.

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 o comando create-package novamente para criar um pacote contendo a configuração do plug-in. A S3Key deve apontar para um arquivo .zip no Amazon S3 que siga a estrutura de diretórios esperada pelo plug-in.

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

Use o comando create-package novamente para criar um pacote contendo o plug-in em si. A S3Key deve apontar para o arquivo .zip do plug-in no Amazon S3.

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

Por fim, use o comando associate-package para vincular o plug-in, a licença e a configuração do parceiro a um domínio compatível especificando os IDs de pacote de cada um. Especifique o ID do plug-in como um pré-requisito para os outros pacotes, o que significa que ele deve ser associado ao domínio antes dos outros pacotes.

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

Próximas etapas

Quando a associação for concluída, você poderá habilitar o plug-in em índices específicos ou configurá-lo conforme necessário segundo seus requisitos. Para aplicar a funcionalidade do plug-in de terceiros a índices específicos, modifique as configurações de índice durante a criação do índice ou atualize os índices existentes. Por exemplo, se o plug-in de terceiros incluir um analisador personalizado, o referencie nas configurações de índice.

Para aplicar os atributos do plug-in de modo consistente entre vários índices, use modelos de índice que incluem as configurações do plug-in. Sempre consulte a documentação do plug-in para entender como configurar seus atributos para a configuração do OpenSearch.