BPC Konfigurationsdatei

Diverse Einstellungen des BPCs werden über die Konfigurationsdatei INSTALLATIONSVERZEICHNIS/karaf/etc/de.virtimo.bpc.core.cfg festgelegt.
Im Folgenden werden diese Einstellungen vorgestellt und beschrieben.

Wenn Sie Änderungen an diesen Parametern durchführen wollen, empfehlen wir dringend, dies über die Zentrale Konfigurationsdatei zu tun. Siehe dazu Werte von etc-Dateien überschreiben.

Allgemein

Parameter Default

de.virtimo.bpc.core.version
Enthält die genaue Versionsnummer des BPC Backend Core Moduls.
Kann und sollte nicht geändert werden.

-

de.virtimo.bpc.core.name
Sprechender Name dieses Servers im Cluster.

BPC

de.virtimo.bpc.core.karaf.uuid
Enthält eine eindeutige ID zur Identifizierung dieses Servers im Cluster.
Wird beim Start automatisch erzeugt und gesetzt, wenn nicht vorhanden.

Nicht gesetzt

de.virtimo.bpc.core.forceLocalIdentityProvider
Falls der momentan eingestellte Identity Provider nicht erreichbar bzw. falsch konfiguriert ist, dann kann vorübergehend der lokale Identity Provider (user.properties) aktiviert werden.

false

de.virtimo.bpc.core.encryption.key
Der Schlüssel, der zum Verschlüsseln/Entschlüsseln von Passwörtern (z.B. von Backend-Verbindungen) verwendet wird, die im OpenSearch-Index gespeichert sind.

  • Wenn Sie diesen Schlüssel ändern, werden die bestehenden Passwörter ungültig.

  • Stellen Sie sicher, dass Sie auf allen Servern Ihres Clusters denselben Schlüssel verwenden.

virtimo_berlin

de.virtimo.bpc.core.systemchecker.interval
Legt das Intervall in Sekunden fest, in dem das System z.B. den verfügbaren Festplattenplatz überprüft.

30 Sekunden

de.virtimo.bpc.core.cookieName
Legt den Namen des vom BPC erzeugten Cookie fest.

BPC_J_S

de.virtimo.bpc.core.cookieSecure
Legt fest, ob das vom BPC erzeugte Cookie (das sogenannte 'secure'-Flag) gesetzt werden soll oder nicht.

false

de.virtimo.bpc.core.os-bpc-plugin.retryInterval
Der BPC-Backend-Core stellt eine Websocket-Verbindung zum BPC-Plugin, welches im OpenSearch läuft, her. Wenn diese Verbindung unterbrochen wurde, dann wird nach der angegebenen Zeit wieder versucht, eine Verbindung herzustellen.

5 Sekunden

de.virtimo.bpc.core.percolatorschecker.intervalInMinutes
Zeitangabe, nach der ungültige bzw. nicht mehr valide Percolatoren gelöscht werden sollen.

60 Minuten

de.virtimo.bpc.core.ipPinningCheck
+ Definiert, ob ein IP Pinning Check durchgeführt wird. Hierbei wird bei jeder Benutzeranfrage geprüft, ob die übermittelte IP-Adresse mit der vom Login übereinstimmt. Falls ein HTTP Proxy zum Einsatz kommt, dann Bitte darauf achten, dass ein HTTP Header wie X-Forwarded-For gesetzt wird.

true

de.virtimo.bpc.core.ipPinningCheck.httpHeader
Falls ein HTTP Proxy zum Einsatz kommt, dann hier den Namen des verwendeten HTTP Header setzen, unter dem die IP-Adresse des Benutzers zu finden ist. Es wird empfohlen sich an den Quasi-Standard X-Forwarded-For zu halten.

X-Forwarded-For

OpenSearch

Für den Zugriff auf die zu verwendende OpenSearch Installation.

Parameter (Möglichkeit 1) Default

de.virtimo.bpc.core.opensearch.host
Der Hostname bzw. die IP-Adresse, unter welcher OpenSearch zu erreichen ist.

localhost

de.virtimo.bpc.core.opensearch.port
Der Port, unter welchem OpenSearch zu erreichen ist.

9200

de.virtimo.bpc.core.opensearch.scheme
Das Schema, das beim Zugriff auf OpenSearch verwendet werden soll.
Entweder http oder https.

http
Parameter (Möglichkeit 2) Default

de.virtimo.bpc.core.opensearch.hosts
Falls dieser Parameter verwendet wird, dann werden die 3 Parameter der 'Möglichkeit 1' ignoriert. Hier können auch multiple OpenSearch Nodes, durch Kommata getrennt, angegeben werden. Beispiel: https://server1.example.com:9200, https://server2.example.com:9200, https://server3.example.com:9200

Nicht gesetzt
Parameter Default

de.virtimo.bpc.core.opensearch.username
Falls das OpenSearch per Username/Passwort-Zugriff geschützt ist, dann kann hier der Benutzername hinterlegt werden.

Nicht gesetzt

de.virtimo.bpc.core.opensearch.password
Falls das OpenSearch per Username/Passwort-Zugriff geschützt ist, dann kann hier das Passwort hinterlegt werden.

Nicht gesetzt

Wartungsmodus

Siehe auch Wartungsmodus.

Parameter Default

de.virtimo.bpc.core.maintenancemode
Zur Aktivierung/Deaktivierung des Wartungsmodus.
Bei true ist der Wartungsmodus aktiviert.
Bei false ist er deaktiviert.

Default ist false.

de.virtimo.bpc.core.maintenancemode.fileSystemLimitInMB
Die Einheit ist MB.
Steht weniger Festplattenplatz zur Verfügung, dann wird der Wartungsmodus aktiviert.
Dieser Wert sollte auf den gleichen Wert wie cluster.routing.allocation.disk.watermark.low aus der opensearch.yml gesetzt werden.

10240

de.virtimo.bpc.core.maintenancemode.message
Optional kann eine Wartungsmodus-Meldung festgelegt werden, die dem Benutzer bei der Anmeldung angezeigt wird.

Nicht gesetzt

Metrics-Schnittstelle (Prometheus)

Die Metrics-Schnittstelle ist per Basic Authentication (Benutzername/Passwort) geschützt und kann nicht ohne aufgerufen werden.

Siehe auch System Monitoring (Metriken für Prometheus).

Parameter Default

de.virtimo.bpc.metrics.basic_auth.username
Der Benutzername für den Zugriff auf den Metrics-Endpunkt.

virtimo

de.virtimo.bpc.metrics.basic_auth.password
Das Passwort für den Zugriff auf den Metrics-Endpunkt.
Falls nicht gesetzt, wird beim Start ein zufälliges Passwort erzeugt und gesetzt.

Nicht gesetzt

Performance Metriken

Im OpenSearch-Index bpc-performance werden diverse Performance-Metriken des Frontends gesammelt. Dieser Index wird periodisch gesäubert.

Parameter Default

de.virtimo.bpc.core.performance.cleanupPeriodInMinutes
Zeitangabe, nach der der Säuberungslauf (wieder) gestartet werden soll.

60 Minuten (heißt: alle 60 Minuten)

de.virtimo.bpc.core.performance.deleteEntriesOlderThan
Zeitangabe, bei der ältere Einträge bei einem Säuberungslauf aus dem Index gelöscht werden sollen.

4 weeks ago

Audit Logger

Legt die Konfiguration der Audit-Logger fest.
Der 'OpenSearchAuditLogger' wird vom BPC-Backend-Core verwendet und nachfolgend konfiguriert. Falls ein Bundle einen eigenen Logger verwendet, dann sind die Einträge zu duplizieren und dabei 'OpenSearchAuditLogger' dementsprechend durch den eigenen Namen zu ersetzen.

Siehe auch Audit Log Service.

Parameter Default

de.virtimo.bpc.core.auditlog.OpenSearchAuditLogger.auditlog.level
Zur Festlegung des Log-Levels.
Zulässige Werte: DEBUG, INFO, WARNING, ERROR

INFO

de.virtimo.bpc.core.auditlog.OpenSearchAuditLogger.auditlog.cleanupPeriodInMinutes
Zeitangabe in Minuten, nach der der Säuberungslauf periodisch gestartet werden soll.

-1 (deaktiviert)

de.virtimo.bpc.core.auditlog.OpenSearchAuditLogger.auditlog.deleteEntriesOlderThan
Zeitangabe, bei der ältere Einträge bei einem Säuberungslauf aus dem Index bpc-auditlog gelöscht werden sollen.
Beispiel: 1 year ago

Nicht gesetzt (deaktiviert)

de.virtimo.bpc.core.auditlog.OpenSearchsearchAuditLogger.auditlog.backupEnabled
Legt fest, ob periodisch Backups vom bpc-auditlog-Index erstellt werden sollen.

true

de.virtimo.bpc.core.auditlog.OpenSearchsearchAuditLogger.auditlog.backupIntervalInSeconds
Legt das Intervall fest, in dem das Backup durchgeführt werden soll.

86400 Sekunden (heißt: alle 24 Stunden)

de.virtimo.bpc.core.auditlog.OpenSearchsearchAuditLogger.auditlog.keepBackupsDurationInSeconds
Legt fest, wie lange die Backups aufbewahrt werden sollen.
Ältere Backups werden gelöscht.

2592000 Sekunden (30 Tage)
Keywords:
Press Esc to exit full screen
Modal image placeholder
Press Esc to exit full screen