Administration und Installation: Unterschied zwischen den Versionen

Aus Wiki openKONSEQUENZ
Wechseln zu: Navigation, Suche
(Projektstruktur)
(Der Seiteninhalt wurde durch einen anderen Text ersetzt: „{{Warning|text=Die Dokumentation von Administration und Installation des CIM Caches findet sich, nach den Anforderungen des überarb…“)
 
(30 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
__TOC__
+
{{Warning|text=Die Dokumentation von Administration und Installation des CIM Caches findet sich, nach den Anforderungen des überarbeiteten QC-Handbooks, in der Service-Dokumentation im AsciiDoc-Format.}}
 
 
=Hardware-Voraussetzungen=
 
Die Anforderungen an die Hardware für den Rechner für Serverkomponenten hängen von verschiedenen Rahmenbedingungen ab. Sind die Mindestanforderungen erfüllt, ist die Anwendung lauffähig. Mit zunehmender Leistung der Hardware wird ein besseres Laufzeitverhalten erreicht.
 
 
 
{|class="wikitable"
 
|Prozessor:
 
|Intel Core i7-7700 CPU Prozessor, mind. 4x 3.60GHz
 
|-
 
|RAM:
 
|mind. 16 GB
 
|-
 
|Festplattenspeicher:
 
|mind. 20 GB
 
|-
 
|Internetverbindung:
 
|Ja
 
|}
 
 
 
=Software-Voraussetzungen=
 
Folgende Installationen und Konfigurationen wurden gemäß Dokumentation ausgeführt:
 
 
 
{| class="wikitable"
 
| 64-bit-Windows-Umgebung* in der Version 10
 
|
 
|-
 
| Oracle Java-Runtime-Umgebung in der Version 1.8
 
| [https://java.com/de/download/ Download]
 
|-
 
| Apache Maven Umgebung in der Version 3.3.9 oder höher
 
| [https://maven.apache.org/download.cgi Download]
 
|-
 
| Mozilla Firefox-Browser in der Version 52 oder höher
 
| [https://www.mozilla.org Download]
 
|}
 
 
 
Die für das Projekt notwendigen Sourcen (veröffentlichte Quelltexte) können über das [https://projects.eclipse.org/projects/technology.openk-platform/developer eclipse-git] bezogen werden.
 
 
 
=Projektstruktur=
 
Die Projektverzeichnisse und Dateien befinden nach dem Entpacken bzw. Herunterladen auf dem lokalen Rechner in einem gemeinsamen Verzeichnis (z. B. ''D:\demo\git.openk\cim-cache''), das im Folgenden als ''ROOT_PATH'' bezeichnet wird:
 
<pre style="white-space: pre;">
 
org.eclipse.openk.build
 
org.eclipse.openk.cim.cim17v07
 
org.eclipse.openk.cim.profile.openkonsequenz
 
org.eclipse.openk.common
 
org.eclipse.openk.domain.dynamic-topology
 
org.eclipse.openk.domain.static-topology
 
org.eclipse.openk.domain.topology-state
 
org.eclipse.openk.service
 
org.eclipse.openk.source-system.mock-up-static-topology
 
org.eclipse.openk.source-system.mock-up-topology-state
 
.gitignore
 
pom.xml
 
</pre>
 
 
 
Es sind die folgenden Quelltexte und Definitionen enthalten:
 
* der CIM-Standard in der Version 17.07
 
* das Domänen-Modul des [[TopologieDatenManagement]]s
 
* das Quellsystem-Modul der [[Mock-Up-Topologie|Mock-Up-Topology]]
 
* gemeinsam genutzte Basis- und Servicefunktionalität
 
* eine Hilfsdatei für die Versionsverwaltung Git (''.gitignore'')
 
* die notwendigen Definitionen zum automatisierten Kompilieren und Testen der Quellen (''pom.xml'')
 
 
 
=Kompilieren des CIM-Caches auf der Basis der veröffentlichten Quelltexte=
 
 
 
#Innerhalb der Konsole in das Verzeichnis ''ROOT_PATH'' wechseln:<pre>cd demo\git.openk\cim-cache</pre>
 
#Anschließend den Bau des CIM-Caches mit Hilfe des Tools ''Maven'' starten:<pre>mvn clean install</pre>
 
 
 
Auf dieser Basis führt Maven folgende Schritte durch:
 
* Auflösen der zum Bauen notwendigen Informationen
 
* Herunterladen der externen Abhängigkeiten
 
* Durchführung der statischen Code-Analyse
 
* Bauen der einzelnen Module in der festgelegten Reihenfolge
 
* Durchführung von Unit- und Integrationstest
 
 
 
=Starten des CIM-Caches=
 
 
 
Der Start des CIM-Cache setzt die Verfügbarkeit der Quellsysteme voraus.
 
Für Tests kann hier die [[Mock-Up-Topologie|Mock-Up-Topology]] als Quellsystem-Mock-Up verwendet werden.
 
 
 
Dabei ist zu berücksichtigen, dass alle notwendigen Applikationen auf unterschiedlichen Ports laufen. Diese lassen sich, wie in Abschnitt 6 beschrieben, konfigurieren.
 
 
 
==Starten der [[Mock-Up-Topologie|Mock-Up-Topology]]==
 
#Innerhalb der Konsole in das folgende Verzeichnis wechseln:<pre>ROOT_PATH/org.eclipse.openk.sourcesystem.mock-up-topology/mock-up-topology-service/target</pre>
 
#Das Quellsystem-Mock-Up mit dem folgenden Befehl starten (Windows):<pre>java -jar mock-up-topology-service.jar</pre>
 
#Das Quellsystem-Mock-Up mit dem folgenden Befehl starten (Linux):<pre>nohup java -jar mock-up-topology-service.jar > mock-up-topology-service.log 2>&1 &</pre>
 
 
 
==Starten des [[TopologieDatenManagement]]==
 
# Innerhalb der Konsole in das folgende Verzeichnis wechseln:<pre>ROOT_PATH/org.eclipse.openk.domain.topology.topology-service/target</pre>
 
# Den CIM-Cache mit dem folgenden Befehl starten (Windows):<pre>java -jar topology-interface-service.jar</pre>
 
# Den CIM-Cache mit dem folgenden Befehl starten (Linux):<pre>nohup java -jar topology-interface-service.jar > topology-interface-service.log 2>&1 &</pre>
 
 
 
=Beenden der Applikation=
 
 
 
Die Applikation wird beendet, indem die Konsole(n), in der die Applikation(en) gestartet wurden, geschlossen werden.
 
 
 
=Anstoßen des Neuaufbaus des Datenmodells=
 
{{Warning|text=noch nicht in MS 1.3}}
 
Nach einem Post-Request an <pre>/commands/reload-topology/executions</pre> wird das Datenmodell neu eingelesen. Zum Absetzen des Kommandos kann die folgende HTML-Seite verwendet werden:
 
 
 
<pre>http://</pre>
 
 
 
=Prüfen des CIM-Cache-Start durch einen Service-Aufruf=
 
{{Warning|text=Die folgende Beschreibung gilt für eine lokale Installation.}}
 
 
 
Zur Überprüfung des Starts des CIM-Caches kann im Browser die folgende URL aufgerufen: [http://localhost:9590/domain/topology/ac-line-segments?revision=3]
 
 
 
Das Ergebnis sollte eine in XML formatierte Liste der dem System bekannten Leitungsabschnitte darstellen.
 
 
 
=Log- und Konfigurationsdateien=
 
Die Anwendung wird durch die Konfigurationsdatei application.properties angepasst. Folgende Parameter können hier konfiguriert werden:
 
 
 
*server-Port
 
*logging-level
 
 
 
Die Datei befindet sich im Verzeichnis:
 
<pre>ROOT_PATH/org.eclipse.openk.domain.topology.topology-service/src/main/resources/</pre>
 
 
 
Die Konfiguration dieser Datei können Sie beim Start der Anwendung überschreiben. Dazu fügen Sie dem Befehl zum Starten der Applikation folgenden Parameter hinzu und verweisen damit auf eine alternative Konfigurationsdatei mit den gewünschten Einstellungen:
 
<pre>java -jar topology-service.jar --spring.config.location=./Configuration/application.properties</pre>
 
 
 
=Konfiguration der Schnittstellen, Versionen und Ports=
 
 
 
Sie können den Service anhand der Datei topology-service.config konfigurieren. Ein Beispiel für einen Konfigurationsparameter ist in der der folgenden Tabelle beschrieben. Die Datei befindet sich im Verzeichnis
 
 
 
<pre>ROOT_PATH/org.eclipse.openk.domain.topology.topology-service</pre>
 

Aktuelle Version vom 12. März 2019, 09:41 Uhr

Warning-yellow.icon.svg Die Dokumentation von Administration und Installation des CIM Caches findet sich, nach den Anforderungen des überarbeiteten QC-Handbooks, in der Service-Dokumentation im AsciiDoc-Format.