Documentação do Oracle Cloud Infrastructure

Estabelecendo Conexão com um Cluster OpenSearch

Este tópico abrange os pré-requisitos e os detalhes da conexão necessários para estabelecer conexão com o cluster OpenSearch do OCI Search com OpenSearch. Ele também inclui um passo a passo que abrange as etapas para alguns cenários básicos de conexão usando uma instância de VM na mesma VCN e sub-rede do cluster.

Use as informações fornecidas aqui para permitir que seus clientes OpenSearch e soluções de pesquisa personalizadas conectem e ingeram dados do seu cluster.

Observação

Embora a Pesquisa com OpenSearch esteja aplicando patches às instâncias de um cluster ou redimensionando o cluster, a funcionalidade de pesquisa do cluster está no modo somente leitura, o modo de gravação está desativado para uma janela de manutenção. Consulte Operações de Aplicação de Patches e Redimensionamento de Clusters para obter mais informações.

Pontos Finais Privados

A pesquisa com OpenSearch fornece acesso ao seu cluster e aos Painéis de Controle OpenSearch do seu cluster em pontos finais privados. O serviço fornece duas maneiras de estabelecer conexão com os pontos finais privados do seu cluster:

  • IP Privado: O endereço IP privado do ponto final privado. Use o IP privado se você estiver se conectando de uma instância de VM dentro da mesma VCN e sub-rede do seu cluster. Você também pode usar o IP privado ao se conectar da sua máquina local com o encaminhamento de porta configurado para a instância da VM.
  • Ponto final de API: O FQDN (Fully Qualified Domain Name) fornecido pelo serviço para acessar os pontos finais privados do cluster. Use o ponto final da API ao estabelecer conexão do seu cliente OpenSearch, como LogStash ou Beats.

Consulte Pré-requisitos para obter detalhes específicos.

Com endpoints privados, o tráfego não passa pela internet. Os pontos finais só podem ser acessados dentro da VCN do seu cluster. Para tornar o ponto final da API acessível aos seus clientes OpenSearch, é necessária mais configuração para tornar o ponto final acessível a clientes externos. Por exemplo, você pode usar o serviço API Gateway para permitir o acesso com um endereço IP público.

Pré-requisitos

Veja a seguir a lista de pré-requisitos necessários para se conectar ao seu cluster

  1. Determinar as informações de conexão do cluster.

  2. Crie as regras de segurança necessárias.

  3. (Opcional) Criar e estabelecer conexão com uma instância de VM.

Informações da Conexão do Cluster

As informações de conexão do cluster incluem os pontos finais da API e os endereços IP que você usa para estabelecer conexão e trabalhar com o cluster e os Painéis de Controle OpenSearch do cluster. Para obter mais informações, consulte Pontos Finais Privados.

Você pode encontrar todas as informações de conexão na página Detalhes do Cluster na Console.

Observação

As conexões com clusters criados antes de 15 de setembro de 2022 exigem que você faça download de um certificado. O domínio do ponto final da API para esses clusters é oci.oracleiaas.com. As conexões com clusters criados em 15 de setembro de 2022 ou posterior não exigem a etapa extra de download de um certificado. O domínio do ponto final da API para esses clusters é oci.oraclecloud.com.

Exibindo Detalhes do Cluster

  1. Na página de lista Clusters, localize o cluster com o qual você deseja trabalhar. Se precisar de ajuda para localizar a página de lista ou o cluster, consulte Listando Clusters OpenSearch.
  2. Na lista Clusters, selecione o nome do cluster cujos detalhes você deseja exibir.
  3. Na página Detalhes do Cluster, anote o seguinte:
    • Ponto final da API: O FQDN do ponto final privado do cluster.
    • IP Privado: O endereço IP privado do ponto final privado do cluster.
    • OpenSearch Ponto final da API de Painéis: O FQDN dos Painéis de Controle OpenSearch do cluster.
    • OpenSearch IP Privado dos Painéis: O endereço IP do ponto final privado que você pode usar para estabelecer conexão com os Painéis de Controle OpenSearch do cluster.

Criar Regras de Segurança

Você precisa criar regras de segurança para a VCN do cluster para permitir conexões com o cluster e com os Painéis de Controle OpenSearch do cluster.

Para tornar os dados acessíveis do seu cluster, adicione regras de segurança de entrada com monitoramento de estado para tráfego TCP do seguinte modo:

  • OpenSearch na porta de destino 9200 da origem 0.0.0.0/0 e de qualquer porta de origem.
  • OpenSearch Painéis na porta de destino 5601 da origem 0.0.0.0/0 e de qualquer porta de origem.

Você pode criar uma lista de segurança com essas regras ou adicioná-las à lista de segurança padrão da VCN do cluster.

Opção 1: Criar uma Lista de Segurança

  1. Na página de lista Clusters, localize o cluster com o qual você deseja trabalhar. Se precisar de ajuda para localizar a página de lista ou o cluster, consulte Listando Clusters OpenSearch.
  2. Selecione o cluster desejado.
  3. Em Detalhes do cluster, para Rede virtual no nuvem, clique no nome da rede no nuvem. A página Detalhes da Rede Virtual em Nuvem é aberta.
  4. Em Recursos, clique em Listas de Segurança.
  5. Selecione Criar Lista de Segurança.
  6. Informe o seguinte:
    1. Nome: um nome descritivo para a lista do serviço Security. O nome não precisa ser exclusivo e não poderá ser alterado posteriormente na Console (mas você pode alterá-lo com a API). Evite digitar informações confidenciais.
    2. Criar no Compartimento: o compartimento em que você deseja criar a lista de segurança, se diferente do compartimento em que está trabalhando.
  7. Clique em Outra Regra de Entrada.
  8. Informe os seguintes valores para a regra:
    • Sem monitoramento de estado: Deixe a caixa de seleção desmarcada.
    • Tipo de Origem: CIDR
    • CIDR de Origem: 0.0.0.0/0
    • Protocolo IP: TCP
    • Faixa de Portas de Origem: Tudo
    • Intervalo de Portas de Destino: 9200
    • Descrição: Uma descrição opcional da regra.
  9. Selecione Outra Regra de Entrada.
  10. Informe os seguintes valores para a regra:
    • Sem monitoramento de estado: Deixe a caixa de seleção desmarcada.
    • Tipo de Origem: CIDR
    • CIDR de Origem: 0.0.0.0/0
    • Protocolo IP: TCP
    • Faixa de Portas de Origem: Tudo
    • Intervalo de Portas de Destino: 5601
    • Descrição: Uma descrição opcional da regra.
  11. Selecione Criar Lista de Segurança.

Opção 2: Adicionar regras à lista de segurança padrão

  1. Na página de lista Clusters, localize o cluster com o qual você deseja trabalhar. Se precisar de ajuda para localizar a página de lista ou o cluster, consulte Listando Clusters OpenSearch.
  2. Em Detalhes do cluster, para Rede virtual no nuvem, clique no nome da rede no nuvem. A página Detalhes da Rede Virtual em Nuvem é aberta.
  3. Em Recursos, clique em Listas de Segurança.
  4. Selecione a lista de segurança denominada Lista de Segurança Padrão para VCN_name.
  5. Selecione Adicionar Regras de Entrada.
  6. Informe os seguintes valores para a regra:
    • Sem monitoramento de estado: Deixe a caixa de seleção desmarcada.
    • Tipo de Origem: CIDR
    • CIDR de Origem: 0.0.0.0/0
    • Protocolo IP: TCP
    • Faixa de Portas de Origem: Tudo
    • Intervalo de Portas de Destino: 9200
    • Descrição: Uma descrição opcional da regra.
  7. Selecione Outra Regra de Entrada.
  8. Informe os seguintes valores para a regra:
    • Sem monitoramento de estado: Deixe a caixa de seleção desmarcada.
    • Tipo de Origem: CIDR
    • CIDR de Origem: 0.0.0.0/0
    • Protocolo IP: TCP
    • Faixa de Portas de Origem: Tudo
    • Intervalo de Portas de Destino: 5601
    • Descrição: Uma descrição opcional da regra.
  9. Selecione Adicionar Regras de Entrada.

Criar uma Instância de VM (Opcional)

Após concluir os pré-requisitos de conexão, opcionalmente você pode criar uma instância de VM para executar alguns testes de conexão básicos para verificar se os pré-requisitos foram configurados corretamente e se você tem as informações de conexão corretas. Você cria a instância de VM na mesma sub-rede para a VCN na qual criou o cluster. Consulte um dos seguintes tópicos para saber como criar uma instância:

Após a criação da instância, conecte-se à instância na sua máquina local. Para obter mais informações, consulte:

Testar a Conexão com o Seu Cluster

Depois de se conectar à instância da VM na sua máquina local, execute um dos comandos a seguir para testar a conexão.

Para clusters em que o domínio do ponto final da API é oci.oraclecloud.com (criado em 15 de setembro de 2022 ou após essa data):

curl https://<cluster_API_endpoint>:9200

O URL informado neste comando é o valor especificado no campo ponto final da API na página Detalhes do Cluster. Consulte Pré-requisitos.

Se a conexão com o ponto final for bem-sucedida, uma resposta como a seguinte será retornada:

{
  "name" : "opensearch-master-0",
  "cluster_name" : "<cluster_name>",
  "cluster_uuid" : "<cluster_UUID>",
  "version" : {
    "distribution" : "opensearch",
    "number" : "1.2.4-SNAPSHOT",
    "build_type" : "tar",
    "build_hash" : "<build_hash>",
    "build_date" : "2022-02-08T16:44:39.596468Z",
    "build_snapshot" : true,
    "lucene_version" : "8.10.1",
    "minimum_wire_compatibility_version" : "6.8.0",
    "minimum_index_compatibility_version" : "6.0.0-beta1"
  },
  "tagline" : "The OpenSearch Project: https://opensearch.org/"
}

Para outros comandos que você pode testar, incluindo o envio de dados para o cluster e o envio de consultas de pesquisa ao cluster, consulte o tutorial Pesquisar e visualizar dados usando o OCI Search Service com OpenSearch.

Testar a Conexão com os Painéis de Controle OpenSearch do Cluster

Uma das maneiras de estabelecer conexão com os Painéis de Controle OpenSearch do seu cluster é configurando o encaminhamento de porta da sua máquina local para a instância de VM criada na mesma VCN e sub-rede do cluster.

Para configurar o encaminhamento de porta para estabelecer conexão com os Painéis de Controle OpenSearch, siga estas etapas:

  1. Crie uma instância de VM.
  2. Execute o seguinte comando na sua máquina local: 
    ssh -C -v -t -L 127.0.0.1:5601:<OpenSearch_Dashboards_private_IP>:5601 -L 127.0.0.1:9200:<OpenSearch_cluster_private_IP>:9200 opc@<VM_instance_public_IP> -i <private_key_file>

    Substitua <OpenSearch_Dashboards_private_IP> pelo IP privado dos Painéis de Controle OpenSearch do seu cluster. Substitua <OpenSearch_cluster_private_IP> pelo IP privado do seu cluster. Para localizar os IPs privados, consulte Pré-requisitos.

    Substitua <VM_instance_public_IP> pelo endereço IP público da instância da VM. Substitua <private_key_file> pelo caminho para a chave privada usada para estabelecer conexão com a instância. Para obter mais informações sobre esses valores e como localizá-los, consulte Estabelecendo Conexão com uma Instância.

  3. Em um browser na sua máquina local, abra https://localhost:5601 para acessar os Painéis de Controle OpenSearch.