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.

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.

Datei-Download

Die benötigten BPC-Installationsdateien können via Download - Virtimo Fileserver bezogen werden. Dort stehen diverse Dateien bereit.

Sie benötigen nicht alle aufgeführten Dateien.
Je nach Betriebssystem laden Sie unterschiedliche Dateien herunter, mehr dazu unter Erforderliche Dateien und Empfohlene Dateien.

Erforderliche Dateien

Folgende Komponenten werden für jede Installation benötigt:

Elasticsearch

Sie benötigen je nach Betriebssystem eine der folgenden Dateien:

elasticsearch_windows.zip Windows
elasticsearch_linux.tar.gz Linux und andere Unix-Systeme
elasticsearch_mac.tar.gz macOS

Karaf

Sie benötigen je nach Betriebssystem eine der folgenden Dateien:

karaf.zip Windows
karaf.tar.gz Sonstige (Linux, macOS, …)

Core

Sie benötigen beide Dateien

bpc-be-core.jar
bpc-fe-core.war

Empfohlene Dateien

Folgende Komponenten werden empfohlen:

Zentrale Konfigurationsdatei

Sie benötigen je nach Betriebssystem eine der folgenden Dateien:

bpc.env.cmd Windows
bpc.env.sh Linux, macOS und andere Unix-Systeme

Die Dokumentation zu dieser Datei finden Sie unter Zentrale Konfigurationsdatei

Monitor

Sie benötigen beide Dateien:

bpc-be-monitor.jar
bpc-fe-monitor.war

Die Dokumentation zu diesem Modul finden Sie unter Process Monitoring

Dashboard

Sie benötigen beide Dateien:

bpc-be-dashboard.jar
bpc-fe-dashboard.war

Die Dokumentation zu diesem Modul finden Sie unter Process Dashboard

Java-Laufzeitumgebung

Sie benötigen je nach Betriebssystem eine der folgenden Dateien:

jdk_windows.zip Windows
jdk_linux.tar.gz Linux und andere Unix-Systeme

Sie können auch eine eigene Java-11-kompatible Laufzeitumgebung bereitstellen.

Installation der Systemkomponenten

Im Folgenden werden die einzelnen Systemkomponenten installiert.
Das INSTALLATIONSVERZEICHNIS sollte am Ende der Installation in etwa so aussehen:

Zentrale Konfigurationsdatei

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.

Weitere Informationen finden Sie unter Zentrale Konfigurationsdatei.

Java installieren

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

Sie müssen für den Benutzer, der das BPC ausführt, die Umgebungsvariable JAVA_HOME mit dem Wert INSTALLATIONSVERZEICHNIS/jdk-* setzen. Damit stellen Sie sicher, dass Elasticsearch installieren und Karaf installieren diese Laufzeitumgebung verwenden.

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

Um zukünftige Updates von Java einfacher zu machen, können Sie auch einen symbolischen Link nutzen und auf das Java Verzeichnis zeigen lassen. In diesem Fall zeigt JAVA_HOME auf den symbolischen Link und bei einem Update wird nur der Link geändert.

Elasticsearch installieren

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

Erzeugen Sie einen symbolischen Link mit dem Namen elasticsearch, der auf das neue Verzeichnis zeigt:

UNIX Beispiel

ln -s elasticsearch-7.10.2/ elasticsearch

Windows Beispiel (Administrator Rechte werden benötigt)

mklink /D elasticsearch elasticsearch-7.10.2

Starten Sie die Komponenten wie folgt:

UNIX Beispiel

INSTALLATIONSVERZEICHNIS/elasticsearch/bin/elasticsearch -d

Windows Beispiel

INSTALLATIONSVERZEICHNIS\elasticsearch\bin\elasticsearch -d

Siehe auch https://www.elastic.co/guide/en/elasticsearch/reference/7.x/starting-elasticsearch.html

Zum Stoppen der Komponente können Sie den entsprechenden Prozess beenden:

UNIX Beispiel

kill PROZESS_ID

Windows Beispiel

taskkill /pid PROZESS_ID

Siehe auch https://www.elastic.co/guide/en/elasticsearch/reference/7.x/stopping-elasticsearch.html

Der Prozess sollte nicht forciert/hart beendet werden. Ein "hartes" Beenden des Prozesses kann zu Datenverlust führen.

Nachdem Sie den Schritt Einrichten als Betriebssystem-Service durchgeführt haben, sollten Sie ausschließlich den Service zum Starten und Stoppen verwenden.

Weitere Informationen finden Sie auf der Seite Elasticsearch.

Karaf installieren

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

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

UNIX Beispiel

ln -s karaf-4.1.6/ karaf

Windows Beispiel (Administrator Rechte werden benötigt)

mklink /D karaf karaf-4.1.6

Starten Sie die Komponenten wie folgt:

UNIX Beispiel

INSTALLATIONSVERZEICHNIS/karaf/bin/start

Windows Beispiel

INSTALLATIONSVERZEICHNIS\karaf\bin\start

Siehe auch http://karaf.apache.org/manual/latest/#_start

Zum Stoppen der Komponente können Sie Folgendes aufrufen:

UNIX Beispiel

INSTALLATIONSVERZEICHNIS/karaf/bin/stop

Windows Beispiel

INSTALLATIONSVERZEICHNIS\karaf\bin\stop

Nachdem Sie den Schritt Einrichten als Betriebssystem-Service durchgeführt haben, sollten Sie ausschließlich den Service zum Starten und Stoppen verwenden.

Siehe auch http://karaf.apache.org/manual/latest/#_stop

Weitere Informationen finden Sie unter Karaf.

BPC Module

Nun können die BPC-Module installiert werden.

Kopieren Sie bitte mindestens die Dateien für folgende Module in das Verzeichnis INSTALLATIONSVERZEICHNIS/karaf/deploy.

core
dashboard
monitor

BPC-Module erkennen Sie am Dateinamen. Die meisten Module bestehen dabei aus zwei Teilen mit jeweils einer Datei. Es gibt jedoch Ausnahmen, bei denen nur eine der beiden Dateien benötigt wird.

Die Dateinamen entsprechen einem der beiden Schemata:

bpc-fe-MODULID.war
bpc-be-MODULID.jar

Zusätzlich muss nun auch Ihre Lizenz (bpc-be-license.jar) in das Verzeichnis INSTALLATIONSVERZEICHNIS/karaf/deploy eingefügt werden.

Einrichten als Betriebssystem-Service

Die beiden Systemkomponenten sollten Sie nun als Service einrichten, damit diese automatisch mit dem Server gestartet und auch gestoppt werden.

Siehe dazu: Services

Anschließend sollten Sie die Systemkomponenten nur noch über die jeweiligen Services starten und stoppen.

Initiale Anmeldung

Sobald Sie die Installation abgeschlossen haben, können Sie mit der Konfiguration fortfahren.

Das BPC ist in Ihrem Browser unter https://localhost:8181/ erreichbar, wenn Elasticsearch und Karaf gestartet wurden.

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

Username Bemerkung

Username	Bemerkung
`bpcadmin`	Admin-User mit der Rolle bpcadmin.
`root`	Admin-User mit der Rolle bpcadmin.
`virtimo`	Nur für den Zugriff auf die Karaf-Konsole.

bpcadmin

Admin-User mit der Rolle bpcadmin.

root

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: