Gestione dei plugin personalizzati in Amazon Service OpenSearch

Per installare un plug-in personalizzato

1. Accedi alla console di Amazon OpenSearch Service da https://console.aws.amazon.com/aos/casa.

2. Nel riquadro di navigazione a sinistra scegliere Pacchetti.

3. Scegli Importa pacchetto.

4. Per Nome, inserisci un nome univoco e facilmente identificabile per il plugin.

5. (Facoltativo) In Descrizione, fornite tutti i dettagli utili sul pacchetto o sul suo scopo.

6. Per Tipo di pacchetto, scegli Plugin.

7. Per Package source, inserisci il percorso o cerca il file ZIP del plugin in Amazon S3.

8. Per la versione OpenSearch del motore, scegli la versione OpenSearch supportata dal plugin.

9. Per Package encryption, scegli se personalizzare la chiave di crittografia per il pacchetto. Per impostazione predefinita, OpenSearch Service crittografa il pacchetto del plug-in con un Chiave di proprietà di AWS. In alternativa, puoi utilizzare una chiave gestita dal cliente.

10. Seleziona Importa.

Per installare un plug-in personalizzato tramite la AWS CLI

1. Crea un nuovo pacchetto per il tuo plugin personalizzato eseguendo il seguente comando create-package, assicurandoti che siano soddisfatti i seguenti requisiti:

   • La posizione del bucket e della chiave deve puntare al .zip file del plug-in in un bucket S3 dell'account in cui stai eseguendo i comandi.

   • Il bucket S3 deve trovarsi nella stessa regione in cui viene creato il pacchetto.

   • Per .zip ZIP-PLUGIN i pacchetti sono supportati solo i file.

   • Il contenuto del .zip file deve seguire la struttura delle cartelle prevista dal plugin.

   • Il valore di --engine-version deve essere nel formatoOpenSearch_{MAJOR}.{MINOR}. Ad esempio: OpenSearch_2.17.

   Sostituisci placeholder values con le tue informazioni:

   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. (Facoltativo) Visualizza lo stato dell'create-packageoperazione, inclusi eventuali risultati di convalida e vulnerabilità di sicurezza, utilizzando il comando describe-packages. Sostituisci placeholder values con le tue informazioni:

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

   Questo comando restituisce informazioni simili alle seguenti:

   {
       "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 l'create-packageoperazione, Amazon OpenSearch Service verifica il ZIP-PLUGIN valore per la compatibilità delle versioni, le estensioni dei plugin supportate e le vulnerabilità di sicurezza. Le vulnerabilità di sicurezza vengono analizzate utilizzando il servizio Amazon Inspector. I risultati di questi controlli vengono visualizzati nel ErrorDetails campo della risposta dell'API.

3. Utilizzate il comando associate-package per associare il plugin al dominio di OpenSearch servizio di vostra scelta utilizzando l'ID del pacchetto creato nel passaggio precedente.

   Suggerimento

   Se disponi di più plugin, puoi invece utilizzare il comando associate-packages per associare più pacchetti a un dominio con un'unica operazione.

   Sostituisci placeholder values con le tue informazioni:

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

   Nota

   Il plugin viene installato e disinstallato utilizzando un processo di distribuzione blu/verde.

4. (Facoltativo) Utilizzate il list-packages-for-domaincomando per visualizzare lo stato dell'associazione. Lo stato dell'associazione cambia man mano che il flusso di lavoro avanza da ASSOCIATING aACTIVE. Lo stato dell'associazione diventa ATTIVO dopo il completamento dell'installazione del plug-in e il plug-in è pronto per l'uso.

   Sostituire placeholder values con le proprie informazioni.

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

Per aggiornare un plug-in personalizzato tramite la AWS CLI

• Esegui il comando seguente. Sostituire placeholder values con le proprie informazioni.

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

Per aggiornare un dominio OpenSearch di servizio con plug-in personalizzati a una versione successiva utilizzando il OpenSearch AWS CLI

1. Usa il comando create-package per creare un nuovo pacchetto per il tuo plugin specificando la nuova versione. OpenSearch

   Assicurati che il nome del pacchetto sia lo stesso per il plugin per tutte le versioni del motore. La modifica del nome del pacchetto causa il fallimento del processo di aggiornamento del dominio durante la distribuzione blu/verde.

2. Aggiorna il tuo dominio alla versione superiore seguendo la procedura riportata di seguito. Aggiornamento dei domini del servizio Amazon di Amazon OpenSearch

   Durante questo processo, Amazon OpenSearch Service dissocia la versione precedente del pacchetto di plug-in e installa la nuova versione utilizzando una distribuzione blu/verde.

Per disinstallare e visualizzare lo stato di dissociazione di un plug-in personalizzato

1. Disabilita il plugin in ogni indice. Questa deve essere fatto prima di dissociare il pacchetto del plugin.

   Se provate a disinstallare un plugin prima di disabilitarlo da ogni indice, il processo di distribuzione blu/verde rimane bloccato nello stato. Processing

2. Per disinstallare il plugin, esegui il comando seguente. Sostituire placeholder values con le proprie informazioni.

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

3. (Facoltativo) Eseguite il list-packages-for-domaincomando per visualizzare lo stato della dissociazione.