Wartungsmodus

Das BPC wird automatisch in einen Wartungsmodus versetzt, wenn der Festplattenplatz knapp wird. Ist der Wartungsmodus aktiv, dann wird unter anderem die Replikation gestoppt. Der Rest läuft ganz normal weiter. Die Grenze wird alle 30 Sekunden überprüft und es wird nur der freie Festplattenplatz der Rechner geprüft, auf denen OpenSearch installiert ist. Genauer gesagt: Es werden die Partitionen, auf welchen OpenSearch seine Daten ablegt, überprüft.

Der Wartungsmodus muss manuell deaktiviert werden.

Was passiert bei aktiviertem Wartungsmodus?

  • die Replikation wird gestoppt

  • es werden keine Backups der OpenSearch Indices durchgeführt

  • die Log Service Endpunkte können nicht benutzt werden

Status-Abfrage

Es gibt mehrere Möglichkeiten der Status-Abfrage:

  • über die BPC-Weboberfläche auf der Statusseite

  • über das Karaf-Konsole Kommando: bpc:maintenance-mode status

  • über die JSON-Statusseite (https://localhost:8181/cxf/bpc-core/status). Dort ist der Wert maintenanceModeEnabled entweder true oder false.

  • über die Statuscode-Seite (https://localhost:8181/cxf/bpc-core/status/maintenance). Diese liefert entweder den HTTP Statuscode 200 (deaktiv) oder 503 (aktiv).

  • die Prometheus Schnittstelle liefert eine bpc_maintenance_mode_enabled Metrik (1=aktiviert; 0=deaktiviert)

Manuelle Aktivierung/Deaktivierung

Über die Statusseite kann der Wartungsmodus (de)aktiviert werden.

maintenance mode1

Alternativ kann der Wartungsmodus auch über die Karaf-Konsole aktiviert/deaktiviert werden:

Wartungsmodus aktivieren
virtimo@virtimo()> bpc:maintenance-mode on
Wartungsmodus deaktivieren
virtimo@virtimo()> bpc:maintenance-mode off

Einstellmöglichkeiten

Festplatten-Limit

Die Einheit ist MB und die Voreinstellung beträgt 10240. Steht weniger Festplattenplatz zur Verfügung, dann wird der Wartungsmodus aktiviert und die Replikation gestoppt. Über die Karaf-Konsole kann die Anpassung vorgenommen werden. In den unten stehenden Schritten wird das Limit auf 4096 MB gesetzt.

Festplatten-Limit auf 4096 MB gesetzt
virtimo@virtimo()> config:edit de.virtimo.bpc.core
virtimo@virtimo()> config:property-set de.virtimo.bpc.core.maintenancemode.fileSystemLimitInMB 4096
virtimo@virtimo()> config:update

Es hat sich gezeigt, dass de.virtimo.bpc.core.maintenancemode.fileSystemLimitInMB auf den gleichen Wert wie die OpenSearch Option cluster.routing.allocation.disk.watermark.low in der <OpenSearch-Verzeichnis>/config/opensearch.yml gesetzt sein sollte.

Meldung

Optional kann eine Wartungsmodus-Meldung festgelegt werden, die dem Benutzer bei Anmeldung angezeigt wird.

Werden OIDC oder Keycloak als Identity Provider verwendet, dann wird die Meldung nicht angezeigt.

Meldung setzen
virtimo@virtimo()> config:edit de.virtimo.bpc.core
virtimo@virtimo()> config:property-set de.virtimo.bpc.core.maintenancemode.message "Achtung, noch bis 14:30 Uhr werden Wartungsarbeiten durchgeführt."
virtimo@virtimo()> config:update

Oder bei Aktivierung des Wartungsmodus per Karaf-Konsole Kommando.

Wartungsmodus aktivieren und Meldung setzen
virtimo@virtimo()> bpc:maintenance-mode -m "Achtung, noch bis 14:30 Uhr werden Wartungsarbeiten durchgeführt." on

Intervall

Das Intervall hat eine Voreinstellung von 30 Sekunden und kann bei Bedarf angepasst werden. Danach muss momentan noch der Karaf neu gestartet werden. Über die Karaf-Konsole kann die Anpassung vorgenommen werden. In den unten stehenden Schritten wird das Intervall auf 60 Sekunden gesetzt.

Intervall auf 60 Sekunden setzen
virtimo@virtimo()> config:edit de.virtimo.bpc.core
virtimo@virtimo()> config:property-set de.virtimo.bpc.core.systemchecker.interval 60
virtimo@virtimo()> config:update

Einstellungen überprüfen

virtimo@virtimo()> config:edit de.virtimo.bpc.core
virtimo@virtimo()> config:property-list
  ...
   de.virtimo.bpc.core.maintenancemode = false
   de.virtimo.bpc.core.maintenancemode.fileSystemLimitInMB = 10240
   de.virtimo.bpc.core.maintenancemode.message =
  ...
virtimo@virtimo()> config:cancel

Keywords: