OpenSearch auf Managed Flex Server einrichten

Auf unseren Managed Flex Servern kann OpenSearch als eigener Dienst betrieben werden. Die folgende Anleitung zeigt, wie Sie OpenSearch einrichten und über die Custom Service Control (CSC) verwalten können.

Einführung

OpenSearch ist eine Open-Source-Suchmaschine und Analytics-Plattform , die unter der Apache-Lizenz steht. Sie ist 2021 aus einem Ableger von Elasticsearch entstanden und ist ein Projekt der Linux Foundation.

Hostpoint stellt Ihnen OpenSearch als sogenannten Self-Managed-Service zur Verfügung. Das bedeutet, dass Sie die Anwendung selbständig auf Ihrem Server installieren und verwalten müssen, wir Ihnen dazu aber Unterstützung in Form dieser Anleitung bieten.

Installation anfordern

Um OpenSearch auf Ihrem Managed Flex Server nutzen zu können, müssen Sie zunächst die Installation bei uns anfordern.

Erstellen Sie hierfür einen Support-Code im Hostpoint Control Panel, wie in dieser Anleitung beschrieben.

Senden Sie den Support-Code anschliessend unserem technischen Support (support@hostpoint.ch) und bitten Sie um die Einrichtung von OpenSearch auf Ihrem Server.

Unser technischer Support richtet daraufhin Folgendes für Sie ein:

• Die OpenSearch-Installation auf Ihrem Server
• Die Verzeichnisstruktur unter ~/app/opensearch/ mit den Unterordnern config, data, logs und tmp
• Die Konfigurationsdateien jvm.options, log4j2.properties und opensearch.yml im Ordner ~/app/opensearch/config/
• Die Konfigurationsdateien sind mit den korrekten Pfaden für Ihren Server vorkonfiguriert.

OpenSearch konfigurieren

CSC-Service anlegen

Erstellen Sie nun mit dem folgenden Befehl einen neuen Custom Service für OpenSearch:

hpservices supervisord add opensearch

Bei erfolgreicher Ausführung sollten Sie folgende Antwort erhalten:

successfully created dir for opensearch: /home/username/.services/supervisord/opensearch
successfully created dir for opensearch: /home/username/.services/supervisord/opensearch/log
supervisord service config file written: /home/username/.services/supervisord/opensearch/service.conf

service.conf anpassen

In der Datei ~/.services/supervisord/opensearch/service.conf wird ein Konfigurationsgerüst für den neuen Service erstellt. Für OpenSearch müssen leichte Anpassungen vorgenommen werden.

Öffnen Sie die Datei mit vim oder einem anderen Editor und übernehmen Sie den folgenden Inhalt 1:1:

[program:opensearch]
command=/usr/local/lib/opensearch/bin/opensearch
autostart=true
stopwaitsecs=10
stdout_logfile=%(ENV_HOME)s/.services/supervisord/opensearch/log/default.log
stdout_logfile_maxbytes=1MB
stdout_logfile_backups=10
stderr_logfile=%(ENV_HOME)s/.services/supervisord/opensearch/log/default.err
stderr_logfile_maxbytes=10MB
stderr_logfile_backups=10
environment=OPENSEARCH_JAVA_HOME="/usr/local",OPENSEARCH_PATH_CONF="%(ENV_HOME)s/app/opensearch/config",JAVA_VERSION=25,OPENSEARCH_TMPDIR="%(ENV_HOME)s/app/opensearch/tmp"

Die environment-Zeile enthält mehrere wichtige Umgebungsvariablen:

• OPENSEARCH_JAVA_HOME legt den Pfad zur Java-Installation fest.
• OPENSEARCH_PATH_CONF zeigt auf Ihr Konfigurationsverzeichnis mit den drei Konfigurationsdateien.
• JAVA_VERSION gibt die zu verwendende Java-Version an.
• OPENSEARCH_TMPDIR definiert ein festes Verzeichnis für temporäre Dateien. Ohne diese Einstellung würde OpenSearch bei jedem Neustart ein neues zufälliges Verzeichnis unter /tmp erstellen, was zu zahlreichen verwaisten Verzeichnissen führen würde.

Integration

Mit supervisorctl update können Sie die neue Konfiguration für OpenSearch aktivieren:

supervisorctl update
opensearch: added process group

Überprüfen Sie anschliessend mit folgendem Befehl den Status des Services:

supervisorctl status opensearch

Genaueres zur Bedienung und zu den Möglichkeiten, die Ihnen mit der CSC zur Verfügung stehen, können Sie der Anleitung zur Custom Service Control entnehmen.

Testen

Testen Sie Ihre neue OpenSearch-Instanz mit dem folgenden Befehl:

curl http://127.0.0.1:9200/

Wenn alles richtig konfiguriert wurde, müssten Sie eine JSON-Antwort mit dem Namen und der OpenSearch-Version erhalten.

Wenn nicht, dann empfehlen wir Ihnen, die Anleitung nochmals durchzusehen. Sollte es weiterhin nicht funktionieren, können Sie uns gerne kontaktieren.

Bitte beachten Sie folgende Punkte:

1. Ihre OpenSearch-Instanz wird von uns nicht überwacht, daher können wir bei Fehlern oder Abstürzen leider nicht reagieren.
2. Bei Major Updates von OpenSearch kann es vorkommen, dass der Dienst nicht automatisch neu gestartet wird. In diesem Fall müssen Sie den Dienst mit dem Befehl supervisorctl restart opensearch neu starten.
3. Im Hostpoint Control Panel wird Ihre selbst erstellte OpenSearch-Instanz in der Serverübersicht nicht angezeigt.