Plugins personnalisés

Les plugins personnalisés pour Amazon OpenSearch Service sont une nouvelle option de gestion des plugins qui étend les OpenSearch fonctionnalités dans des domaines tels que l'analyse linguistique, le filtrage personnalisé et le classement, vous permettant ainsi de créer des expériences de recherche personnalisées. Des plugins personnalisés pour OpenSearch peuvent être développés en étendant la org.opensearch.plugins.Plugin classe, puis empaquetés sous forme de fichier .zip. Les extensions de plug-in suivantes sont actuellement prises en charge par Amazon OpenSearch Service :

• Plug-in d'analyse : étend les fonctionnalités d'analyse en ajoutant des analyseurs personnalisés, des tokeniseurs de caractères ou des filtres pour le traitement de texte.

• Plug-in de recherche : améliore les capacités de recherche avec des types de requêtes personnalisés, des algorithmes de similarité, des options de suggestion et des agrégations.

Vous pouvez utiliser la console Amazon OpenSearch Service ou les packages personnalisés existants APIs pour télécharger et associer un plugin à votre domaine Amazon OpenSearch Service. Pour plus d'informations sur les packages personnalisés, consultez Packages personnalisés pour Amazon OpenSearch Service. Vous pouvez également l'utiliser DescribePackages pour décrire tous les packages de votre compte pour afficher des détails tels que la OpenSearch version actuellement utilisée ou les détails des erreurs. Amazon OpenSearch Service valide le package de plugins pour vérifier la compatibilité des versions, les failles de sécurité et les opérations de plug-in autorisées.

Les plugins personnalisés sont pris en charge sur les domaines de OpenSearch service exécutant la OpenSearch version 2.15 ou ultérieure et sont disponibles dans 14 régions du monde : USA Ouest (Oregon), USA Est (Ohio), USA Est (Virginie du Nord), Amérique du Sud (Sao Paulo), Europe (Paris), Europe (Londres), Europe (Irlande), Europe (Francfort), Canada (Centre), Asie-Pacifique (Tokyo), Asie-Pacifique (Sydney), Asie-Pacifique (Singapour)), Asie-Pacifique (Séoul) et Asie-Pacifique (Mumbai).

Note

Les plugins personnalisés contiennent du code développé par l'utilisateur. Tout problème, y compris les violations des SLA, causé par le code développé par l'utilisateur ne sera pas éligible aux crédits SLA. Pour plus d'informations, consultez les exclusions Amazon OpenSearch Service SLA sous Amazon OpenSearch Service - Service Level Agreement.

Limites des plugins

Vous pouvez créer jusqu'à 25 plugins personnalisés par compte. Le nombre maximum de plugins pouvant être associés à un seul domaine est de 20. Ce nombre inclut tous les types de plugins, qu'ils soient facultatifs, tiers ou personnalisés. La taille non compressée maximale autorisée pour un plugin est de 1 Go.

Le tableau suivant répertorie les fonctionnalités qui ne sont pas disponibles lors de l'utilisation de plugins personnalisés :

Fonctionnalités OpenSearch d'Amazon Service	Plugins personnalisés
Recherche entre clusters	Non pris en charge.
Réplication entre clusters	Non pris en charge
Réindexation à distance	Non pris en charge
Réglage automatique	Non pris en charge
Multi-AZ avec mode veille	Non pris en charge
Interface OpenSearch utilisateur centralisée	Non pris en charge

Utilisation de plugins personnalisés avec OpenSearch Service

Conditions préalables à l'utilisation de plugins personnalisés avec Service OpenSearch

Avant de pouvoir utiliser des plugins personnalisés avec Amazon OpenSearch Service, vous devez vous assurer que vous disposez de la configuration suivante :

• Chiffrement nœud à nœud

• Chiffrement des données au repos

• EnforceHTTPS défini sur true

• Les clients doivent prendre en charge la TLSSecurity politique 'Policy-Min-TLS-1-2-PFS-2023-10', vous pouvez la configurer avec la commande suivante :

  aws opensearch update-domain-config —domain-name domain-name —domain-endpoint-options '{"TLSSecurityPolicy":"Policy-Min-TLS-1-2-PFS-2023-10" }'

  Pour de plus amples informations, veuillez consulter DomainEndpointOptions.

• Le fichier descriptor.properties de la version du moteur prise en charge par votre plugin doit être similaire à 2.15.0 ou la version du correctif 2.x.0.i.e doit être nulle.

Installation de plugins personnalisés avec AWS CLI

Vous pouvez installer des plugins personnalisés à l'aide du AWS CLI. Avant de pouvoir associer un plugin personnalisé à votre domaine, vous devez le télécharger dans un compartiment Amazon S3. Vous devez créer le compartiment Amazon S3 dans la région où vous souhaitez utiliser le plugin. Pour obtenir des instructions sur la manière de procéder, consultez la section Chargement d'objets dans le guide Qu'est-ce qu'Amazon S3 ? Si votre plugin contient des informations sensibles, sélectionnez le chiffrement côté serveur avec des clés gérées par S3 lorsque vous le téléchargez. Après avoir chargé le fichier, prenez note de son chemin Amazon S3. Consultez l'exemple de format de chemin Amazon S3 suivant :

s3://bucket-name/file-path/file-name

Vous devrez créer un nouveau package pour votre plugin personnalisé. Vous pouvez le faire à l'aide de l'CreatePackageAPI existante. Lorsque vous créez votre nouveau package, veuillez mettre à jour le compartiment et l'emplacement des clés pour qu'ils pointent vers le fichier .zip de votre plugin personnalisé dans le compartiment Amazon S3 du compte appelant. Notez que votre compartiment Amazon S3 doit se trouver dans la même région que le package en cours de création. Seuls les fichiers .zip sont pris en charge pour les ZIP-PLUGIN packages. Le contenu du fichier .zip doit suivre la structure du répertoire prévue par le plugin. Pour créer un package, consultez l'exemple suivant :

aws opensearch --region $REGION create-package --package-name <package-name> --package-type ZIP-PLUGIN --package-source S3BucketName=<bucket>,S3Key=<key> --engine-version OpenSearch_2.15

Vous pouvez consulter l'état de l'opération de création du package, y compris les erreurs de validation et de détection de failles de sécurité à l'aide de la commande describe-packages. Pour ce faire, consultez l'exemple suivant :

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

Voici un exemple de réponse de l'API describe-packages :

{ "PackageDetailsList": [ { 
"PackageID": "pkg-identifier", 
"PackageName": "custom-plugin-test", 
"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" } ] }

Note

Au cours de l'opération de création du package, Amazon OpenSearch Service vérifie la compatibilité ZIP-PLUGIN des versions, les extensions de plug-in prises en charge et les failles de sécurité. Les failles de sécurité sont notamment analysées à l'aide du service Amazon Inspector. Les résultats de ces contrôles sont affichés dans le ErrorDetails champ de réponse de l'API.

Utilisez l'AssociatePackageAPI pour associer le plugin à votre domaine Amazon OpenSearch Service à l'aide de l'identifiant du package créé à l'étape précédente. Si vous avez plusieurs plug-ins, vous pouvez utiliser l'AssociatePackagesAPI pour associer plusieurs packages à un domaine en une seule opération. Pour ce faire, consultez l'exemple suivant :

aws opensearch --region $REGION associate-package --domain-name <domain-name> --package-id <package-id>

Note

Les plugins sont installés et désinstallés à l'aide d'un processus de déploiement bleu/vert.

Vous pouvez utiliser l'ListPackagesForDomainAPI pour voir le statut de l'association. Le statut de l'association changera au fur et à mesure que le flux de travail passera de ASSOCIATING àACTIVE. Le statut de l'association passe à ACTIVE une fois que le processus d'installation du plugin est terminé et que votre plugin est prêt à être utilisé. Pour ce faire, consultez l'exemple suivant :

aws opensearch --region $REGION list-packages-for-domain
      --domain-name <domain-name>

Mettre à jour des plugins personnalisés

Vous pouvez mettre à jour les plugins personnalisés à l'aide de l'UpdatePackageAPI existante. Vous pouvez utiliser l'exemple d'API associate-packages suivant pour appliquer des mises à jour de packages à un domaine. Pour ce faire, consultez l'exemple suivant :

aws opensearch --region $REGION update-package --package-id <package-id>  --package-source S3BucketName=<bucket>,S3Key=<key> --package-description <description>

Note

Vous pouvez auditer les opérations de création, de mise à jour, d'association et de dissociation sur votre plugin à l'aide AWS CloudTrail de. Pour plus d'informations, consultez la documentation Monitoring Amazon OpenSearch Service API calls with AWS CloudTrail.

Mise à niveau de votre domaine avec des plugins personnalisés

Pour mettre à niveau votre domaine Amazon OpenSearch Service associé à des plugins personnalisés vers une version ultérieure de OpenSearch, vous pouvez utiliser l'CreatePackageAPI pour créer un nouveau package pour votre plugin.

Note

Assurez-vous que le nom du package est le même pour le plugin pour toutes les versions du moteur. La modification du nom du package entraînera l'échec du processus de mise à niveau du domaine lors du déploiement bleu/vert.

Pour obtenir des instructions sur la mise à niveau de votre domaine Amazon OpenSearch Service, consultez la section Mise à niveau d'Amazon OpenSearch Service. Amazon OpenSearch Service dissociera la version précédente de votre package de plug-in et installera la nouvelle version du plug-in via un déploiement bleu/vert.

Chiffrer des plugins personnalisés

Lorsque vous utilisez l'CreatePackageAPI, vous pouvez définir true et PackageEncryptionOptions transmettre l'ARN de la clé KMS que vous souhaitez utiliser pour le chiffrement. Pour ce faire, consultez l'exemple suivant :

aws opensearch --region $REGION create-package --package-name <package-name> --package-type ZIP-PLUGIN --package-source S3BucketName=<bucket>,S3Key=<key> --engine-version OpenSearch_2.15   
"PackageConfigOptions": {
     ...
  }
  "PackageEncryptionOptions": {
    "Enabled": true,
    "KmsKeyId":"kms_key_arn"
  }

Vous pouvez activer la même option lors de la mise à jour du package à l'aide de l'UpdatePackageAPI.

Note

Si une clé KMS est désactivée ou supprimée, elle peut laisser le cluster inopérationnel.

Désinstaller des plugins personnalisés

Vous pouvez désinstaller des plug-ins personnalisés à l'aide de DissociatePackagel'API existante pour désinstaller un plug-in d'un domaine. Cette étape supprime également tous les packages de configuration et/ou de licence associés au plugin. Vous pouvez utiliser l'ListPackagesForDomainAPI existante pour voir l'état de la dissociation. En outre, vous pouvez également utiliser l'DissociatePackagesAPI pour désinstaller plusieurs plug-ins d'un domaine en une seule opération.

Vous pouvez utiliser l'exemple d'API disassociate-packages suivant pour appliquer des mises à jour de packages à un domaine. Pour ce faire, consultez l'exemple suivant :

aws opensearch --region $REGION dissociate-package --package-id <plugin-package-id> --domain-name <domain-name>

Note

Pour désinstaller un plugin, vous devez d'abord le désactiver de chaque index avant de dissocier le package du plugin. Si vous essayez de désinstaller un plugin sans le désactiver dans chaque index, le processus de déploiement bleu/vert restera bloqué dans l'état de traitement.