Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Installation:

Update How to:

Open the Docker Command Line Interface for the Docker container "requisis-toolbox-docker_server" by clicking on the button CLI.Image Removed

Change to the directory home/<yourusername>/reqif-manager-int you may need to log in with an appropriate user.

Stop the Docker container Before you can start the installation you need:

  • DNG 6.06 or higher
  • a Docker installation 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 .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.

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 stop This will take takes a short moment.

Now you need to edit Open the .env file . To do this, enter the following command: vi .env This opens the VI Editor with the file. Navigate to the end of the line that starts with in the root directory with an editor.

In the line REQIF_MANAGER_IMAGE

If you are not familiar with the VI Editor, search the Internet for "vi cheat sheet".

Now you = at the end now change the version tag . There for this there are two possible ways to do this.variants:

  1. To update to a specific version write out the tag completely for example: 2.9.03-stable for the 
    version 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.
The end of the edited line will look like this /reqif-manager:2.9.03-stable resp. /reqif
  1. Ex: /reqid-manager:2.9-stable

Save and close the file and the VI Editor.

Optionally, you can open the startDocker.cmd script to check the used user and password in the docker login line and adjust them if necessary.

Running the env

By running the script startDocker.cmd script 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 may 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 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 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

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

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 stop  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 zwei 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.: /reqid-manager:2.9-stable

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.