DocumentationGuide de Commerce sur Cloud

Configurer le service Elasticsearch

Last update: Fri Jan 31 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

  • Administration
  • Développeur

Elasticsearchest un produit open-source qui vous permet de prendre des données de n’importe quelle source, n’importe quel format, et de les rechercher et de les visualiser en temps réel.

WARNING
Elasticsearch version 7.11 et ultérieure n’est pas pris en charge pour Adobe Commerce sur les infrastructures cloud. Les versions 2.3.7-p3, 2.4.3-p2 et 2.4.4 d’Adobe Commerce et ultérieures prennent en charge le service OpenSearch. Les installations sur site continuent à prendre en charge l’Elasticsearch.

Pour Adobe Commerce version 2.4.4 et ultérieure, voir Configuration du service OpenSearch.

  • Elasticsearch effectue des recherches rapides et avancées sur les produits du catalogue de produits
  • Les analyseurs Elasticsearch prennent en charge plusieurs langues
  • Prend en charge les mots vides et les synonymes
  • L’indexation n’affecte pas les clients tant que l’opération de réindexation n’est pas terminée
TIP
Adobe vous recommande de toujours configurer Elasticsearch pour votre projet d’infrastructure Adobe Commerce on cloud, même si vous envisagez de configurer un outil de recherche tiers pour votre application Adobe Commerce. La configuration d’Elasticsearch fournit une option de secours en cas d’échec de l’outil de recherche tiers.

Utilisez les instructions suivantes pour la configuration du service sur les environnements Pro Integration et les environnements de démarrage, y compris la branche master.

NOTE
Envoyez un ticket d’assistance Adobe Commerce pour modifier la configuration du service dans les environnements de production et d’évaluation Pro.

Pour activer l’Elasticsearch :

  1. Pour les projets de démarrage, ajoutez le service elasticsearch au fichier .magento/services.yaml avec la version Elasticsearch et l’espace disque alloué en Mo.

    code language-yaml 
    elasticsearch:
    type: elasticsearch:<version>
    disk: 1024

    Pour les projets Pro, vous devez envoyer un ticket d’assistance Adobe Commerce pour modifier la version de l’Elasticsearch dans les environnements d’évaluation et de production.

  2. Définissez la propriété relationships dans le fichier .magento.app.yaml.

    code language-yaml 
    relationships:
    elasticsearch: "elasticsearch:elasticsearch"

  3. Ajout, validation et modifications de code push.

    code language-bash 
    git add .magento/services.yaml .magento.app.yaml && git commit -m "Enable Elasticsearch" && git push origin <branch-name>

    Pour plus d’informations sur l’impact de ces modifications sur vos environnements, voir Services.

  4. Une fois le processus de déploiement terminé, utilisez SSH pour vous connecter à l’environnement distant.

    code language-bash 
    magento-cloud ssh

  5. Réindexez l’index de recherche catalogue.

    code language-bash 
    bin/magento indexer:reindex catalogsearch_fulltext

  6. Nettoyez le cache.

    code language-bash 
    bin/magento cache:clean
TIP
Après la configuration initiale du service, vous pouvez modifier la version du logiciel d’un service installé en mettant à jour les fichiers de configuration services.yaml et .magento.app.yaml. Consultez Modifier la version du service pour obtenir des conseils sur la mise à niveau ou la rétrogradation d’un service.

Compatibilité logicielle Elasticsearch

Lorsque vous installez ou mettez à niveau votre projet d’infrastructure Adobe Commerce sur le cloud, vérifiez toujours la compatibilité entre la version du service Elasticsearch et le client Elasticsearch PHP pour Adobe Commerce.

  • Première configuration-Vérifiez que la version Elasticsearch spécifiée dans le fichier services.yaml est compatible avec le client PHP Elasticsearch configuré pour Adobe Commerce.

  • Mise à niveau du projet-Vérifiez que le client PHP Elasticsearch dans la nouvelle version de l'application est compatible avec la version du service Elasticsearch installée sur l'infrastructure cloud.

La prise en charge des versions de service et de la compatibilité pour Adobe Commerce sur l’infrastructure cloud est déterminée par les versions déployées sur l’infrastructure cloud et diffère parfois des versions prises en charge par les déploiements sur site d’Adobe Commerce. Voir Versions des services.

Pour vérifier la compatibilité logicielle Elasticsearch :

  1. Sur votre station de travail locale, accédez au répertoire du projet.

  2. Afficher les détails Elasticsearch de l’environnement actif.

    code language-bash 
    magento-cloud relationships --property=elasticsearch

  3. Vous pouvez également utiliser SSH pour vous connecter à l’environnement distant.

    code language-bash 
    magento-cloud ssh

  4. Vérifiez la version du package du compositeur pour elasticsearch/elasticsearch.

    code language-bash 
    composer show elasticsearch/elasticsearch

    Dans la réponse, vérifiez la version installée dans la propriété versions .

    code language-none 
    name     : elasticsearch/elasticsearch
descrip. : PHP Client for Elasticsearch
keywords : client, elasticsearch, search
versions : * v7.17.1
type     : library
license  : Apache License 2.0 (Apache-2.0) (OSI approved) https://spdx.org/licenses/Apache-2.0.html#licenseText
license  : GNU Lesser General Public License v2.1 only (LGPL-2.1-only) (OSI approved) https://spdx.org/licenses/LGPL-2.1-only.html#licenseText
homepage :
source   : [git] git@github.com:elastic/elasticsearch-php.git f1b8918f411b837ce5f6325e829a73518fd50367
dist     : [zip] https://api.github.com/repos/elastic/elasticsearch-php/zipball/f1b8918f411b837ce5f6325e829a73518fd50367 f1b8918f411b837ce5f6325e829a73518fd50367
path     : ~/vendor/elasticsearch/elasticsearch
names    : elasticsearch/elasticsearch

    En outre, vous pouvez retrouver la version Elasticsearch du client PHP dans le fichier composer.lock dans le répertoire racine de l'environnement.

  5. À partir de la ligne de commande, récupérez les détails de connexion au service Elasticsearch.

    code language-bash 
    vendor/bin/ece-tools env:config:show services

    Dans la réponse, recherchez l’adresse IP du point d’entrée du service Elasticsearch :

    code language-none 
    | elasticsearch:                                                                                                  |
+------------------------------------------+----------------------------------------------------------------------+
| username                                 | null                                                                 |
| scheme                                   | http                                                                 |
| service                                  | elasticsearch                                                        |
| fragment                                 | null                                                                 |
| ip                                       | 169.254.220.11                                                       |
| hostname                                 | dzggu33f75wi3sd24lgwtoupxm.elasticsearch.service._.magentosite.cloud |
| public                                   | false                                                                |
| cluster                                  | fo3qdoxtla4j4-master-7rqtwti                                         |
| host                                     | elasticsearch.internal                                               |
| rel                                      | elasticsearch                                                        |
| query                                    |                                                                      |
| path                                     | null                                                                 |
| password                                 | null                                                                 |
| type                                     | elasticsearch:6.5                                                    |
| port                                     | 9200                                                                 |
+------------------------------------------+----------------------------------------------------------------------+

  6. Récupérez le version:number de service Elasticsearch installé à partir du point d’entrée du service.

    code language-bash 
    curl -XGET <elasticsearch-service-endpoint-ip-address>:9200/
    code language-json 
    {
   "name" : "-AqGi9D",
   "cluster_name" : "elasticsearch",
   "cluster_uuid" : "_yze6-ywSEW1MaAF8ZPWyQ",
   "version" : {
     "number" : "6.5.4",
     "build_flavor" : "default",
     "build_type" : "deb",
     "build_hash" : "82a8aa7",
     "build_date" : "2019-01-23T12:07:18.760675Z",
     "build_snapshot" : false,
     "lucene_version" : "7.5.0",
     "minimum_wire_compatibility_version" : "5.6.0",
     "minimum_index_compatibility_version" : "5.0.0"
},
"  tagline" : "You Know, for Search"
}

  7. Vérifiez la compatibilité des versions entre le service Elasticsearch et le client PHP.

    Si les versions sont incompatibles, effectuez l’une des mises à jour suivantes dans la configuration de votre environnement :

    • Remplacez le client PHP Elasticsearch par une version compatible avec la version du service Elasticsearch.

      code language-bash 
      composer require "elasticsearch/elasticsearch:~<version>"

    • Remplacez la version du service Elasticsearch dans le fichier services.yaml par une version compatible avec le client PHP Elasticsearch.

TIP
Pour les projets Pro, vous devez envoyer un ticket d’assistance Adobe Commerce pour installer ou mettre à jour les services dans les environnements Staging et Production uniquement.
Indiquez les changements de service nécessaires, incluez vos fichiers .magento.app.yaml et services.yaml mis à jour, et indiquez la version PHP dans le ticket. Pour les modifications en libre-service de la version PHP, des extensions ou des paramètres d'environnement, voir paramètres PHP dans Configuration de l'application.
Pour apporter des modifications à un environnement de production en ligne (Pro uniquement), un préavis d’au moins 48 heures est requis. L’équipe en charge de l’infrastructure cloud dispose ainsi de suffisamment de temps pour rassembler les ressources et effectuer une mise à niveau sécurisée. La période de préavis commence lorsque l’équipe d’infrastructure accuse réception de la demande et planifie la mise à niveau, à l’exclusion des week-ends. Par exemple, pour que les mises à niveau de service soient terminées un lundi, un accusé de réception de la mise à niveau prévue doit être reçu avant le mercredi. Pendant les périodes de pointe, le traitement de votre demande peut prendre plus de temps.

Redémarrez le service Elasticsearch

Si vous devez redémarrer le service Elasticsearch, vous devez contacter l'assistance Adobe Commerce.

Configuration de recherche supplémentaire

  • Par défaut, la configuration de la recherche pour les environnements cloud se régénère à chaque déploiement. Vous pouvez utiliser la variable de déploiement SEARCH_CONFIGURATION pour conserver les paramètres de recherche personnalisés entre les déploiements. Voir Déploiement de variables.

  • Une fois que vous avez configuré le service Elasticsearch pour votre projet, utilisez l’interface utilisateur d’administration pour tester la connexion Elasticsearch et personnaliser les paramètres Elasticsearch pour Adobe Commerce.

Ajout de modules externes pour l’Elasticsearch

Vous pouvez éventuellement ajouter des modules externes pour Elasticsearch en ajoutant la section configuration:plugins au service Elasticsearch dans le fichier .magento/services.yaml. Par exemple, le code suivant active les modules externes d’analyse ICU et d’analyse phonétique.

elasticsearch:
    type: elasticsearch:<service-version>
    disk: 1024
    configuration:
        plugins:
            - analysis-icu
            - analysis-phonetic

Si vous utilisez le plug-in tiers Elastic Suite, vous devez mettre à jour le package ece-tools vers la version 2002.0.19 ou ultérieure.
Lors de la configuration d’Elastic Suite, ajoutez les paramètres de configuration à la variable de déploiement ELASTICSUITE_CONFIGURATION. Cette configuration enregistre les paramètres dans tous les déploiements.

Supprimer les modules externes pour l’Elasticsearch

La suppression des entrées du plug-in d’elasticsearch: dans .magento/services.yaml ne les désinstalle pas ou ne les désactive pas comme vous pourriez vous y attendre. Vous devez réindexer les données de votre Elasticsearch. Ce comportement est destiné à empêcher la perte ou la corruption possible des données qui dépendent de ces modules externes.

Pour supprimer des modules externes Elasticsearch :

  1. Supprimez les entrées du module externe Elasticsearch de votre fichier .magento/services.yaml.

  2. Ajouter, valider et transmettre vos modifications de code.

    code language-bash 
    git add .magento/services.yaml
    code language-bash 
    git commit -m "Remove Elasticsearch plugin"
    code language-bash 
    git push origin <branch-name>

  3. Validez les modifications .magento/services.yaml apportées à votre référentiel cloud.

  4. Réindexez l’index de recherche catalogue.

    code language-bash 
    bin/magento indexer:reindex catalogsearch_fulltext

  5. Nettoyez le cache.

    code language-bash 
    bin/magento cache:clean
TIP
Pour plus d’informations sur l’utilisation ou la résolution des problèmes du plug-in Elastic Suite avec Adobe Commerce, consultez la documentation Elastic Suite.

Dépannage

Consultez les articles d’assistance Adobe Commerce suivants pour obtenir de l’aide sur la résolution des problèmes Elasticsearch :

recommendation-more-help