Steuerung des FirstSpirit-Servers unter Windows-Betriebssystemen

Allgemeine Informationen

Voraussetzungen für den Betrieb eines FirstSpirit-Servers sind Java, der Java Service Wrapper und die entsprechenden Steuerungsdateien zum Starten und Stoppen des FirstSpirit-Servers (bzw. der Java JVM).

Die gewünschten Aktionen, u.a.:

• Start des FirstSpirit-Servers,
• Stopp des FirstSpirit-Servers,
• Neustart des FirstSpirit-Servers,
• Erzeugen von Thread Dumps, ...

werden über die Steuerungsdatei fs-server.bat an die JVM weitergegeben.

Bereitstellung der Steuerungsdateien

Bereitstellung über das Aktualisierungsarchiv fs-update-[version].tar.gz

Der Java Service Wrapper und die zugehörige, aktuelle Version der Steuerungsdateien werden von Crownpeak über das Aktualisierungsarchiv (für bestehende Installationen) bereitgestellt.

Das Archiv ist per Download erhältlich (für Zugangsdaten wenden Sie sich bitte an den Technical Support).

Die Steuerungsdateien (fs-server und fs-server.bat) dürfen nicht verändert werden.

Entpacken des Archivs im Installationsverzeichnis

Das Archiv muss zunächst im vorhandenen FirstSpirit-Server-Installationsverzeichnis ausgepackt werden.

Dazu wird das Archiv zunächst mit einem Zip-Tool wie 7-zip oder IZArc entpackt. Anschließend muss der Inhalt der erhaltenen .tar-Datei ebenfalls entpackt werden.

Nach dem Auspacken sollten die Benutzer- und Gruppenrechte der ausgepackten Dateien betrachtet und ggfs. angepasst werden.

Schritt 1) Wartungsmodus aktivieren

Alle Clients sollten vor Beginn der Aktionen abgemeldet sein.

Vor dem Starten und Stoppen des FirstSpirit-Servers kann der Wartungsmodus aktiviert werden.

Schritt 2) Die Steuerungsdatei fs-server.bat

Im Installations- bzw. Aktualisierungsarchiv ist aktuell jeweils eine Steuerungsdatei für Linux und Windows enthalten.

(Die Steuerungsdateien fs-server wird ausschließlich für Linux-Betriebssysteme benötigt - siehe Steuerung unter Linux).

Der Funktionsumfang der Steuerungsdatei fs-server.bat:

• console: Starten des FirstSpirit-Servers in der aktuellen Konsole.
• start: Starten des FirstSpirit-Servers über einen Windows-Systemdienst.
  Um das Kommando zu verwenden, muss der FirstSpirit-Server zunächst als Windows-Systemdienst installiert werden (siehe install).
• stop: Stoppen des FirstSpirit-Servers über einen Windows-Systemdienst.
  Um das Kommando zu verwenden, muss der FirstSpirit-Server zunächst als Windows-Systemdienst installiert werden (siehe install).
• restart: Neustart des FirstSpirit-Servers über einen Windows-Systemdienst.
  Um das Kommando zu verwenden, muss der FirstSpirit-Server zunächst als Windows-Systemdienst installiert werden (siehe install).
• status: Ausgabe des aktuellen Status des FirstSpirit-Servers.
• install: Installiert den FirstSpirit-Server als Windows-Systemdienst.
• installstart: Installiert den FirstSpirit-Server als Windows-Systemdienst und startet anschließend den FirstSpirit-Server.
• remove: Deinstalliert den FirstSpirit-Server als Windows-Systemdienst.
• setup: Registriert den Java Service Wrapper im Windows-Event-Log.
  Der Loglevel wird über den Parameter wrapper.syslog.loglevel= definiert und sollte nicht zu hoch gesetzt werden (siehe wrapper.syslog.*).
• teardown: Deregistriert den Java Service Wrapper wieder vom Windows-Event-Log.

Für die Verwendung der Steuerungsdatei fs-server.bat ist ein Java Service Wrapper ab Version 3.5.42 notwendig:

• Mit dem FirstSpirit Aktualisierungsverzeichnis erhalten sie immer eine aktuelle Version des Wrappers sowie die dazu passenden Steuerungsdateien.
• Die Version des Java Service Wrappers, die auf dem Server aktuell verwendet wird, kann über das FirstSpirit ServerMonitoring ermittelt werden. Unter ServerMonitoring - Übersicht - Status wird unter „Grundinformationen (System)“ die „Wrapper-Version“ eingeblendet.
• Entspricht die verwendete Wrapper-Version nicht der vom FirstSpirit-Server empfohlenen, wird dies durch rote Schrift und den Zusatz veraltet angezeigt. In der Datei fs-wrapper.log wird dies ebenfalls festgehalten.
  In diesem Fall sollte der Java Service Wrapper zeitnah aktualisiert werden (siehe dazu Das FirstSpirit-Backend aktualisieren).

Schritt 3a) Server steuern über einen Windows-Systemdienst (empfohlen)

Dienst installieren und Server starten

Unter Microsoft-Windows-Betriebssystemen kann der FirstSpirit-Servers über einen Windows-Systemdienst gestartet werden.

Dazu unter Windows die Kommandozeile öffnen und in den Ordner ~FS/bin wechseln und den Windows-Systemdienst über den folgenden Aufruf installieren und starten:

~FS\bin\fs-server installstart

~FS ist hier das Installationsverzeichnis für den FirstSpirit-Server.

Für den Aufruf von fs-server installstart werden unter Windows Administratorenrechte benötigt.

Hinweis: Bei Namensänderung des Windows-Systemdienstes: muss der Service mit dem alten Namen zunächst deinstalliert werden: ~FS\bin\fs-server remove Anschließend muss der Dienst mit dem neuen Namen installiert werden: ~FS\bin\fs-server install

Alle Subkommandos können anschließend über den Windows-Systemdienst oder über die Kommandozeile nach der folgenden Syntax ausgeführt werden:

~FS\bin\fs-server [reload|restart|start|status|stop|...]

z. B. Starten des FirstSpirit-Servers:

~FS\bin\fs-server start

Konfiguration des Windows-Systemdienstes

Die Konfiguration des Windows-Dienstes in der Datei fs-wrapper.isolated.conf kann über die Parameter wrapper.ntservice.* angepasst werden (siehe wrapper.java.command).

Schritt 3b) Server steuern ohne einen Windows-Systemdienst

Alternativ kann der FirstSpirit-Server über folgenden Aufruf in der aktuellen Konsole gestartet werden (ohne Nutzung eines Systemdienstes):

~FS\bin\fs-server console

Der Server kann über das Konsolenfenster mit der Tastenkombination Strg+C beendet werden.

Alle Subkommandos können anschließend über die Kommandozeile nach der folgenden Syntax ausgeführt werden:

~FS\bin\fs-server [reload|restart|start|status|stop|...]

Schritt 3c) Server neustarten über das FirstSpirit ServerMonitoring

Eine einfache Steuerung des FirstSpirit-Servers ist auch über das FirstSpirit ServerMonitoring möglich. Unter ServerMonitoring - FirstSpirit - Steuerung kann der FirstSpirit Server neugestartet werden.

Die Steuerung ermöglicht an dieser Stelle aber keine weiteren Kommandos (wie die Steuerungsdateien) und keine Logausgaben oder Benachrichtigungen.

Schritt 4) Fehlerdiagnose und Monitoring

Protokollierung / Logdateien

Falls während bzw. nach dem Start des FirstSpirit-Servers Probleme auftreten, liefern die Logdateien fs-server.log und fs-wrapper.log unter ~FS/log detaillierte Hinweise zur Problemursache.

Kann die Java VM nicht gestartet werden, wird nur die fs-wrapper.log aktualisiert.

Für eine weiterführende Analyse und Auswertung der Logdateien können sie sich auch an den Technical Support wenden.

Threaddumps erzeugen und analysieren

Eine weitere Analysemöglichkeit bietet das FirstSpirit ServerMonitoring. Die über die Funktionalität Threads erstellten Thread Dumps können hier analysiert und in einer aufbereiteten Ansicht angezeigt werden.

Status des Dienstes ausgeben

Statusinformationen zum Dienst können über den Befehl:

~FS\bin\fs-server.service status 

ausgegeben werden.

Runlevel

Beim Start eines FirstSpirit-Servers stehen Informationen über den aktuellen Runlevel zur Verfügung.

Die Runlevel werden an verschiedenen Stellen ausgegeben:

• als Logausgabe in der Datei fs-server.log bzw. fs-wrapper.log
• als Wert [Zahl] in der Datei ~FS/.fs.lock

Anhand dieser Runlevels kann abgelesen werden, ob bzw. wann welche Server-Funktionalität zur Verfügung steht:

• SHUTDOWN (RunLevel 0)
  Der Server ist heruntergefahren.
  Hinweis: Die Datei ~FS/.fs.lock ist in diesem Runlevel nicht vorhanden.
• IN_PROGRESS (RunLevel 20)
  Der Server startet bzw. wird beendet, es sind keine Funktionalitäten sicher verfügbar.
• CORE_STARTED (RunLevel 40)
  Die Grundfunktionalitäten stehen zur Verfügung, der Server kann über den SOCKET-Port erreicht werden.
• ROOT_WEBAPP_STARTED (RunLevel 60)
  Der Server kann nun auch über den HTTP-Port erreicht werden.
• CORE_WEBAPPS_STARTED (RunLevel 80)
  Die globalen Web-Anwendungen stehen zur Verfügung.
• STARTED (RunLevel 100)
  Alle FirstSpirit-Funktionalitäten stehen zur Verfügung.

Auf diese Runlevel kann beispielweise per API reagiert werden (Interface RunLevelAgent, Package de.espirit.firstspirit.agency, FirstSpirit Access-API).