DocumentationCommerceGuide de Commerce sur Cloud

Configuration du service OpenSearch

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

Créé pour :

  • Administration
  • Développeur

Le service OpenSearch est un branchement open source d’Elasticsearch 7.10.2, suite aux modifications de licence d’Elasticsearch. Voir le Projet OpenSource dans GitHub.

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.

OpenSearch 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.

  • Recherches rapides et avancées sur les produits du catalogue
  • Les analyseurs OpenSearch 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

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.
TIP
Adobe vous recommande de toujours configurer OpenSearch 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’OpenSearch fournit une option de secours en cas d’échec de l’outil de recherche tiers.

Pour activer OpenSearch :

  1. Pour les environnements d’intégration Starter et Pro, ajoutez le service opensearch au fichier .magento/services.yaml avec la version appropriée et l’espace disque alloué en Mo. Dans ce cas, la version 2 est appropriée. La version mineure n’est pas requise, car l’infrastructure cloud utilise la dernière version d’OpenSearch.

    code language-yaml 
    opensearch:
    type: opensearch:2
    disk: 1024

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

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

    code language-yaml 
    relationships:
    opensearch: "opensearch:opensearch"

  3. Ajout, validation et modifications de code push.

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

    Pour plus d’informations sur l’impact de ces modifications sur vos environnements, consultez Configuration des 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é du logiciel OpenSearch

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 OpenSearch et le client OpenSearch PHP pour Adobe Commerce.

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

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

La prise en charge des versions de service et de la compatibilité est déterminée par les versions testées et 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. Consultez Configuration requise dans le Guide d’installation pour obtenir la liste des versions prises en charge.

Pour vérifier la compatibilité du logiciel OpenSearch :

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

  2. Afficher les détails OpenSearch pour l’environnement actif.

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

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

    code language-bash 
    magento-cloud ssh

  4. Récupérez les détails de connexion au service OpenSearch.

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

    Dans la réponse, recherchez l’adresse IP et le port du point d’entrée du service OpenSearch :

    code language-none 
    +------------------------------------------+--------------------------------------------------------+
| opensearch:                                                                                       |
+------------------------------------------+--------------------------------------------------------+
| username                                 | null                                                   |
| scheme                                   | http                                                   |
| service                                  | opensearch                                             |
| fragment                                 | null                                                   |
| ip                                       | 169.254.220.11                                         |
| hostname                                 | hostf75wi3sd24l.opensearch.service._.magentosite.cloud |
| port                                     | 9200                                                   |
| cluster                                  | projectID-develop-4ranwui                              |
| host                                     | opensearch.internal                                    |
| rel                                      | opensearch                                             |
| path                                     | null                                                   |
| query                                    |                                                        |
| password                                 | null                                                   |
| type                                     | opensearch:2                                           |
| public                                   | false                                                  |
| host_mapped                              | false                                                  |

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

    code language-bash 
    curl -XGET <opensearch-service-endpoint-ip-address>:9200
    code language-json 
    {
   "name" : "opensearch.0",
   "cluster_name" : "opensearch",
   "cluster_uuid" : "_yzaae6-ywSEW1MaAF8ZPWyQ",
   "version" : {
     "distribution" : "opensearch",
     "number" : "2.5.0",
     "build_type" : "deb",
     "build_hash" : "aaaaaaa",
     "build_date" : "2023-01-23T12:07:18.760675Z",
     "build_snapshot" : false,
     "lucene_version" : "9.4.2",
     "minimum_wire_compatibility_version" : "7.10.0",
     "minimum_index_compatibility_version" : "7.0.0"
},
"tagline" : "The OpenSearch Project: https://opensearch.org/"
}
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 OpenSearch

Si vous devez redémarrer le service OpenSearch, 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 OpenSearch pour votre projet, utilisez l’interface utilisateur d’administration pour tester la connexion OpenSearch et personnaliser les paramètres OpenSearch pour Adobe Commerce.

Ajout de modules externes pour OpenSearch

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

opensearch:
    type: opensearch:2
    disk: 1024
    configuration:
        plugins:
            - analysis-icu
            - analysis-phonetic

Voir le Projet OpenSearch pour plus d’informations sur les modules externes.

Suppression de modules externes pour OpenSearch

La suppression des entrées du module externe de la section opensearch: du fichier .magento/services.yaml ne désinstalle pas ni ne désactive le service. Pour désactiver complètement le service, vous devez réindexer vos données OpenSearch après avoir supprimé les modules externes de votre fichier .magento/services.yaml. Cette conception empêche la perte ou la corruption possible des données qui dépendent de ces modules externes.

Pour supprimer les modules externes OpenSearch :

  1. Supprimez les entrées du module externe OpenSearch 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 OpenSearch plugin"
    code language-bash 
    git push origin <branch-name>

  3. Validez les modifications .magento/services.yaml dans 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
recommendation-more-help
7c2b03ac-000c-497d-aba3-2c6dc720a938