Erstellen Sie Ihre erste OpenSearch-Instanz und stellen Sie eine Verbindung her

Voraussetzungen

• Sie haben ein STACKIT-Kundenkonto: Kundenkonto erstellen
• Sie haben ein STACKIT-Benutzerkonto: Benutzerkonto erstellen
• Sie haben ein STACKIT-Projekt: Projekt erstellen

Instanz vorbereiten, bestellen und erstellen

In dieser Anleitung erstellen und konfigurieren Sie eine Instanz. Die Anleitung zeigt die gängigsten Einstellungen für eine kleine Entwicklungsumgebung. Beim Befolgen dieser Anleitung arbeiten Sie mit dem STACKIT Portal.

1. Besuchen Sie das STACKIT Portal.
2. Klicken Sie in der Seitenleiste auf OpenSearch.
3. Klicken Sie in der oberen Leiste auf OpenSearch erstellen.

Nach Abschluss der Schritte sehen Sie ein Overlay mit drei Bereichen:

Allgemeine Informationen

• Belassen Sie entweder den Namen der Instanz oder vergeben Sie einen individuellen Namen.
• Wählen Sie die Instanzversion aus.

Pläne

• Belassen Sie die Plan-Einstellungen bei stackit-opensearch-1.4.10-single (1 vCPU und 4 GB RAM), sofern Sie nicht im Voraus wissen, wie viele Ressourcen Sie benötigen. Sie können den Plan jederzeit ändern, indem Sie in der Seitenleiste Plans auswählen.

Benutzerdefinierte Parameter

• Fügen Sie die IPv4-Adresse Ihres Clients zur Liste der ACLs hinzu.

  Wenn Sie eine Verbindung mit dem Computer herstellen möchten, mit dem Sie diese Dokumentation aufrufen, nutzen Sie das IP-Trace-Tool von Cloudflare, um Ihre IPv4-Adresse zu ermitteln. Öffnen Sie Ihren bevorzugten Browser und rufen Sie das Cloudflare Trace Tool auf. Kopieren Sie den Wert hinter ip. Dieser sollte wie folgt aussehen: xxx.xxx.xxx.xxx. Ergänzen Sie anschließend /32 und fügen Sie den Eintrag als ACL hinzu. Fügen Sie dazu hinter der letzten IP ein Komma ein und ergänzen Sie Ihre Adresse. Das Feld erfordert eine durch Kommas getrennte Liste von IP-Netzwerken in CIDR-Notation.

Wenn Sie die IPv4-Adresse Ihres Clients nicht zur Liste der ACLs hinzufügen, können Sie keine Verbindung zu Ihrer Instanz herstellen.

Nachdem Sie alle Einstellungen überprüft haben, klicken Sie auf Kostenpflichtig bestellen, um Ihre neue Instanz zu erstellen. Anschließend sehen Sie eine Bestätigung, dass Ihre Instanz erstellt wurde. Ihre neue Instanz wird der Instanzliste hinzugefügt. Nach wenigen Minuten wechselt der Status von In Erstellung zu Aktiv.

Das Ausführen der hier beschriebenen Aktion kann Kosten verursachen oder Ihre laufenden Kosten ändern. Prüfen Sie sorgfältig, welche einmaligen und/oder laufenden Kosten anfallen, und führen Sie die Aktionen nur aus, wenn Sie damit einverstanden und dazu berechtigt sind.

Instanz konfigurieren

Um Änderungen an Ihrer Instanz vorzunehmen, müssen Sie diese auswählen. Klicken Sie dazu in der Seitenleiste auf OpenSearch und anschließend auf Ihre neu erstellte Instanz. Danach wird die Übersichtsseite Ihrer Instanz angezeigt.

Zugangsdaten erstellen

1. Navigieren Sie zu OpenSearch und wählen Sie die Instanz aus.

2. Wählen Sie im Menü Anmeldeinformationen.

3. Klicken Sie auf Anmeldeinformationen erstellen.

   Ein Dienstschlüssel wird erstellt.

4. Speichern Sie Endpunkt, Benutzername und Passwort.

5. Klicken Sie auf Schließen.

Verbindung zu Ihrer neuen Instanz testen

Sie können eine Verbindung zu OpenSearch-Instanzen mit jedem REST-API-Tool herstellen. Nachfolgend finden Sie Beispiele für eine Verbindung über das Terminal mit curl.

Terminal mit curl

Um eine Verbindung zur OpenSearch-Instanz herzustellen, müssen die folgenden Parameter definiert sein:

Parameter	Bedeutung	Beispiel
Endpunkt	Der Endpunkt Ihrer OpenSearch-Instanz.	https://sed24c2ed-0.data.eu01.onstackit.cloud:49339
Benutzername	Der Benutzername	a9s4051b692…
Passwort	Das Passwort	a9s4051b692…

curl -X GET [Endpunkt] --user [Benutzername]:[Passwort]

Sie erhalten eine Antwort wie diese:

{
  "name" : "os/49f0d818-18ac-4301-91af-48b2ebe9a670",
  "cluster_name" : "sed24c2ed",
  "cluster_uuid" : "Y3xuV2lPTrK6snUyaNGnhw",
  "version" : {
    "distribution" : "opensearch",
    "number" : "2.19.1",
    "build_type" : "tar",
    "build_hash" : "2e4741fb45d1b150aaeeadf66d41445b23ff5982",
    "build_date" : "2025-02-27T01:16:47.726162386Z",
    "build_snapshot" : false,
    "lucene_version" : "9.12.1",
    "minimum_wire_compatibility_version" : "7.10.0",
    "minimum_index_compatibility_version" : "7.0.0"
  },
  "tagline" : "The OpenSearch Project: https://opensearch.org/"
}

Sie haben nun über die REST-API Zugriff auf Ihren OpenSearch-Service. Weitere Details zur Nutzung von OpenSearch finden Sie in den How-Tos oder in der OpenSearch-Dokumentation.

Daten einfügen und abfragen

Um sich mit OpenSearch vertraut zu machen, können Sie einige Beispieldaten einfügen und abfragen.

Fügen Sie zunächst einige Beispieldaten in OpenSearch ein.

Parameter	Bedeutung	Beispiel
Endpunkt	Der Endpunkt Ihrer OpenSearch-Instanz.	https://sed24c2ed-0.data.eu01.onstackit.cloud:49339
Benutzername	Der Benutzername	a9s4051b692…
Passwort	Das Passwort	a9s4051b692…
Data	Ein JSON, das Sie in OpenSearch speichern möchten.	{ "Title": "The White Lioness", "Genre": "Thriller", "Year": 1993, "Author": "Henning Mankell", "Type": "novel" }

# Buch 1
curl -X POST [Endpunkt]/books/_doc/ \
  --user [Benutzername]:[Passwort] \
  --header "Content-Type: application/json" \
  --data '{
           "Title": "The White Lioness",
           "Genre": "Thriller",
           "Year": 1993,
           "Author": "Henning Mankell",
           "Type": "novel"
         }'

# Buch 2
curl -X POST [Endpunkt]/books/_doc/ \
  --user [Benutzername]:[Passwort] \
  --header "Content-Type: application/json" \
  --data '{
           "Title": "1984",
           "Genre": "Dystopian Fiction",
           "Year": 1949,
           "Author": "George Orwell",
           "Type": "novel"
         }'

# Buch 3
curl -X POST [Endpunkt]/books/_doc/ \
  --user [Benutzername]:[Passwort] \
  --header "Content-Type: application/json" \
  --data '{
           "Title": "The Hobbit",
           "Genre": "Fantasy",
           "Year": 1937,
           "Author": "J.R.R. Tolkien",
           "Type": "novel"
         }'

OpenSearch sollte mit einer Antwort reagieren, die in etwa wie folgt aussieht:

{"_index":"books","_id":"U9Fl6JkBSNAfLfHa8Pvs","_version":1,"result":"created","_shards":{"total":4,"successful":1,"failed":0},"_seq_no":0,"_primary_term":1}%

Nun können Sie einen Eintrag im Datensatz suchen. Dies entspricht einem Anwendungsfall, bei dem ein Benutzer im Frontend nach einem bestimmten Buch sucht:

Parameter	Bedeutung	Beispiel
Endpunkt	Der Endpunkt Ihrer OpenSearch-Instanz.	https://sed24c2ed-0.data.eu01.onstackit.cloud:49339
Benutzername	Der Benutzername	a9s4051b692…
Passwort	Das Passwort	a9s4051b692…
Data	Die Abfrage, mit der Sie filtern möchten	{ "query": { "wildcard": { "Title.keyword": { "value": "*Hobbit*", "case_insensitive": true } } } }

curl -X POST [Endpunkt]/books/_search?pretty \
  --user [Benutzername]:[Passwort] \
  --header "Content-Type: application/json" \
  --data '{
           "query": {
             "wildcard": {
               "Title.keyword": {
                 "value": "*Hobbit*",
                 "case_insensitive": true
               }
             }
           }
         }'

Sie erhalten eine Ausgabe, die in etwa wie folgt aussieht:

{
  "took" : 662,
  "timed_out" : false,
  "_shards" : {
    "total" : 1,
    "successful" : 1,
    "skipped" : 0,
    "failed" : 0
  },
  "hits" : {
    "total" : {
      "value" : 1,
      "relation" : "eq"
    },
    "max_score" : 1.0,
    "hits" : [
      {
        "_index" : "books",
        "_id" : "V9Fv6JkBSNAfLfHa6vu7",
        "_score" : 1.0,
        "_source" : {
          "Title" : "The Hobbit",
          "Genre" : "Fantasy",
          "Year" : 1937,
          "Author" : "J.R.R. Tolkien",
          "Type" : "novel"
        }
      }
    ]
  }
}

Nun haben Sie einige grundlegende Befehle mit OpenSearch ausgeführt. Ab hier können Sie mit den How-Tos tiefer in die Nutzung einsteigen.