Documentation Oracle Cloud Infrastructure

Connexion à un cluster OpenSearch

Cette rubrique présente les prérequis et les détails de connexion requis pour se connecter au cluster OpenSearch pour OCI Search avec OpenSearch. Il comprend également une procédure pas à pas qui couvre les étapes de certains scénarios de connexion de base utilisant une instance de machine virtuelle dans le même VCN et le même sous-réseau que le cluster.

Utilisez les informations fournies ici pour permettre à vos clients OpenSearch et à vos solutions de recherche personnalisées de connecter et d'ingérer des données à partir de votre cluster.

Remarque

Alors que Search with OpenSearch applique des patches aux instances d'un cluster ou redimensionne le cluster, la fonctionnalité de recherche du cluster est en mode lecture seule, le mode écriture est désactivé pour une fenêtre de maintenance. Pour plus d'informations, reportez-vous à la section Cluster Patching and Resize Operations.

Adresses privées

La recherche avec OpenSearch permet d'accéder à votre cluster et aux tableaux de bord OpenSearch de votre cluster sur les adresses privées. Le service offre deux façons de se connecter aux adresses privées de votre cluster :

  • Adresse IP privée : adresse IP privée de l'adresse privée. Utilisez l'adresse IP privée si vous connectez à partir d'une instance de machine virtuelle au sein du même VCN et du même sous-réseau que votre cluster. Vous pouvez également utiliser l'adresse IP privée lorsque vous vous vous connectez à partir de votre machine locale avec le transfert de port configuré vers l'instance de machine virtuelle.
  • Adresse d'API : nom de domaine complet fourni par le service pour accéder aux adresses privées du cluster. Utilisez l'adresse d'API lors de la connexion à partir du client OpenSearch, par exemple LogStash ou Beats.

Pour plus d'informations, reportez-vous à Prérequis.

Avec des adresses privées, le trafic ne passe pas par Internet. Les adresses sont uniquement accessibles à partir du VCN de votre cluster. Pour permettre à l'adresse d'API d'accéder à vos clients OpenSearch, vous devez configurer davantage l'adresse afin qu'elle soit accessible aux clients externes. Par exemple, vous pouvez utiliser API Gateway pour activer l'accès avec une adresse IP publique.

Prérequis

Vous trouverez ci-dessous la liste des prérequis requis pour la connexion au cluster.

  1. Déterminez les informations de connexion du cluster.

  2. Créez les règles de sécurité requises

  3. (Facultatif) Création d'une instance de machine virtuelle et connexion à celle-ci.

Informations sur la connexion du cluster

Les informations de connexion du cluster incluent les adresses d'API et les adresses IP que vous utilisez pour vous connecter à votre cluster et utiliser ses tableaux de bord OpenSearch. Pour plus d'informations, reportez-vous à Adresses privées.

Vous trouverez toutes les informations de connexion sur la page Détails du cluster dans la console.

Remarque

Les connexions aux clusters créés avant le 15 septembre 2022 nécessitent le téléchargement d'un certificat. Le domaine de l'adresse d'API pour ces clusters est oci.oracleiaas.com. Les connexions aux clusters créés le 15 septembre 2022 ou après ne nécessitent pas l'étape supplémentaire de téléchargement d'un certificat. Le domaine de l'adresse d'API pour ces clusters est oci.oraclecloud.com.

Affichage des détails d'un cluster

  1. Sur la page de liste Clusters, recherchez le cluster avec lequel vous voulez travailler. Si vous avez besoin d'aide pour trouver la page de liste ou le cluster, reportez-vous à Liste des clusters OpenSearch.
  2. Dans la liste Clusters, sélectionnez le nom du cluster pour lequel afficher les détails.
  3. Sur la page Détails du cluster, tenez compte des éléments suivants :
    • Adresse d'API : nom de domaine qualifié complet de l'adresse privée du cluster.
    • Adresse IP privée : adresse IP privée de l'adresse privée du cluster.
    • Adresse d'API OpenSearch Dashboards : nom de domaine qualifié complet des tableaux de bord OpenSearch du cluster.
    • Adresse IP privée des tableaux de bord OpenSearch : adresse IP de l'adresse privée que vous pouvez utiliser pour vous connecter aux tableaux de bord OpenSearch du cluster.

Créer des règles de sécurité

Vous devez créer des règles de sécurité pour le VCN du cluster afin d'autoriser les connexions au cluster et aux tableaux de bord OpenSearch du cluster.

Pour rendre les données accessibles à partir de votre cluster, vous devez ajouter des règles de sécurité entrantes avec conservation de statut pour le trafic TCP pour les éléments suivants :

  • OpenSearch sur le port de destination 9200 à partir de la source 0.0.0.0/0 et de tout port source.
  • OpenSearch Tableaux de bord sur le port de destination 5601 à partir de la source 0.0.0.0/0 et de tout port source.

Vous pouvez créer une liste de sécurité avec ces règles ou les ajouter à la liste de sécurité par défaut pour le VCN du cluster.

Option 1 : création d'une liste de sécurité

  1. Sur la page de liste Clusters, recherchez le cluster avec lequel vous voulez travailler. Si vous avez besoin d'aide pour trouver la page de liste ou le cluster, reportez-vous à Liste des clusters OpenSearch.
  2. Sélectionnez le cluster qui vous intéresse.
  3. Sous Détails du cluster, dans Réseau cloud virtuel, cliquez sur le nom du réseau cloud. La page Détails du réseau cloud virtuel s'ouvre.
  4. Sous Ressources, cliquez sur Listes de sécurité.
  5. Sélectionnez Créer une Liste de Sécurité.
  6. Entrez les informations suivantes :
    1. Nom : nom descriptif de la liste de sécurité. Le nom n'a pas besoin d'être unique et ne peut être modifié ultérieurement dans la console (mais vous pouvez le modifier avec l'API). Evitez de saisir des informations confidentielles.
    2. Créer dans le compartiment : compartiment de création de la liste de sécurité, s'il est différent du compartiment où vous travaillez.
  7. Cliquez sur Autre règle entrante.
  8. Entrez les valeurs suivantes pour la règle :
    • Sans conservation de statut : ne cochez pas la case.
    • Type de source : CIDR
    • CIDR source : 0.0.0.0/0
    • Protocole IP : TCP
    • Plage de ports source : Tous
    • Plage de ports de destination : 9200
    • Description : description facultative de la règle.
  9. Sélectionnez Autre règle entrante.
  10. Entrez les valeurs suivantes pour la règle :
    • Sans conservation de statut : ne cochez pas la case.
    • Type de source : CIDR
    • CIDR source : 0.0.0.0/0
    • Protocole IP : TCP
    • Plage de ports source : Tous
    • Plage de ports de destination : 5601
    • Description : description facultative de la règle.
  11. Sélectionnez Créer une Liste de Sécurité.

Option 2 : ajout de règles à la liste de sécurité par défaut

  1. Sur la page de liste Clusters, recherchez le cluster avec lequel vous voulez travailler. Si vous avez besoin d'aide pour trouver la page de liste ou le cluster, reportez-vous à Liste des clusters OpenSearch.
  2. Sous Détails du cluster, dans Réseau cloud virtuel, cliquez sur le nom du réseau cloud. La page Détails du réseau cloud virtuel s'ouvre.
  3. Sous Ressources, cliquez sur Listes de sécurité.
  4. Sélectionnez la liste de sécurité nommée Liste de sécurité par défaut pour VCN_name.
  5. Sélectionnez Ajouter des règles entrantes.
  6. Entrez les valeurs suivantes pour la règle :
    • Sans conservation de statut : ne cochez pas la case.
    • Type de source : CIDR
    • CIDR source : 0.0.0.0/0
    • Protocole IP : TCP
    • Plage de ports source : Tous
    • Plage de ports de destination : 9200
    • Description : description facultative de la règle.
  7. Sélectionnez Autre règle entrante.
  8. Entrez les valeurs suivantes pour la règle :
    • Sans conservation de statut : ne cochez pas la case.
    • Type de source : CIDR
    • CIDR source : 0.0.0.0/0
    • Protocole IP : TCP
    • Plage de ports source : Tous
    • Plage de ports de destination : 5601
    • Description : description facultative de la règle.
  9. Sélectionnez Ajouter des règles entrantes.

Créer une instanciation de machine virtuelle (facultatif)

Une fois les prérequis de connexion remplis, vous pouvez éventuellement créer une instance de machine virtuelle pour exécuter des tests de connexion de base afin de vérifier que les prérequis ont été configurés correctement et que vous disposez des informations de connexion correctes. Vous créez l'instance de machine virtuelle dans le même sous-réseau pour le VCN dans lequel vous avez créé le cluster. Pour créer une instance, reportez-vous à l'une des rubriques suivantes :

Une fois l'instance créée, connectez-vous à l'instance à partir de votre ordinateur local. Pour plus d'informations, reportez-vous aux rubriques suivantes :

Test de la connexion à votre cluster

Une fois que vous êtes connecté à l'instance de machine virtuelle à partir de votre ordinateur local, exécutez l'une des commandes suivantes pour tester la connexion.

Pour les clusters dont le domaine d'adresse d'API est oci.oraclecloud.com (créé le 15 septembre 2022 ou après) :

curl https://<cluster_API_endpoint>:9200

L'URL transmise dans cette commande est la valeur indiquée dans le champ Adresse d'API de la page Détails du cluster. Reportez-vous à Prérequis.

Si la connexion à l'adresse réussit, une réponse semblable à la suivante est renvoyée :

{
  "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/"
}

Pour les autres commandes que vous pouvez tester, y compris la transmission de données au cluster et la soumission de requêtes de recherche au cluster, reportez-vous au tutoriel Rechercher et visualiser des données à l'aide d'OCI Search Service avec OpenSearch.

Test de la connexion aux tableaux de bord OpenSearch du cluster

L'un des moyens de vous connecter aux tableaux de bord OpenSearch de votre cluster consiste à configurer le transfert de port de votre ordinateur local vers l'instance de machine virtuelle que vous avez créée dans le même VCN et le même sous-réseau que le cluster.

Pour configurer le transfert de port pour la connexion aux tableaux de bord OpenSearch, procédez comme suit :

  1. Créez une instance de machine virtuelle.
  2. Exécutez la commande suivante à partir de votre ordinateur 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>

    Remplacez <OpenSearch_Dashboards_private_IP> par l'adresse IP privée des tableaux de bord OpenSearch de votre cluster. Remplacez <OpenSearch_cluster_private_IP> par l'adresse IP privée de votre cluster. Pour localiser les adresses IP privées, reportez-vous à Prérequis.

    Remplacez <VM_instance_public_IP> par l'adresse IP publique de l'instance de machine virtuelle. Remplacez <private_key_file> par le chemin de la clé privée que vous utilisez pour vous connecter à l'instance. Pour plus d'informations sur ces valeurs et sur leur localisation, reportez-vous à Connexion à une instance.

  3. Dans un navigateur de votre ordinateur local, ouvrez https://localhost:5601 pour accéder aux tableaux de bord OpenSearch.