Installation:

Before you can start the installation you need:

• DNG 6.06 or higher
• a Docker installation and Docker Compose on the system where you want to install the requisis_ReqIF Manager
• an email from product support with your license and feature information.
• an email from product support with your Harbor account information
• the download of the initial requisis_reqif-manager-X.x.zip package / evaluation package 

Unpack the initial zip package in the desired installation path on your system. In the subfolder Administrator-Manual you will find a pdf file with more detailed installation instructions.

Copy the features.yml file from the email to the subfolder store/toolbox/config

Open the admin area of your DNG server in a new browser tab and navigate to the page Communication → Consumers (Inbound) the following URL will help you:

"https://(your-server:your-port)/jts/admin#action=com.ibm.team.repository.admin.configureOAuth".

Follow the instructions on the page to generate OAuth consumer keys for ReqIF Manager.

Edit with an editor the file mix-config.json which can also be found in the subfolder store/toolbox/config. In this file you determine with which DNG servers the ReqIF Manager is allowed to connect.

• Add the URL of your DNG server to the targetUrl line.  Please note that slash / needs to be escaped with a backslash \ in the json format.
• Add the value of the Consumer Key property to the oauth_clientId line.
• In the oauth_clientSecret line, add the value of the Consumer Secret property.

Repeat these steps for each DNG Server the ReqIF Manager is allowed to connect to.

Save the file mix-config.json

Open the .env file in the root directory with an editor

• In the line HARBOR_USER= add your Harbor username. If this line is missing, add it at the end of the file.
  Ex: HARBOR_USER=robot$myCompany
• In the line PW= add the password of the harbor user. If this line is missing, add it under the HARBOR_USER line.
  Ex: PW=<veryLongString>

Save the .env file

Open the file startDocker.cmd

• Add the line docker login, with username and PW This line must be before the docker pull commands.
  Ex: docker login -u %HARBOR_USER% -p %PW%https://harbor.requisis.com:443

Save the startDocker.cmd file. Once you run the startDocker.cmd the ReqIF Manger will be installed. This will take several minutes. For DNG server settings, see the Configuration chapter in the Administrator Manual.

Open a new browser tab with the address: localhost:8080 to display the reqif manager.

For the Evalauations license you can log in with the user test and the password test.

Update:

To trigger an update to a new version of the requisis_ReqIF manager perform the following steps:

Stop the Docker container "requisis-toolbox-docker_server" for example with the command docker-compose down This takes a moment.

Open the .env file in the root directory with an editor.

In the line REQIF_MANAGER_IMAGE= at the end now change the version tag for this there are three possible variants:

1. To update to a specific version write out the tag completely for example: 2.9.03-stable for version 2.9.03
   Ex: /reqif-manager:2.9.03-stable
2. If you want to have automatic updates for your version use the following tag: 2.9-stable As soon as there is an update to version 2.9.04 you will get it automatically.
   Ex: /reqif-manager:2.9-stable
3. You can also always use the latest currently available version: /reqif-manager:latest-stable
   1. If you do not want to update to the next major version (e.g. from version 2 to 3), then you should not use this option!

Save the file .env

By running the script startDocker.cmd it will check if you are currently using the latest version configured in your .env file and update it if not. Afterwards, the Docker containers are started up again. This can take some time due to the update. This depends on how many DNG modules are used. As soon as you can see the interface of the Reqif Manager in the browser again, the update is finished.

With the command docker-compose logs -f server you can follow the process of update and migration.

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 der requisis_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 der 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 der 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

Ö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.

Öffnen Sie einen neuen Browser Tab mit der Adresse: localhost:8080 um den 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 des requisis_ReqIF-Managers 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  Dies dauert einen kurzen Augenblick.

Öffnen Sie die Datei .env im Hauptverzeichnis mit einem Editor.

In der Zeile REQIF_MANAGER_IMAGE= ändern Sie am Ende nun den Versions Tag hierzu gibt es drei mögliche Varianten:

1. Um auf eine bestimmte Version upzudaten schreiben Sie den Tag komplett aus zum Beispiel: 2.9.03-stable für die  Version 2.9.03
   Bsp.: /reqif-manager:2.9.03-stable
2. Möchten Sie hingegeben automatische Updates für Ihre Version haben benutzen Sie folgenden Tag: 2.9-stable So bald es ein Update auf die Version 2.9.04 gibt werden Sie dieses automatisch erhalten.
   Bsp.: /reqif-manager:2.9-stable
3. Sie können auch immer die letzte aktuell verfügbare Version nutzen: /reqif-manager:latest-stable
   1. Wenn Sie kein Update auf die nächste Hauptversion wünschen (z.B. von Version 2 auf 3), dann sollten Sie diese Option nicht verwenden!

Speichern Sie die Datei .env

Durch Ausführen des Skripts startDocker.cmd wird überprüft ob Sie aktuell die neuste, bei sich in der .env Datei konfiguriete, Version verwenden und updatet diese falls nicht. Im Anschluss werden die Docker Container wieder hochgefahren. Dies kann aufgrund des Updates etwas Zeit in anspruch nehmen. Dies hängt davon ab wieviele DNG Module verwendet werden. So bald Sie das Interface des Reqif Managers wieder im Browser sehen können ist das Update beendet.

Mit dem Kommando docker-compose logs -f server können Sie den Prozess des Updates und Migration verfolgen.