Java-VM und -Wrapper (fs-wrapper*.conf)

Tanuki Java Service Wrapper

Der Tanuki Java Service Wrapper umschließt die Java Virtual Machine (Java VM) von FirstSpirit. Über den Wrapper wird die Java VM gestartet und beendet.

Steuerung

Start und Stopp des Wrappers erfolgt über die Steuerungsdatei fs-server (Unix) bzw. fs-server.bat (Windows):

• Steuerung des Servers (Windows)
• Steuerung des Servers (Unix)

Protokollierung

Der Wrapper prüft zur Laufzeit des FirstSpirit-Prozesses regelmäßig die Erreichbarkeit der FirstSpirit Java VM und protokolliert Auffälligkeiten zur Java VM in einem eigenen Logfile (fs-wrapper.log).

Hier werden sowohl längere Wartezeiten auf die Java VM protokolliert als auch alle Ausgaben, die von der Java VM auf die Konsole erfolgen würden. Wie zum Beispiel die Ausgaben, die bis zur Initialisierung des LoggingManagers beim Start des FirstSpirit Servers ausgegeben werden.

Aktualisierung des Wrappers

Der Wrapper wird in unregelmäßigen Abständen von Crownpeak aktualisiert. Eine Aktualisierung kann mehrere Gründe haben, u.a.:

• Korrektur von Fehlern im Wrapper,
• Sicherheitsaktualisierungen,
• Unterstützung neuer Java-Versionen,
• Unterstützung von Betriebssystemänderungen.

Eine zeitnahe Aktualisierung des „Java Service Wrappers“ in bestehenden FirstSpirit-Installation wird empfohlen.

Die Version des Tanuki 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 gemäß „FirstSpirit aktualisieren (→Installationsanleitung)“ aktualisiert werden.

Die Aktualisierung eines FirstSpirit-Servers durch Austausch der FirstSpirit-Server-Datei fs-isolated-server.jar führt nicht zu einer Aktualisierung des verwendeten Java Service Wrappers.

Vor der Aktualisierung des Wrappers muss der FirstSpirit-Server beendet werden. Alle Clients, die am Server angemeldet sind, sollten vor der Aktualisierung des Wrappers und vor dem Beenden des Servers ebenfalls beendet werden, um Datenverluste zu vermeiden. Dazu kann der Wartungsmodus genutzt werden.

Konfiguration

Konfigurationsdateien

Im Unterverzeichnis conf des FirstSpirit-Servers befinden sich Dateien, die wichtige Konfigurationseinstellungen für den Serverstart und das Java-System des FirstSpirit-Servers enthalten. Diese Konfigurationsdateien sind zuständig für Start und Stop des Java-Prozesses und enthalten Parameter zur optimalen Ausnutzung des Hauptspeichers des Host-Betriebssystems.

Folgende Dateien können vorhanden sein:

• die Datei fs-wrapper-vendor.conf
  enthält die empfohlenen Hersteller-Startoptionen der Java VM.
• die Datei conf/fs-wrapper.conf 
  enthält nur die Startoptionen, die serverspezifisch angepasst werden sollten
  (Konfiguration der Java VM für Non-Isolated-Installationen)
• die Datei conf/fs-wrapper.isolated.conf 
  enthält nur die Startoptionen, die serverspezifisch angepasst werden sollten.
  (Konfiguration der Java VM für Isolated-Installationen)
• die Datei conf/fs-wrapper.slave.conf 
  (allgemeine Konfiguration der Java VM für Cluster-Knoten für Non-Isolated-Installationen)
• die Datei fs-wrapper.isolated.slave.conf
  (allgemeine Konfiguration der Java VM für Cluster-Knoten für Isolated-Installationen)
• die Datei conf/fs-wrapper-j1.include.conf 
  (Konfiguration spezieller Startparameter für Oracle Java 8)
  (obsolet nach Umstellung auf die neue Konfiguration)
• die Datei conf/fs-wrapper-j2.include.conf 
  (Konfiguration spezieller Startparameter für Oracle Java Versionen >= 9)
  (obsolet nach Umstellung auf die neue Konfiguration)

Einige Dateien sind nur relevant für den Einsatz mit bestimmten Java-Versionen (siehe Abhängigkeit zur Java-Version).

Die Konfigurationsdatei fs-wrapper-vendor.conf ist Bestandteil des FirstSpirit Aktualisierungsarchivs fs-update-[version].tar.gz. Bei der Aktualisierung des FirstSpirit-Servers über das Aktualisierungsarchiv fs-update-[version].tar.gz werden die Startoptionen automatisch aktualisiert. Damit sind diese Konfigurationsanpassungen ohne manuelle Anpassung auch für bestehende FirstSpirit-Installationen verfügbar (ohne die serverspezifisch angepassten Werte durch eine Aktualisierung zu überschreiben).
Weiterführende Dokumentation siehe FirstSpirit aktualisieren (→Installationsanleitung).

Die Konfigurationsdatei fs-wrapper-vendor.conf sollte nicht geändert werden. Sollte es in Einzelfällen notwendig sein, die empfohlenen Hersteller-Startoptionen anzupassen, sollten die entsprechenden Startparameter in der Konfigurationsdatei fs-wrapper[.isolated].conf erneut definiert werden (und nicht in der fs-wrapper-vendor.conf überschrieben werden).

Hinweise zu unterstützten Java-Versionen siehe Technische Voraussetzungen und Empfehlungen und FirstSpirit Release Notes.

Standardkonfiguration

Die Dateien enthalten initial bei der Installation eine von Crownpeak vorgegebene Standardkonfiguration, die auf maximale Kompatibilität mit vielen FirstSpirit-Installationen ausgelegt sind. Diese sollten aber in Abhängigkeit von den Anforderungen und Bedürfnissen von produktiven Kunden-Installationen optimiert werden. Dazu sollte Beratung durch Java-Experten, betreuende Partner-Unternehmen oder Crownpeak selbst in Anspruch genommen werden.

Eine vollständige Beschreibung aller Parameter des Java-Wrappers und weiterführende Informationen finden Sie unter:
http://wrapper.tanukisoftware.org/doc/english/properties.html. 

Änderung der Konfigurationsdateien

Änderungen an diesen Konfigurationsdateien können teilweise über das FirstSpirit ServerMonitoring vorgenommen werden (siehe Startoptionen). Die Änderungen werden dann in die Konfigurationsdatei geschrieben und auf dem Server aktualisiert. Werden ungültige Konfigurationen vorgenommen, wird beim Speichern der Konfiguration im ServerMonitoring auf den Fehler hingewiesen, und der Speichervorgang wird nicht ausgeführt:

unexpected configuration property key 'wrapper.startUp.timeout' in line 76

Alternativ können Änderungen an den Konfigurationsdateien auch direkt an den Dateien im Dateisystem erfolgen.

Die Reihenfolge der Parameter in der Datei ist beliebig.

Im Folgenden werden einige Parameter beispielhaft erläutert.

• Konfiguration der Java-VM
• Allgemeine Java-Parameter
• Parameter des Java-Wrappers
• Protokollierung (Log-Files)
• IPv6-Unterstützung
• Systemdienst unter Windows
• Sonstige Parameter

Bei allen Änderungen der Konfigurationsdateien ist ein Neustart des Servers erforderlich.

Innerhalb der Konfigurationsdateien dürfen Kommentare nicht in einer Zeile mit Parameter-Werten stehen, z. B.:                                         wrapper.startup.timeout=30 # Kommentar

Abhängigkeit zur Java-Version

Einige Konfigurationseinstellungen für den Serverstart sind abhängig von der eingesetzten Java-Version.

Das bedeutet, eine aktuelle Java-Version unterstützt andere Parameter als eine ältere Java-Version, und umgekehrt.

Informationen zur Versionsabhängigen Konfiguration siehe (Java-) Versionsabhängige Konfiguration.