Anleitung zum Installieren oder Aktualisieren der requisis_Toolbox / ReqIF-Managers in einer Docker-Umgebung
Installation:
Bevor Sie mit der Installation beginnen können benötigen Sie:
- DNG 6.06 oder höher
- eine Docker Installation und Docker Compose auf dem System auf dem die requisis_Toolbox / ReqIF-Manager installiert werden soll
- eine Email vom Produkt Support mit ihren Lizenz- und Feature-Informationen.
- eine Email vom Produkt Support mit ihren Harbor Accountinformationen
- den Download des initialen requisis_reqif-manager-X.x.zip Paketes / Evaluationspacket
Entpacken Sie das initiale zip-Paket im gewünschten Installtionspfad auf ihrem System. Im Unterordner Administrator-Manual befindet sich eine pdf-Datei mit einer ausführlicheren Installationsanleitung.
Kopieren Sie die Datei features.yml aus der Email in den Unterordner store/toolbox/config
Öffnen Sie in einem neuen Browser-Tab den Administartionsbereich ihres DNG Servers und navigieren Sie zur Seite Communication → Consumers (Inbound) die folgend URL hilft ihnen dabei: “https://(your-server:your-port)/jts/admin#action=com.ibm.team.repository.admin.configureOAuth”
Folgend Sie den Anweisungen auf der Seite um OAuth Consumer Keys für den ReqIF Manager zuerzeugen.
Editieren Sie mit einem Editor die Datei mix-config.json die ebenfalls im Unterordner store/toolbox/config zu finden ist. In dieser Datei bestimmen Sie mit welchen DNG Servern die requisis_Toolbox / ReqIF-Manager sich verbinden darf.
- Ergänzen Sie in der Zeile targetUrl die URL ihres DNG Servers. Bitte beachten Sie, dass der Slash / im json-Format durch einen Backslash \ ersetzt werden muss.
- Ergänzen Sie in der Zeile oauth_clientId den Wert der Eigenschaft Consumer Key
- Ergänzen Sie in der Zeile oauth_clientSecret den Wer der Eigenschaft Consumer Secret
Wiederholen Sie diese Schritte für jeden DNG Server mit dem sich die requisis_Toolbox / ReqIF-Manager verbinden darf.
Speichern Sie die Datei mix-config.json
Öffnen Sie die Datei .env im Hauptverzeichnis mit einem Editor
- In der Zeile HARBOR_USER= fügen Sie ihren Harbor Usernamen hinzu. Falls diese Zeile fehlt ergänzen Sie diese am Ende der Datei.
Bsp.: HARBOR_USER=robot$meineFirma - In der Zeile PW= fügen Sie das Passwort des Harbor Users hinzu. Falls diese Zeile fehlt ergänzen Sie diese unter der Zeile HARBOR_USER.
Bsp.: PW=<sehrLangeZeichenkette>
Speichern Sie die Datei .env
Verzichten Sie auf Kommentare (Zeilen, die mit einem # beginnen) in der .env Datei, da diese zu Problemen bei der Ausführung des Startskripts führen können.
Wenn Sie nicht auf Kommentare verzichten können, fügen Sie diese nur in Ihre Sicherheitskopie der .env Datei ein.
Öffnen Sie die Datei startDocker.cmd / startDocker.sh auf Linux Systemen
- Fügen Sie die Zeile docker login ein, mit Username und PW Diese Zeile muss vor dem Docker pull Commands stehen.
Bsp.: docker login -u %HARBOR_USER% -p %PW%https://harbor.requisis.com:443
Speichern Sie die Datei startDocker.cmd. Sobald Sie die startDocker.cmd ausführen wird der ReqIF Manger installiert. Dies dauert mehrere Minuten. Zu den Einstellungen des DNG Servers lesen Sie das Kapitel Configuration im Administrator-Manual.
Sollte es beim Ausführen des Skriptes zu diesem Fehler kommen:
Error response form daemon: Get "https://harbor.requisis.com": Forbidden
Die Fehlermeldung kann auch etwas anders aussehen, bedeutet aber dasselbe:
Error: Get "https://harbor.requisis.com": Forbidden
Um dieses Problem zu beheben, fügen Sie diese URL als Ausnahme/Whitelist zu Ihrer Firewall hinzu. Die in der Fehlermeldung genannte URL ist eine der URLs aus der .env-Datei, aus der die Images für die Dockercontainer gezogen werden.
Öffnen Sie einen neuen Browser Tab mit der Adresse: localhost:8080 um die requisis_Toolbox / ReqIF-Manager anzuzeigen.
Bei der Evalauations Lizenz können Sie sich mit dem Nutzer test und dem Passwort test einloggen.
Update:
Um ein Update auf eine neue Version der requisis_Toolbox / ReqIF-Manager anzustoßen führen Sie folgende Schritte durch:
Stoppen Sie den Docker-Container "requisis-toolbox-docker_server" zum Beispiel mit dem Befehl docker-compose down . Die Dauer des Herunterfahrens hängt davon ab, ob im Hintergrund noch Jobs laufen.
Öffnen Sie die Datei .env im Hauptverzeichnis mit einem Editor.
In der Zeile REQUISIS_TOOLBOX_IMAGE= ändern Sie am Ende nun den Versions Tag hierzu gibt es drei mögliche Varianten:
Der Parameter REQUISIS_TOOLBOX_IMAGE hieß in früheren Versionen noch REQIF_MANAGER_IMAGE Wenn Sie auf eine neue Version updaten ändern Sie nur den Tag in der Zeile. Ändern Sie nicht den Parameternamen!
- Um auf eine bestimmte Version upzudaten schreiben Sie den Tag komplett aus zum Beispiel: 4.4.01-stable für die Version 4.4.01
Bsp.: /requisis-toolbox:4.4.01-stable - Möchten Sie hingegeben automatische Updates für Ihre Version haben benutzen Sie folgenden Tag: 4.4-stable So bald es ein Update auf die Version 4.4.02 gibt werden Sie dieses automatisch erhalten.
Bsp.: /requisis-toolbox:4.4-stable - Sie können auch immer die letzte aktuell verfügbare Version nutzen:
/requisis-toolbox:latest-stable
Speichern Sie die Datei .env
Durch Ausführen des Skripts startDocker.cmd wird überprüft, ob Sie aktuell die neueste, in Ihrer .env-Datei konfigurierte Version verwenden, wenn nicht wird diese gegebenenfalls aktualisiert. Anschließend werden die Docker-Container neu gestartet. Dies kann aufgrund des Updates etwas Zeit in Anspruch nehmen. Sobald Sie die Oberfläche des Reqif Managers wieder im Browser sehen können, ist das Update abgeschlossen.
Mit dem Kommando docker-compose logs -f server können Sie den Prozess des Updates und Migration verfolgen.