Administration und Konfiguration unter Linux: Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
Zeile 61: Zeile 61:
 
;ies-server.xml: Zentrale Konfigurationsdatei des [[IES]]. Bei manuellen Änderungen dieser Datei muss sie über IES-Admin neu eingelesen werden
 
;ies-server.xml: Zentrale Konfigurationsdatei des [[IES]]. Bei manuellen Änderungen dieser Datei muss sie über IES-Admin neu eingelesen werden
 
:Eine beispielhafte Konfiguration kann [[IES_Konfiguration#Beispiel_einer_ies-server.xml|hier]] eingesehen werden.
 
:Eine beispielhafte Konfiguration kann [[IES_Konfiguration#Beispiel_einer_ies-server.xml|hier]] eingesehen werden.
;sitepark.conf: Enthält Konfigurationen für das Init-Script (<code>/etc/init.d/ies</code>):
+
;sitepark.conf: Enthält Konfigurationen für das Systemd-Script:
 
:;SITEPARK_HOME: Installations-Verzeichnis des IES
 
:;SITEPARK_HOME: Installations-Verzeichnis des IES
 
:;JAVA_HOME: Vom IES verwendete Java-Installation
 
:;JAVA_HOME: Vom IES verwendete Java-Installation
:;JBOSS_HOME: Vom IES verwendete JBoss-Installation
 
 
:;IES_PID_FILE: Name und Pfad der Datei, in der die PID des IES-Prozesses geschrieben werden soll
 
:;IES_PID_FILE: Name und Pfad der Datei, in der die PID des IES-Prozesses geschrieben werden soll
 
:;IES_MEM_MAX: Maximaler Speicher, der für den Java-Heap angefordert werden darf
 
:;IES_MEM_MAX: Maximaler Speicher, der für den Java-Heap angefordert werden darf
 
:;IES_MEM_INIT: Speicher, der Initial für den Java-Heap angefordert wird
 
:;IES_MEM_INIT: Speicher, der Initial für den Java-Heap angefordert wird
 
:;IES_PERM_MAX: Maximaler Speicher, der für den Java-Non-Heap angefordert werden darf
 
:;IES_PERM_MAX: Maximaler Speicher, der für den Java-Non-Heap angefordert werden darf
:;IES_INIT_OUTPUT: Log-Datei, in der die Konsolen-Ausgaben des IES-Prozesses gelenkt werden
+
:;IES_MIN_HEAD_RATIO: Steuerung des Speicherverhaltens der JVM
:;IES_LOG_ROTATE: Log-Rotating Steuerung für <code>IES_INIT_OUTPUT</code>. Der Schalter <code>-l</code> gibt die Maximalen Zeilen einer Log-Datei an. Der Schalter <code>-n</code> gibt die Anzahl der maximalen Log-Dateien an
+
:;IES_MAX_HEAD_RATIO: Steuerung des Speicherverhaltens der JVM
 
:;IES_USER: Nutzer, unter dem der IES gestartet wird
 
:;IES_USER: Nutzer, unter dem der IES gestartet wird
 
:;IES_LANG: Standard-Sprache, mit der der IES läuft
 
:;IES_LANG: Standard-Sprache, mit der der IES läuft
 
:;IES_UMASK: umask Setzungen für den Nutzer des IES
 
:;IES_UMASK: umask Setzungen für den Nutzer des IES
:;IES_BIND_ADDRESS: Die IP, auf die der JBoss gebunden werden soll. Standardmäßig ist dort <code>localhost</code> konfiguriert, um das System von Außen zu schützen. Wird dort <code>0.0.0.0</code> konfiguriert, so ist der Zugriff über das Netzwerk möglich. Informationen hierzu finden Sie auch unter [[:Kategorie:Installation]]
+
:;IES_BIND_ADDRESS: Die IP, auf die der IES gebunden werden soll. Standardmäßig ist dort <code>localhost</code> konfiguriert, um das System von Außen zu schützen. Wird dort <code>0.0.0.0</code> konfiguriert, so ist der Zugriff über das Netzwerk möglich. Informationen hierzu finden Sie auch unter [[:Kategorie:Installation]]
 
:;IES_IMGFILE_DEFAULT_PROVIDER: Konfiguration der Bildberechnungsroutine. Mögliche Werte sind <code>gfx</code> (Standard unter Linux; Eigenentwicklung von Sitepark), <code>gfxcmd</code> Aufruf der Bibliothek in einem eigenen Prozess (gfx muss konfiguriert sein), <code>imagemagick</code>
 
:;IES_IMGFILE_DEFAULT_PROVIDER: Konfiguration der Bildberechnungsroutine. Mögliche Werte sind <code>gfx</code> (Standard unter Linux; Eigenentwicklung von Sitepark), <code>gfxcmd</code> Aufruf der Bibliothek in einem eigenen Prozess (gfx muss konfiguriert sein), <code>imagemagick</code>
 
;version.properties: Enthält die aktuelle Versionsnummer des IES
 
;version.properties: Enthält die aktuelle Versionsnummer des IES

Version vom 21. September 2022, 08:47 Uhr

Unter Linux sind keine graphischen Werkzeuge vorgesehen, da Linuxserver i.d.R. lediglich über die Console administriert werden. Typischerweise gibt es hier zum einen ein Init-Script, sowie einen Ordner mit Konfigurationen unter /etc.

Init-Script /etc/init.d/ies

Unter Linux wird der IES-Prozess über das Init-Script /etc/init.d/ies mit Hilfe des Parameters start gestartet und mit dem Parameter stop gestoppt.

Unter Linux wird ein übermäßiges Anwachsen der Logdatei $SITEPARK_HOME/ies.out durch Log-Rotating mit Hilfe des Scripts $SITEPARK_HOME/bin/logrot verhindert. Das Script sorgt dafür, dass die ies.out-Datei nicht mehr als 1.000.000 Zeilen enthält. Ist diese Zahl erreicht, wird die Datei umbenannt und eine neue Logdatei angelegt. Die Anzahl der Log-Dateien ist auf 5 begrenzt. Diese Einstellungen können in der Konfiguration /etc/sitepark/sitepark.conf in der Variable IES_LOG_ROTATE geändert werden. Der Schalter -l gibt die Maximalen Zeilen einer Log-Datei an. Der Schalter -n bestimmt die Anzahl der maximalen Log-Dateien.

Ist der IES-Prozess erfolgreich gestartet, wird in die Datei /etc/sitepark/ies.pid die PID des IES-Prozesses geschrieben.

Das Init-Script dient zum Starten und Stoppen des IES-Prozesses. Es kann aber auch zur Abfrage weiterer Informationen verwendet werden.

Standardmäßig wird der IES mit der Konfigurationsdatei $SITEPARK_HOME/conf/ies-server.xml und der Lizenz-Datei $SITEPARK_HOME/conf/ies-key.xml gestartet. Es ist jedoch möglich einen anderen Konfigurationssatz zu verwenden, indem vor den eigentlichen Steuerparameter (start,stop,...) ein Konfigurationsname angegeben wird. Wird das Script z.B. mit den Parametern

/etc/init.d/ies testing start

aufgerufen, so wird die Konfigurationsdatei $SITEPARK_HOME/conf/ies-testing-server.xml und die Lizenz-Datei $SITEPARK_HOME/conf/ies-testing-key.xml verwendet.

Folgende Steuer-Parameter stehen für das Init-Script zur Verfügung:

server
Startet den IES-Prozess nicht im Hintergrund. Die Standard-Ausgabe wird in der Konsole angezeigt. Der Prozess lässt sich mit Strg-C beenden.
start
Startet den IES-Prozess im Hintergrund. Das Script wird dennoch erst beendet, wenn der Server gestartet ist. Ein Abbrechen des Init-Scriptes mit Strg-C beendet nur das Script, nicht aber den IES-Prozess.
stop
Stoppt den IES-Prozess.
restart
Stoppt den IES-Prozess und startet ihn danach im Hindergrund neu. Wird das Init-Script während der Stop-Phase mit Strg-C beendet, wird das Stoppen des IES-Prozesses abgeschlossen ohne den IES-Prozess neu zu starten. Bei einem Stop in der Start-Phase wird nur das Init-Script beendet, nicht der IES-Prozess.
status
Liefert den aktuellen Status des IES. Folgende Stati sind möglich:
Status Beschreibung
stopped Der IES oder der gesamte IES-Prozess ist gestoppt
started Der IES ist gestartet
busy Der IES ist zur Zeit nicht in der Lage den Status zurückzugeben
unknown Der Status des IES ist unbekannt
error: <message> Der IES-Prozess ist gestartet. Es ist aber ein Fehler aufgetreten
cmd
Gibt die Kommandozeile aus, mit der der IES gestartet wird
pid
Liefert die PID des IES-Prozesses.
kill
Schickt das KILL Signal an den IES-Prozess
dumpstack
Sichert den Java-Stack des IES-Prozesses nach $SITEPARK_HOME/ies.jstack
chkcnf
Prüft die Konfigurationsdatei /etc/sitepark/ies-server.xml auf Gültigkeit.
chkports
Prüft, ob alle für den IES-Prozess nötigen Ports nicht schon verwendet werden.


Dateien in /etc/sitepark

Im Folgenden wird die Bedeutung der im Verzeichnis /etc/sitepark liegenden Dateien beschrieben. Hierbei handelt es sich um einen sog. Symlink auf das Konfigurationsverzeichnis $SITEPARK_HOME/conf.

ies-key.xml
Verschlüsselte XML-Datei, die die Lizenz dieser IES-Instanz beinhaltet
ies.pid
Enthält die PID des gestarteten IES-Prozesses. Diese Datei wird nach einem erfolgreichen Aufruf von /etc/init.d/ies stop gelöscht
ies-server.xml
Zentrale Konfigurationsdatei des IES. Bei manuellen Änderungen dieser Datei muss sie über IES-Admin neu eingelesen werden
Eine beispielhafte Konfiguration kann hier eingesehen werden.
sitepark.conf
Enthält Konfigurationen für das Systemd-Script:
SITEPARK_HOME
Installations-Verzeichnis des IES
JAVA_HOME
Vom IES verwendete Java-Installation
IES_PID_FILE
Name und Pfad der Datei, in der die PID des IES-Prozesses geschrieben werden soll
IES_MEM_MAX
Maximaler Speicher, der für den Java-Heap angefordert werden darf
IES_MEM_INIT
Speicher, der Initial für den Java-Heap angefordert wird
IES_PERM_MAX
Maximaler Speicher, der für den Java-Non-Heap angefordert werden darf
IES_MIN_HEAD_RATIO
Steuerung des Speicherverhaltens der JVM
IES_MAX_HEAD_RATIO
Steuerung des Speicherverhaltens der JVM
IES_USER
Nutzer, unter dem der IES gestartet wird
IES_LANG
Standard-Sprache, mit der der IES läuft
IES_UMASK
umask Setzungen für den Nutzer des IES
IES_BIND_ADDRESS
Die IP, auf die der IES gebunden werden soll. Standardmäßig ist dort localhost konfiguriert, um das System von Außen zu schützen. Wird dort 0.0.0.0 konfiguriert, so ist der Zugriff über das Netzwerk möglich. Informationen hierzu finden Sie auch unter Kategorie:Installation
IES_IMGFILE_DEFAULT_PROVIDER
Konfiguration der Bildberechnungsroutine. Mögliche Werte sind gfx (Standard unter Linux; Eigenentwicklung von Sitepark), gfxcmd Aufruf der Bibliothek in einem eigenen Prozess (gfx muss konfiguriert sein), imagemagick
version.properties
Enthält die aktuelle Versionsnummer des IES

Werkzeuge in $SITEPARK_HOME/bin

Für die Administration und Steuerung des IES stehen unter $SITEPARK_HOME/bin noch einzelne BASH-Skripte zur Verfügung. Diese waren bis zum Release 2.5 in /usr/bin/ verlinkt. Dies ist aus Sicherheitsgründen umgestellt worden. Nun stehen die Skripte über die $PATH Variable zur Verfügung.

Damit diese auch über einen sudo Aufruf gefunden werden empfiehlt sich die Erweiterung der Datei /etc/sudoers um den folgenden Eintrag:

Defaults !secure_path

Der Aufruf ist grundsätzlich nur als Nutzer root oder ies erlaubt. Die Scripte selber setzen nur notwendige JAVA-Parameter zusammen. Die eigentliche Ausführung erfolgt in einem Java-Prozess.

Folgende Scripte sind verfügbar:

iesadmin
Standard-Werkzeug zur Administration des IES. Weitere Informationen gibt die Option -h oder folgende Dokumentation: Kategorie:IES-Admin (commandline)
iesclient
Werkzeug zu Steuerung von Eingaben in der Console. Es können beliebige Klassen zur Ausführung angegeben werden.
iesxip
Werkzeug für XIP-Importe und -Exporte; basiert auf iesclient