SKOOR Webservice Konfiguration

Dienst starten / stoppen / neu starten / Status

Der eRanger-Webservice ist als Linux-Dienst konfiguriert und kann mit den entsprechenden Befehlen verwaltet werden:

# systemctl start eranger-webservice
# systemctl stop eranger-webservice
# systemctl restart eranger-webservice
# systemctl status eranger-webservice

Konfiguration

Ansonsten sollte die Standardkonfiguration ohne Änderungen sofort einsatzbereit sein.

Bei Bedarf können folgende Änderungen vorgenommen werden:

CORS (Cross-Origin Resource Sharing)

Wenn der Webservice von einer Anwendung mit einer anderen Herkunft genutzt werden soll, muss diese Herkunft als durch Kommas getrennte Liste in die Whitelist aufgenommen werden.

# cors.allowed.origins=

Sie müssen die URL, unter der sich SKOOR oder der SKOOR Viewer befindet, nicht hinzufügen. Anfragen von derselben Quelle sind standardmäßig bereits zulässig.

KI-Anbieter

KI-Anbieter werden hauptsächlich für die Generierung von Code aus natürlicher Sprache verwendet. Ein Beispiel ist die Text2SQL-Funktion für Datenabfragen.

SKOOR unterstützt derzeit die folgenden Anbieter:

SKOOR AI
- Wird von SKOOR als Operator betrieben, es müssen keine Daten mit anderen Drittanbietern geteilt werden.
- Gut als Ausgangspunkt geeignet.
- Bietet grundlegende Genauigkeit und Leistung.
- HTTPS-Verbindung zu ai.skoor.com erforderlich.
- Bereits in jeder SKOOR-Installation vorkonfiguriert.
OpenAI
- Wahrscheinlich der fortschrittlichste Anbieter.
- Erfordert ein API-Abonnement von OpenAI.
- HTTPS-Verbindung zu OpenAI-API-Servern erforderlich.
Google Gemini
- Ähnliche Genauigkeit wie OpenAI.
- Relativ schnell.
- Erfordert einen API-Schlüssel von Google Cloud.
- HTTPS-Verbindung zu Google Cloud-Servern erforderlich.

KI-Einstellungen (z. B. API-Schlüssel) können unter /etc/opt/eranger/eranger-webservice.cfg konfiguriert werden.

ai.enable=true 
                        # Enables or disables the AI features
ai.openaiApiKey=<key>
                        # API key can be obtained from OpenAI 
ai.googleVertexAiApiKey=/etc/opt/eranger/googleVertexAiKey.json
                        # Google JSON API key can be obtained from the Google Cloud Console.
ai.googleVertexAiProjectId=<google-project-id>
                        
ai.googleVertexAiLocation=<location>
                        # Location of the AI servers. Zurich is europe-west6

Es kann jeweils nur eine der folgenden Optionen aktiv sein: google oder openai. Wenn weder google noch openai konfiguriert sind, wird automatisch SKOOR AI verwendet.

Tomcat-Port

Wenn der Standardport 8090 nicht verfügbar ist, kann er in der Datei „/opt/eranger/eranger-webservice/eranger-webservice.conf” geändert werden:

/opt/eranger/eranger-webservice/eranger-webservice.conf

# Spring Boot service config file
# Has to be in the same directory as the JAR file
MODE=service
JAVA_HOME=/opt/eranger/eranger-jre/current
APP_NAME=eranger-webservice
JAVA_OPTS="-Dserver.port=8091"
PID_FOLDER=/var/opt/run/eranger
LOG_FOLDER=/var/log/eranger
LOG_FILENAME=eranger-webservice.log

Der gleiche Port muss in der Reverse-Proxy-Konfiguration in „/etc/httpd/conf.d/eranger-webservice-proxy.conf” konfiguriert werden:

/etc/httpd/conf.d/eranger-webservice-proxy.conf

# mod_proxy setup for using httpd as a reverse proxy for tomcat
# has to placed in /etc/httpd/conf.d
ProxyPass /eranger-webservice http://localhost:8091
ProxyPassReverse /eranger-webservice http://localhost:8091
<Location "/eranger-webservice">
  setOutputFilter DEFLATE
  Require all granted
  Satisfy Any
  Order allow,deny
  Allow from all
</Location>

PID-Datei

In der Standardkonfiguration wird eine PID-Datei in „/var/opt/run/eranger“ geschrieben.

Wenn ein anderer Pfad bevorzugt wird, kann dieser in der Datei „/opt/eranger/eranger-webservice/eranger-webservice.conf” konfiguriert werden.

/opt/eranger/eranger-webservice/eranger-webservice.conf

# Spring Boot service config file
# Has to be in the same directory as the JAR file
MODE=service
JAVA_HOME=/opt/eranger/eranger-jre/current
APP_NAME=eranger-webservice
JAVA_OPTS="-Dserver.port=8091"
PID_FOLDER=/new/pid/path

Multi-Tenancy

Der Webservice kann mithilfe der tenantid Daten von mehreren SKOOR Engines abrufen.

Um zusätzliche Backends zu konfigurieren, muss eine separate Konfigurationsdatei eranger-webservice-<tenantId>.cfg im Ordner /etc/opt/eranger bereitgestellt werden. Diese Datei ist im Grunde eine Kopie der Standarddatei eranger-webservice.cfg mit einer mandantenspezifischen Eranger-Adresse.

/etc/opt/eranger/eranger-websevice-<tenantId>.cfg

# eRanger Server Address
eranger.address=<host of Skoor server>

Sie müssen files.root oder reports.root nicht ändern. Der Webserver übernimmt die Trennung dieser Ordner selbst.

Nachdem die Konfiguration gespeichert wurde, sollten Sie in der Lage sein, Daten aus der konfigurierten SKOOR Engine abzurufen, indem Sie entweder den HTTP-Request-Header X-Tenant-Id oder den URL-Parameter tenantId angeben.