iBus

Allgemeines¶

Der iBus (information bus) bildet in einem InGrid-System das zentrale Element. Er fungiert als Verteilungsstation zwischen Datenquellen und Suchanfragen. So nimmt der iBus eine Suchanfrage von der Portaloberfläche oder einer anderen übergeordneten Schnittstelle entgegen, bereitet die Anfrage auf und sucht in einem zentralen Index, der im Elasticsearch abgelegt ist. Es kann auch ein iPlug angeschlossen sein, das seine Daten nicht im zentralen Index ablegt und vom iBus separat angefragt wird. Dabei wird dann die Suchanfrage auf dem iPlug durchgeführt und das Ergebnis über den iBus zum Aufrufer (z.B. das Portal) weitergeleitet.

Systemvoraussetzungen¶

Installation¶

Die Installation des iBus kann mit Docker oder direkt aus dem GitHub-Repository erfolgen. Im Folgenden sind Beispiele und Anleitungen dazu aufgelistet.

Docker¶

  ingrid-ibus:
    image: docker-registry.wemove.com/ingrid-ibus
    restart: unless-stopped
    environment:
      - TZ=Europe/Berlin
      - CODELIST_URL=http://ingrid-codelist-repo:8080
      - CODELIST_USERNAME=admin
      - CODELIST_PASSWORD=${CODELIST_PASSWORD}
      - ELASTIC_HOSTS=elastic:9200
    volumes:
      - ./conf/activatedIplugs.properties:/opt/ingrid/ingrid-ibus/conf/activatedIplugs.properties
    command: ["sh", "wait-for-elasticsearch.sh", "elastic:9200", "/bin/sh start.sh start"]

From Source¶

Um den iBus direkt auf einem System zu installieren, müssen folgende Vorbedingungen erfüllt sein:

• Elasticsearch 8.x
• Maven 3.5.0+
• Java 17

Die Installation des iBus (z.B. nach /opt/ingrid/ibus) erfolgt dann mit diesen Schritten:

iBus klonen und bauen¶

git clone https://github.com/informationgrid/ingrid-ibus
cd ingrid-ibus
mvn clean package assembly:single -DskipTests

iBus installieren¶

unzip distributions/target/ingrid-ibus-8.1.0-SNAPSHOT-installer.jar "ingrid-*"
cd ingrid-ibus-8.1.0-SNAPSHOT

iBus starten¶

export INGRID_USER=$USER
./start.sh start

Der iBus besitzt eine Administrationsoberfläche, über die die angeschlossenen iPlugs eingesehen und verwaltet werden können.

http://localhost:PORT

Anstelle von localhost können Sie auch die IP-Adresse des Computers eingeben. Nach einer neuen Installation wird man automatisch auf die Konfigurationsseite geleitet, wo man das Administrationspasswort eingeben muss. Nachdem dieses eingegeben worden ist, muss man sich erneut einloggen, um die volle Funktionalität zu nutzen.

Konfiguration¶

Die Systemkonfiguration befindet sich in der application.properties Datei im conf-Verzeichnis. Änderungen an der Konfiguration sollten in der Datei application-default.properties geschrieben werden. Die wichtigsten Einstellungen können über die Admin-Gui getätigt werden. Im Folgenden werden die Umgebungsvariablen beschrieben, die für die Einrichtung häufig benötigt werden.

Umgebungsvariablen¶

Einstellungen in der Admin-Gui¶

In den Einstellungen auf der Administrationsseite können folgende Parameter konfiguriert werden:

• URL zum Codelist-Repository
  • ebenfalls der Benutzername und Passwort
• die URL zum Elasticsearch Cluster
  • optional auch Benutzername und Passwort
  • optional auch mit SSL-Zertifikat (/opt/ingrid/ingrid-ibus/elasticsearch-ca.pem)
• ID des iBusses
• Port des iBusses, auf dem sich die iPlugs verbinden können
• das Passwort für die Admin-GUI

Die Einstellungen für das Codelist-Repository und Elasticsearch haben außerdem eine Signalisierung, die anzeigt, ob eine Verbindung zu der externen Komponente besteht. Falls die Anzeige "Rot" ist, ist die Komponente entweder nicht gestartet oder der iBus hat eine falsche Konfiguration.

Konfiguration der aktivierten Indizes¶

Wird ein Index aktiviert, so wird diese Information in der Datei activatedIplugs.properties hinterlegt. Zusätzlich wird diese Information auch im Elasticsearch-Index vermerkt, was die activatedIplugs.properties in Zukunft ersetzen soll, so dass auch direkte Anfragen an Elasticsearch auf nur ausgewählte Indizes ermöglicht werden.

FAQ¶