DocumentaçãoCommerceGuia do Commerce na infraestrutura em nuvem

Configurar o serviço OpenSearch

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Administrador
  • Desenvolvedor

O serviço OpenSearch é uma bifurcação de código aberto do Elasticsearch 7.10.2, seguindo as alterações de licenciamento do Elasticsearch. Consulte o OpenSource Project no GitHub.

WARNING
O Elasticsearch 7.11 e posterior não é compatível com o Adobe Commerce na infraestrutura em nuvem. As versões do Adobe Commerce 2.3.7-p3, 2.4.3-p2 e 2.4.4 e posteriores são compatíveis com o serviço OpenSearch. As instalações locais continuam a suportar o Elasticsearch.

O OpenSearch permite extrair dados de qualquer fonte, qualquer formato e pesquisá-los e visualizá-los em tempo real.

  • Pesquisas rápidas e avançadas em produtos do catálogo de produtos
  • Os analisadores OpenSearch são compatíveis com vários idiomas
  • Suporta palavras de interrupção e sinônimos
  • A indexação não afeta os clientes até que a operação de reindexação seja concluída

Use as instruções a seguir para a configuração do serviço em ambientes Pro Integration e Starter, incluindo a ramificação master.

NOTE
Envie um tíquete de Suporte da Adobe Commerce para alterar a configuração do serviço em ambientes de Produção e Preparo Profissionais.
TIP
A Adobe recomenda que você sempre configure o OpenSearch para seu projeto do Adobe Commerce na infraestrutura em nuvem, mesmo que planeje configurar uma ferramenta de pesquisa de terceiros para seu aplicativo do Adobe Commerce. A configuração do OpenSearch fornece uma opção de fallback se a ferramenta de pesquisa de terceiros falhar.

Para habilitar OpenSearch:

  1. Para ambientes de integração Starter e Pro, adicione o serviço opensearch ao arquivo .magento/services.yaml com a versão apropriada e o espaço em disco alocado em MB. Nesse caso, a versão 2 é adequada. A versão secundária não é necessária porque a infraestrutura em nuvem usa a versão mais recente do OpenSearch.

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

    Para projetos Pro, você deve enviar um tíquete de Suporte da Adobe Commerce para alterar a versão do OpenSearch nos ambientes de Preparo e Produção.

  2. Defina ou verifique a propriedade relationships no arquivo .magento.app.yaml.

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

  3. Adicionar, confirmar e enviar alterações de código.

    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>

    Para obter informações sobre como essas alterações afetam seus ambientes, consulte Configurar serviços.

  4. Depois que o processo de implantação for concluído, use o SSH para fazer logon no ambiente remoto.

    code language-bash 
    magento-cloud ssh

  5. Reindexe o índice de pesquisa do catálogo.

    code language-bash 
    bin/magento indexer:reindex catalogsearch_fulltext

  6. Limpe o cache.

    code language-bash 
    bin/magento cache:clean
TIP
Após a configuração inicial do serviço, você pode alterar a versão do software de um serviço instalado atualizando os arquivos de configuração services.yaml e .magento.app.yaml. Consulte Alterar versão de serviço para obter orientação sobre como atualizar ou rebaixar um serviço.

Compatibilidade de software OpenSearch

Ao instalar ou atualizar seu projeto Adobe Commerce na infraestrutura em nuvem, sempre verifique a compatibilidade entre a versão do serviço OpenSearch e o cliente PHP🔗 do OpenSearch para Adobe Commerce.

  • Primeira configuração-Confirme se a versão do OpenSearch especificada no arquivo services.yaml é compatível com o cliente OpenSearch PHP configurado para Adobe Commerce.

  • Atualização de projeto-Verifique se o cliente OpenSearch PHP na nova versão do aplicativo é compatível com a versão do serviço OpenSearch instalada na infraestrutura de nuvem.

O suporte à versão e compatibilidade do serviço é determinado por versões testadas e implantadas na infraestrutura da nuvem e, às vezes, difere das versões compatíveis com implantações locais do Adobe Commerce. Consulte Requisitos do sistema no Guia de Instalação para obter uma lista de versões com suporte.

Para verificar a compatibilidade do software OpenSearch:

  1. Na estação de trabalho local, altere para o diretório do projeto.

  2. Mostrar os detalhes do OpenSearch para o ambiente ativo.

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

  3. Como alternativa, você pode usar o SSH para fazer logon no ambiente remoto.

    code language-bash 
    magento-cloud ssh

  4. Recupere os detalhes de conexão do serviço OpenSearch.

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

    Na resposta, localize o endereço IP e a porta do ponto final do serviço 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. Recupere o serviço OpenSearch version:number instalado do ponto de extremidade de serviço.

    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
Para projetos Pro, você deve enviar um tíquete de Suporte da Adobe Commerce para instalar ou atualizar os serviços somente em ambientes Staging e Production.
Indique as mudanças de serviço necessárias, inclua os arquivos atualizados do .magento.app.yaml e do services.yaml e informe a versão do PHP no tíquete. Para alterações de autoatendimento na versão, extensões ou configurações do ambiente do PHP, consulte configurações do PHP em Configuração do aplicativo.
Para alterações em um ambiente de Produção do live (Pro somente), você deve fornecer um aviso mínimo de 48 horas para permitir que a equipe de infraestrutura da nuvem tenha tempo suficiente para empacotar recursos e realizar uma atualização segura.

Reiniciar o serviço OpenSearch

Se precisar reiniciar o serviço OpenSearch, entre em contato com o suporte da Adobe Commerce.

Configuração de pesquisa adicional

  • Por padrão, a configuração de pesquisa para ambientes em nuvem é gerada novamente sempre que você implanta. Você pode usar a variável de implantação SEARCH_CONFIGURATION para manter configurações de pesquisa personalizadas entre implantações. Consulte Implantar variáveis.

  • Depois de configurar o serviço OpenSearch para o seu projeto, use a interface do Administrador para testar a conexão OpenSearch e personalizar as configurações OpenSearch para o Adobe Commerce.

Adicionar plug-ins do OpenSearch

Como opção, você pode adicionar plug-ins para OpenSearch adicionando a seção configuration:plugins ao serviço OpenSearch no arquivo .magento/services.yaml. Por exemplo, o código a seguir habilita os plug-ins de análise ICU e Análise fonética.

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

Consulte o OpenSearch Project para obter mais informações sobre plug-ins.

Remover plug-ins do OpenSearch

A remoção das entradas de plug-in da seção opensearch: do arquivo .magento/services.yaml faz não desinstalar ou desabilitar o serviço. Para desabilitar totalmente o serviço, você deve reindexar os dados do OpenSearch após remover os plug-ins do arquivo .magento/services.yaml. Este design evita a possível perda ou corrupção de dados que dependem desses plug-ins.

Para remover plug-ins do OpenSearch:

  1. Remova as entradas de plug-in OpenSearch do arquivo .magento/services.yaml.

  2. Adicionar, confirmar e enviar por push as alterações de código.

    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. Confirme as .magento/services.yaml alterações no repositório de nuvem.

  4. Reindexe o índice de pesquisa do catálogo.

    code language-bash 
    bin/magento indexer:reindex catalogsearch_fulltext

  5. Limpe o cache.

    code language-bash 
    bin/magento cache:clean
recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26