Gerenciar plug-ins personalizados no Amazon OpenSearch Service

Para instalar um plug-in personalizado

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. Escolha Importar pacote.

4. Em Nome, insira um nome exclusivo e fácil de identificar para o plug-in.

5. (Opcional) Em Descrição, forneça todos os detalhes úteis sobre o pacote ou sua finalidade.

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

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

8. Em Versão do mecanismo do OpenSearch, escolha a versão do OpenSearch com que o plug-in é compatível.

9. Em Criptografia de pacote, escolha se a chave de criptografia do pacote será personalizada ou não. Por padrão, o OpenSearch Service criptografa o pacote do plug-in com uma Chave pertencente à AWS. Também é possível usar uma chave gerenciada pelo cliente.

10. Escolha Importar.

Para instalar um plug-in personalizado usando a AWS CLI

1. Crie um novo pacote para seu plug-in personalizado executando o seguinte comando create-package e garantindo que os seguintes requisitos sejam atendidos:

   • O bucket e a localização da chave devem apontar para o arquivo .zip do plug-in em um bucket do S3 na conta em que você executa os comandos.

   • O bucket do S3 deve estar na mesma região em que o pacote está sendo criado.

   • Somente arquivos .zip são compatíveis com pacotes ZIP-PLUGIN.

   • O conteúdo do arquivo .zip deve seguir a estrutura de diretórios conforme esperado pelo plug-in.

   • O valor fornecido em --engine-version deve estar no formato OpenSearch_{MAJOR}.{MINOR}. Por exemplo: OpenSearch_2.17.

   Substitua os valores dos espaços reservados por suas próprias informações:

   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) Visualize o status da operação create-package, incluindo quaisquer descobertas de validação e vulnerabilidade de segurança, usando o comando describe-packages. Substitua os valores dos espaços reservados por suas próprias informações:

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

   O comando retorna informações semelhantes às seguintes:

   {
       "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 a operação create-package, o Amazon OpenSearch Service verifica o valor ZIP-PLUGIN quanto a compatibilidade de versões, extensões de plug-in compatíveis e vulnerabilidades de segurança. As vulnerabilidades de segurança são examinadas usando o serviço Amazon Inspector. Os resultados dessas verificações são mostrados no campo ErrorDetails da resposta da API.

3. Use o comando associate-package para associar o plug-in ao domínio do OpenSearch Service de sua escolha usando o ID do pacote criado na etapa anterior.

   dica

   Se você tiver vários plug-ins, poderá usar o comando associate-packages para associar vários pacotes a um domínio em uma única operação.

   Substitua os valores dos espaços reservados por suas próprias informações:

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

   nota

   O plug-in é instalado e desinstalado usando um processo de implantação azul/verde.

4. (Opcional) Use o comando list-packages-for-domain para visualizar o status da associação. O status da associação se altera à medida que o fluxo de trabalho avança de ASSOCIATING para ACTIVE. O status da associação passa para ATIVO após a conclusão da instalação do plug-in, e ele está pronto para uso.

   Substitua os valores de espaço reservado por suas próprias informações.

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

Para atualizar um plug-in personalizado usando a AWS CLI

• Execute o comando a seguir. Substitua os valores de espaço reservado por suas próprias informações.

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

Para atualizar um domínio do OpenSearch Service com plug-ins personalizados para uma versão mais nova do OpenSearch usando a AWS CLI

1. Use o comando create-package para criar um novo pacote para o plug-in especificando a nova versão do OpenSearch.

   Certifique-se de que o nome do pacote seja o mesmo para o plug-in de todas as versões do mecanismo. A alteração do nome do pacote causa falha no processo de atualização do domínio durante a implantação azul/verde.

2. Atualize o domínio para a versão acima seguindo as etapas em Atualização de domínios do Amazon OpenSearch Service.

   Durante esse processo, o Amazon OpenSearch Service desassocia a versão anterior do pacote de plug-in e instala a nova versão usando uma implantação azul/verde.

Para desinstalar e visualizar o status de desassociação de um plug-in personalizado

1. Desabilite o plug-in em todos os índices. Faça isso antes de desassociar o pacote de plug-in.

   Se você tentar desinstalar um plug-in antes de desabilitá-lo em todos os índices, o processo de implantação azul/verde ficará preso no estado Processing.

2. Execute o comando a seguir para desinstalar o plug-in. Substitua os valores de espaço reservado por suas próprias informações.

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

3. (Opcional) Execute o comando list-packages-for-domain para visualizar o status da desassociação.