Elasticsearch installieren

Gültig für: yuuvis® RAD Version 8.x

Elasticsearch wird in yuuvis® RAD für die Suche eingebunden.

Bestandteil ist ein Linguistic Plugin für die Optimierung der Suche in einer der folgenden Sprachen: Deutsch, Englisch, Französisch, Spanisch, Italienisch. Die Sprache wird bei der Installation von yuuvis® RAD service-manager angegeben. Sie kann geändert werden.

Stellen Sie vor der Installation sicher, dass die Systemvoraussetzungen erfüllt sind.

Schritte für die Installation von Elasticsearch:

  1. Installationsverzeichnis \elasticsearch in das Dateisystem des Rechners kopieren, auf dem Elasticsearch installiert werden soll.

  2. elasticsearch_setup.exe aus dem Installationsverzeichnis ausführen.
  3. Der Installationsassistent wird gestartet. Folgen Sie den Schritten des Installationsassistenten.

  4. Geben Sie folgende Parameter an:

  5. HTTP-Port Port von Elasticsearch. Default: 9200
    Indexverzeichnis

    Indexverzeichnis für Elasticsearch.

    Das Indexverzeichnis sollte auf einem möglichst schnellen und großen Datenträger und nicht innerhalb des Installationsverzeichnisses angelegt werden.

    Maximaler Speicher Maximaler Arbeitsspeicher für den Dienst in MB
  6. Passen Sie vor dem Dienststart die Dienstparametern an:

    elasticsearch-service-x64w.exe aus dem Verzeichnis \bin ausführen.

    Dienstparameter:

    Log On > Account

    Konto für die Dienstanmeldung

    Elasticsearch benötigt ein administratives Konto.

    Logging > Level Optional: Protokollierungslevel für die Dienstprotokollierung
    Logging > Path Optional: Pfad für Dienstprotokolle
    Logging > Stdout Optional: Umleitung der Standardausgabe in eine Datei
    Logging > Stderror Optional: Umleitung der Standardfehlerausgabe in eine Datei
  7. Weitere optionale Anpassungen:

    • Indexverzeichnis anpassen
    • Über die Konfigurationsdatei elasticsearch.yml aus dem Elasticsearch-Verzeichnis \config kann das Indexverzeichnis angepasst werden. Parameter: path.data

    • Windows-Dienststeuerung
    • Über die Windows-Dienststeuerung die Wiederherstellung bei Dienstfehlern konfigurieren: Wählen Sie Dienst neu starten für alle Fehler.

    • Logging
    • Über die Konfigurationsdatei elasticsearch.yml aus dem Elasticsearch-Verzeichnis \config kann das Elasticsearch-Protokollverzeichnis angepasst werden. Parameter: path.logs

    • Suchen: AND/OR
    • Für die Volltextsuche werden mehrere Begriffe durch das boolesche AND verbunden, wenn der Benutzer keinen Operator angibt. Über die Konfigurationsdatei search-prod.yml aus dem Verzeichnis \config von yuuvis® RAD service-manager kann der Standard-Operator umgestellt werden. Parameter: osfts.default-operator: OR

    • Suchen: Unscharfe Suche
    • Über die Konfigurationsdatei search-prod.yml aus dem Verzeichnis \config von yuuvis® RAD service-manager kann die unscharfe Suche aktiviert werden.

      Parameter: osfts.fuzzy-search: true

      Bei der unscharfen Suche werden Kombinationen von Begriffen nur gefunden, wenn die Kombination in den Metadaten oder im Inhalt vorliegt.

    • Shard-Anzahl
    • Standard: Ein Shard pro Index.

      Über die Konfigurationsdatei index-prod.yml aus dem Verzeichnis \config von yuuvis® RAD service-manager kann die Shard-Anzahl angegeben werden. Parameter: osfts.number-of-shards

      Änderungen erfordern eine Reindexierung über die REST-API:

      • URL aufrufen: http://<service-admin-IP>:7291/swagger-ui.html#!/api-controller/reindexUsingPOST
      • Buttton Try it out! klicken
      • Die Reindexierung wird sofort gestartet.

    • CSV für den Export von Trefferlisten
    • Über die Konfigurationsdatei search-prod.yml aus dem Verzeichnis \config von yuuvis® RAD service-manager kann das Trennzeichen für Spalten in exportierten CSV-Dateien angegeben werden. Parameter: csv.delimiter: ';'. Default: Semikolon.

      CSV-Dateien werden immer UTF-8-codiert ausgegeben. Mit dem Parameter csv.writeBOM: true wird die Datei mit BOM ausgegeben. Default: ohne BOM.

    • Auto-Vervollständigung

    • Die maximale Anzahl der Vorschläge für Felder mit der entsprechenden Eigenschaft kann über die Konfigurationsdatei index-prod.yml aus dem Verzeichnis \config von yuuvis® RAD service-manager angegeben werden. Parameter: osfts.autocomplete.suggestions-size: 500. Default: 500.

      Die Auto-Vervollständigung kann über folgenden Eintrag in der Konfigurationsdatei application-es.yml aus dem Verzeichnis \config von yuuvis® RAD service-manager deaktiviert werden:

      osfts.autocomplete.enabled: false

      Eine Neuerstellung des Auto-Vervollständigungs-Index kann über die REST-API erfolgen:

      • URL aufrufen: http://<service-admin-IP>:7291/swagger-ui.html#!/api-controller/completeAutocompleteIndexUsingPOST
      • Optional: Zeitraum eingeben
      • Buttton Try it out! klicken
      • Die Index-Erstellung wird sofort gestartet.

    • Index-Bereinigung
    • Nach dem Löschen größerer Mengen von Dokumenten kann der Volltextindex bereinigt werden.

      • URL aufrufen: http://<service-admin-IP>:7291/swagger-ui.html#!/api-controller/cleanUpUsingPOST
      • Optional: Objekttyp angeben
      • Buttton Try it out! klicken
      • Die Bereinigung wird sofort gestartet.

        Die Bereinigung erfolgt batchweise, die Batch-Größe ist über die Datei index-prod.yml aus dem Verzeichnis \config von yuuvis® RAD service-manager konfigurierbar: 

        osfts.cleanup.bulkSize: 1000

    • Fehlerbehandlung
    • Wenn Fehler bei Indexierungen auftreten, dann wird als Standard dreimal im Abstand von einer Stunde ein erneuter Versuch gestartet.

      Dieses Verhalten kann durch eine Konfiguration in der Datei index-prod.yml aus dem Verzeichnis \config von yuuvis® RAD service-manager geändert werden:

      routing:
        errorHandling:
          retry: 3
          periodInMinutes: 60
          startPolicy: "0 0/1 * ? * * *" 

      Parameter:

      retry Anzahl der Versuche
      periodInMinutes Abstand zwischen den Versuchen
      startPolicy Zeitplan für Versuche in Cron-Notation

    • Linguistic Plugin
    • Eine Sprache für das Linguistic Plugin wird bei der Installation von yuuvis® RAD service-manager angegeben.Über die Konfigurationsdatei index-prod.yml aus dem Verzeichnis \config von yuuvis® RAD service-manager kann eine andere Sprache aktiviert werden:

      osfts:
        languages: 'de'

      Geben Sie hier das Kürzel für die gewünschte Sprache an: Deutsch (de), Englisch (en), Französisch (fr), Spanisch (es), Italienisch (it). Lizenzen für mehrere und weitere Sprachen können eingebunden werden.

  8. Starten Sie den Dienst Elasticsearch.
  9. Konfigurieren Sie die Authentifizierung für Elasticsearch:
    • Führen Sie die Batch-Datei elasticsearch-set-initial-passwords.bat aus dem Elasticsearch-Verzeichnis \bin mit administrativen Rechten aus.
    • Öffnen Sie die Datei built-in.usr aus dem Elasticsearch-Verzeichnis \config.
    • Kopieren Sie das Passwort des Benutzers 'elastic'.
    • Geben Sie das Passwort bei der Installation von yuuvis® RAD service-manager an.

Cluster

Für die Installation von Eleasticsearch-Clustern beachten Sie bitte Folgendes:

  • Weitere Installationen dürfen vor dem Anpassen der Konfigurationsdateien nicht gestartet werden.
  • Tragen Sie vor dem Dienst-Start in die Konfigurationsdateien elasticsearch.yml jeder Elasticsearch-Installation alle Elasticsearch-Adressen ein:
    • discovery.seed_hosts: ["host1", "host2"]
  • Tragen Sie vor dem Dienst-Start in die Konfigurationsdateien elasticsearch.yml jederElasticsearch- Installation eindeutige Bezeichnungen für Nodes ein: node.name: nodename1
  • Tragen Sie vor dem Dienst-Start in die Konfigurationsdateien elasticsearch.yml jeder Elasticsearch-Installation alle Nodes ein:
    • cluster.initial_master_nodes: ["node-1", "node-2"]
  • Erzeugen Sie das Passwort über die Batch-Datei elasticsearch-set-initial-passwords.bat bei laufendem Dienst ausschließlich für die erste Elasticsearch-Installation.
  • Starten Sie die erste Elasticsearch-Installation und danach alle weiteren Installationen.

Details zur Konfiguration von Clustern finden Sie in den entsprechenden Dokumentationen von Elasticsearch.

Deinstallation

Deinstallieren Sie Elasticsearch über das Deinstallations-Programm aus dem Installationsverzeichnis.

Update

Informationen zur Aktualisierung von Komponenten erhalten Sie über die Release-Informationen.