Installation

Vorbereitungen

Bevor Sie das BPC installieren, sollten Sie die Systemanforderungen prüfen und folgende Vorbereitungen treffen.

Lizenz

Sie benötigen eine Lizenzdatei für Ihre Installation. Diese erhalten Sie vom Support oder Ihrem Sales-Kontakt.

Systembenutzer

Es wird empfohlen, für die Installation und den Betrieb einen dedizierten Benutzer auf dem System anzulegen. Eine negative Wechselwirkung mit anderen Anwendungen auf dem Server soll damit verhindert werden.

Der verwendete Systembenutzer sollte ein Home-Directory besitzen. Falls dies nicht der Fall ist, muss am Ende der Installation org.ops4j.pax.url.mvn.localRepository, in KARAF/etc/org.ops4j.pax.url.cfg, auf einen gültigen Pfad gesetzt werden. Ansonsten kommt es zu Fehlern, falls im Karaf weitere Features installiert werden.

Die Anwendung sollte niemals unter einem Benutzer mit uneingeschränkten Administrationsrechten (wie z.B. root) laufen.

Verzeichnis

Legen Sie ein Verzeichnis (im Folgenden als INSTALLATIONSVERZEICHNIS bezeichnet) an, in dem alle Komponenten installiert werden - z.B. /opt/bpc.

Installationsvorgehen

Es gibt unterschiedliche Möglichkeiten, das BPC zu installieren. Im Folgenden werden die Möglichkeiten beschrieben, ein vorgefertigtes Bundle (empfohlen) zu nutzen oder alle Bestandteile einzeln zusammenzustellen.

Alternativ gibt es auch die Möglichkeit, das BPC im Rahmen einer INUBIT-Installation über dessen Installer zu installieren. Eine Beschreibung dafür finden Sie in der INUBIT-Dokumentation.

Installation mittels Bundle-Datei

Die Installation über die Bundle-Datei ist eine einfache Möglichkeit, das BPC zu installieren, da in diesem Fall bereits alle benötigten Dateien (außer der Lizenz) enthalten sind.

  1. Laden Sie sich zunächst die Bundle-Datei passend für Ihr Betriebssystem herunter.

  2. Entpacken Sie die Bundle-Datei in das INSTALLATIONSVERZEICHNIS.

  3. Wenn Sie Windows als Betriebssystem nutzen, sollten Sie noch zusätzlich Links anlegen.

    cd INSTALLATIONSVERZEICHNIS
    mklink /J opensearch_config\virtimo\ssl ssl
    mklink /J opensearch-3.2.0 opensearch
    mklink /J karaf-5.0.X karaf
    mklink /J jdk-21.X _jvm

    Dies ist nicht zwingend nötig, aber es erleichtert den Betrieb, wenn zukünftig Updates eingespielt werden. So bleiben die Pfade der Systemkomponenten stabil.

  4. Legen Sie Ihre Lizenzdatei im Verzeichnis INSTALLATIONSVERZEICHNIS/karaf/deploy ab.

  5. Falls das BPC als Betriebssystem-Service eingerichtet werden soll, können Sie die Anleitung unter Services befolgen.

    Alternativ können Sie das BPC auch direkt starten und stoppen.

Am Ende sollte der Inhalt des INSTALLATIONSVERZEICHNIS wie folgt aussehen.

Diagram

Installation der Einzelteile

Im Folgenden wird beschrieben, wie die BPC-Systemkomponenten einzeln installiert werden können.

Zentrale Konfigurationsdateien bereitstellen

Es wird empfohlen, die Zentrale Konfigurationsdatei einzusetzen. Damit ist es möglich, wichtige Konfigurationen außerhalb von den Systemkomponenten vorzuhalten. Dies vereinfacht die Aktualisierung der einzelnen Komponenten, da die Konfiguration erhalten bleibt.

  1. Laden Sie die zentralen Konfigurationsdateien herunter.

  2. Legen Sie die Dateien direkt unter INSTALLATIONSVERZEICHNIS ab.

Weitere Informationen finden Sie unter Zentrale Konfigurationsdatei.

Java installieren

Die beiden Systemkomponenten OpenSearch und Java benötigen eine entsprechende Laufzeitumgebung (Java 21). Wenn Sie bereits eine passende Laufzeitumgebung auf dem System haben, dann können Sie die ersten beiden Schritte überspringen.

  1. Entpacken Sie das zu Ihrem Betriebssystem passende Java-Laufzeitumgebungsarchiv (jdk_*) in das INSTALLATIONSVERZEICHNIS.

  2. Erzeugen Sie einen Link mit dem Namen _jvm, der auf das Verzeichnis der Laufzeitumgebung zeigt:

    • Linux

    • Windows

    ln -s jdk-21.X _jvm
    mklink /J jdk-21.X _jvm
  3. Sie müssen für den Benutzer, der das BPC ausführt, die Umgebungsvariable JAVA_HOME mit dem Pfad zur Laufzeitumgebung (z.B. INSTALLATIONSVERZEICHNIS/_jvm) setzen.

    Für das Setzen von JAVA_HOME empfiehlt sich die Zentrale Konfigurationsdatei

OpenSearch installieren

  1. Entpacken Sie das zu Ihrem Betriebssystem passende OpenSearch-Archiv in das INSTALLATIONSVERZEICHNIS.

  2. Erzeugen Sie einen Link mit dem Namen opensearch, der auf das neue Verzeichnis zeigt:

    • Linux

    • Windows

    ln -s opensearch-3.2.0/ opensearch
    mklink /J opensearch opensearch-3.2.0

Wie im Abschnitt OpenSearch konfigurieren beschrieben, empfehlen wir, dass Sie das Konfigurationsverzeichnis auslagern.

Dazu verschieben Sie das OpenSearch-Konfigurationsverzeichnis in das BPC-Installationsverzeichnis, nennen dieses in opensearch_config um und setzen den symbolischen Link auf das SSL-Verzeichnis neu.

  • Linux

  • Windows

mv opensearch/config opensearch_config
cd opensearch_config/virtimo/
rm ssl # falls symlink existiert
ln -s ../../ssl ssl
mv opensearch\config opensearch_config
mklink /J opensearch_config\virtimo\ssl ssl

Aktivieren Sie dann in der zentralen Konfigurationsdatei die folgende Zeile:

  • Linux

  • Windows

export OPENSEARCH_PATH_CONF=../opensearch_config
SET OPENSEARCH_PATH_CONF=..\opensearch_config

Karaf installieren

  1. Entpacken Sie das zu Ihrem Betriebssystem passende Karaf-Archiv in das INSTALLATIONSVERZEICHNIS.

  2. Erzeugen Sie einen Link mit dem Namen karaf, der auf das neue Verzeichnis zeigt:

    • Linux

    • Windows

    ln -s karaf-5.0/ karaf
    mklink /J karaf karaf-5.0.X

Lizenz installieren

Legen Sie Ihre Lizenzdatei im Verzeichnis INSTALLATIONSVERZEICHNIS/karaf/deploy ab.

BPC Module

Nun können die BPC-Module installiert werden.

Laden Sie dazu alle benötigten BPC Module herunter und kopieren Sie diese in das Verzeichnis INSTALLATIONSVERZEICHNIS/karaf/deploy.

Eine einfache Installation umfasst in der Regel folgende Module:

Zentrale Java Trust- und Keystores

Es wird empfohlen, zentrale Trust-/Keystores zu verwenden. Diese sind nötig, um verschlüsselte Netzwerkverbindungen einzurichten. Die Systemkomponenten sind bereits mit Beispiel-Stores ausgestattet, die eine verschlüsselte Verbindung ermöglichen. Sie sollten diese dennoch austauschen und an Ihre Bedürfnisse anpassen.

  1. Stellen Sie sich einen Java Truststore und Keystore zusammen, der alle benötigten Schlüssel und Zertifikate enthält.

    1. Sollten Sie, z.B. für einfache Tests, keinen Bedarf an eigenen Trust- und Keystores haben, können Sie die Beispiel Trust- und Keystores nutzen.

  2. Kopieren Sie diese in das Verzeichnis INSTALLATIONSVERZEICHNIS/ssl.

  3. Nehmen Sie die Konfiguration entsprechend der Anleitung zur Verwendung der zentralen Trust-/Keystores vor.

Start- und Stopp-Skripte

Wollen Sie das BPC mit einem einzelnen Skript starten und stoppen, dann können Sie diese wie folgt einrichten.

  1. Laden Sie die für ihr Betriebssystem passenden Start- und Stopp-Skripte herunter.

  2. Kopieren Sie diese in das Verzeichnis INSTALLATIONSVERZEICHNIS/bin.

Weitere Informationen zur Verwendung der Skripte siehe BPC Starten und Stoppen.

Einrichten als Betriebssystem-Service

Falls das BPC als Betriebssystem-Service eingerichtet werden soll, können Sie die Anleitung unter Services befolgen.

Abschließende Übersicht

Das INSTALLATIONSVERZEICHNIS sollte am Ende der Installation in etwa so aussehen:

Diagram

Initiale Anmeldung

Sobald Sie die Installation abgeschlossen und das BPC gestartet haben, können Sie sich anmelden.

Das BPC ist in Ihrem Browser unter http://localhost:8181/ erreichbar, wenn OpenSearch und Karaf gestartet wurden. Siehe auch BPC Starten und Stoppen.

Um sich im BPC initial anzumelden, ist standardmäßig Karaf als Identity Provider gesetzt.
Hier gibt es zwei Standard-User:

Username Bemerkung

bpcadmin

Admin-User mit der Rolle bpcadmin.

virtimo

Nur für den Zugriff auf die Karaf-Konsole.

Die Passwörter für die Standard-User werden zufällig vergeben und müssen manuell gesetzt werden (siehe Karaf als Identity Provider)!

Für das BPC können auch andere Identity Provider genutzt werden. Wie Sie diese im Einzelnen konfigurieren, lesen Sie unter Identity Provider anlegen, konfigurieren und verwenden.


Keywords: