yuuvis® RAD service-manager installieren

yuuvis® RAD 7.x »

Die Microservices sind in den Dienst yuuvis® RAD service-manager eingebunden und werden mit yuuvis® RAD service-manager installiert. Bestandteil sind auch alle Komponenten für yuuvis® RAD client und yuuvis® RAD management-studio.

Stellen Sie vor der Installation sicher, dass die Systemvoraussetzungen erfüllt sind.

Schritte für die Installation von yuuvis® RAD service-manager:

  1. Installationsverzeichnis yuuvis_rad_service-manager in das Dateisystem des Rechners kopieren, auf dem yuuvis® RAD service-manager mit den Microservices installiert werden soll.

  2. yuuvis_rad_service-manager_setup-<Version>.exe aus dem Installationsverzeichnis ausführen.
  3. Der Installationsassistent wird gestartet. Folgen Sie den Schritten des Installationsassistenten.

  4. Geben Sie folgende Microservice-Parameter an.

    Die zentralen Microservice-Parameter werden in die Konfigurationsdateien der Microservices eingetragen. Nachträgliche Änderungen können über den Service Application Manager SAM vorgenommen werden.

  5. Technischer Dienstname /

    Dienstanzeigename

    Technischer Dienstname und Dienstanzeigename für die Dienststeuerung
    HTTP-Port Port von yuuvis® RAD service-manager. Default: 7281
    Datenverzeichnis Datenverzeichnis für yuuvis® RAD service-manager.
    Server

    IP-Adresse des Rechners, auf dem yuuvis® RAD core-service installiert ist.

    API-Schlüssel

    API-Schlüssel des Systembenutzers angeben. Der hier benötigte API-Schlüssel wird bei der Installation von yuuvis® RAD core-service angezeigt.

    Zugriffe aus yuuvis® RAD service-manager auf yuuvis® RAD core-service erfolgen im Kontext des Systembenutzers, der bei diesen Zugriffen über alle Rechte verfügt.

    Datenbanktyp
    • MSSQL
    • PostgreSQL

    Oracle Datenbanken werden nur für bestehende Installationen weiterhin unterstützt.

    Datenbankserver IP-Adresse des Rechners, auf dem die Datenbank installiert ist.
    Datenbankserver-Port Port des Datenbankrechners
    Datenbankinstanz Datenbankinstanzname
    Datenbankname Datenbankname
    Schemaname Schemaname der Datenbank
    Datenbankbenutzer Name des technischen Benutzers für den Datenbankzugriff.
    Datenbankpasswort Passwort des technischen Benutzers für den Datenbankzugriff.
    JDBC Zeichenkette

    Die JDBC Zeichenkette für die Datenbankverbindung wird automatisch aus den Datenbankangaben erstellt. Ändern Sie den Eintrag nur, wenn Anpassungen für spezifische Umgebungen notwendig sind.

    Rendition-Server

    IP-Adresse des Rendition-Dienstes

    Der Rendition-Dienst kann nach yuuvis® RAD service-manager installiert werden.

    Rendition-Server-Port Port des Rendition-Dienstes. Default: 8090
    IP-Filter für
    dms-sidecar

    IP-Adressen, von denen über den Service 'dms-sidecar' auf yuuvis® RAD core-service zugegriffen werden kann.

    Voreingetragen sind 127.0.0.1 und die Adresse von yuuvis® RAD service-manager.

    Diese Adressen sind für diesen IP-Filter notwendig und in der Regel ausreichend.

    Eingetragen werden die Adressen in die Konfigurationsdatei dms-prod.yml aus dem Verzeichnis \config.

  6. Passen Sie vor dem Dienststart die Dienstparameter an:

    • yuuvis_rad_service_managerw.exe aus dem Verzeichnis \service-manager\bin\ ausführen.
    • Dienstparameter:

      Log On > Account

      Konto für die Dienstanmeldung

      yuuvis® RAD service-manager benötigt ein administratives Konto.

      Logging > Level Optional: Protokollierungslevel für die Dienstprotokollierung
      Logging > Path Optional: Pfad für Dienstprotokolle
      Logging > Stdout Optional: Umleitung der Standardausgabe in eine Datei
      Logging > Stderror Optional: Umleitung der Standardfehlerausgabe eine Datei
      Startup > Arguments Der Port von yuuvis® RAD service-manager kann geändert werden. Default: 7281
      Java > Java Options

      Optional: Tomcat-Datenverzeichnisse anpassen.

  7. Passen Sie die Konfigurationsdatei application-prod.yml aus dem Verzeichnis \config von yuuvis® RAD service-manager an:
    • Ergänzen Sie die Datei am Ende um folgenden Eintrag: feign.hystrix.enabled: false

    • Ändern Sie die Werte für connection-timeout und socket-timeout wie folgt:

      service:
       connection-timeout-ms: 60000
       socket-timeout-ms: 300000

  8. Passen Sie die Konfigurationsdatei application-es.yml aus dem Verzeichnis \config von yuuvis® RAD service-manager an:

    spring.data.elasticsearch.cluster-nodes: '127.0.0.1:9300'
    spring.elasticsearch.rest.uris: '127.0.0.1:9200'

    Geben Sie die Adresse von Elasticsearch an.

    Falls Elasticsearch auf dem gleichen Server installiert ist wie yuuvis® RAD service-manager, dann ist keine Änderung notwendig.

  9. Passen Sie die Konfigurationsdatei application-mq.yml aus dem Verzeichnis \config von yuuvis® RAD service-manager an:

    spring.activemq.broker-url: 'tcp://127.0.0.1:61616'
    spring.activemq.broker-url-stomp: 'stomp://127.0.0.1:61777'

    Geben Sie die Adresse des Servers an, auf dem der Microservice 'messagingservice' lauft.

    Falls yuuvis® RAD core-service auf dem gleichen Server installiert ist wie yuuvis® RAD service-manager, dann ist keine Änderung notwendig.

  10. Wenn die Microservices 'structureservice' und 'discoveryservice' auf unterschiedlichen Rechnern laufen und/oder der Discoveryservice auf einem anderen Port als dem Standard-Port (7261) läuft, dann ergänzen Sie die Konfigurationsdatei <service-manager>\config\servicewatcher-sw.yml um die entsprechenden Werte, Host/ Port des Discoveryservice, im Structureservice-Abschnitt wie folgt:

    - name: structureservice
      type: executable
      profiles: prod,red,es,mq
      instances: 1
      port: 7461-7469
      path: ${appBase}/structureservice/structure-service.exe
      env:
        EUREKA_HOST: discovery-host
        EUREKA_PORT: discovery-port
  11. Weitere optionale Anpassungen:

    • Einstellung für die Authentifizierung über den Microservice 'Gateway':
    • Default: 'FORM' (Anmeldedialog) / 'BASIC' (Anmeldedaten als Parameter).

      Über die Konfigurationsdatei gateway-prod.yml aus dem Verzeichnis \service-manager\config\ kann 'NTLM' aktiviert werden. 'NTLM' deaktiviert automatisch 'FORM' und 'BASIC'.

    • HTTPS
    • HTTPS kann aktiviert werden.

    • SameSite-Attribut
    • Für die Cookies von yuuvis® RAD kann das SameSite-Attribut gesetzt werden: strict, lax, none.

      Das SameSite-Attribut wird in die Konfigurationsdatei gateway-prod.yml aus dem Verzeichnis \service-manager\config\ in einer neuen Zeile eingetragen: cookie.samesite: 'strict'

    • Kontextpfad
    • Ein Kontextpfad wird für alle URLs als Präfix verwendet. Durch einen Kontextpfad wird yuuvis® RAD gateway erreichbar, wenn er als einer von mehreren Diensten auf einer Adresse läuft. Damit ist beispielsweise das Einbinden in Portale möglich.

      • Über die Konfigurationsdatei gateway-prod.yml aus dem Verzeichnis <service-manager>\config\ wird ein Kontextpfad eingebunden:

        server.context-path: ${gateway-context-path}
        management.port: 7396

        management.port: freier Port, der für die anderen yuuvis®-Dienste erreichbar ist. Management-URLs werden nicht unter dem Kontextpfad, sondern unter dem definierten Port aufgerufen.

        Falls mehrere Instanzen des Microservice 'Gateway' laufen, dann wird der Managment-Port stattdessen für die Instanzen in der Konfigurationsdatei servicewatcher-sw.yml angegeben:

        - name: gateway
          type: microservice
          profiles: prod,cloud,red
          instances: 1
          memory: 256M
          port: 80
          path: ${appBase}/gateway/gateway-app.jar
          args: 
          - --management.port=7396
          
        - name: gateway_2
          type: microservice
          profiles: prod,cloud,red
          instances: 1
          memory: 256M
          port: 81
          path: ${appBase}/gateway/gateway-app.jar
          args: 
          - --management.port=7397

        Alternativ kann für jede Instanz ein eigenes Profil verwendet werden. Der Managment-Port wird entweder im Profil oder in der Konfigurationsdatei servicewatcher-sw.yml angegeben.

      • Über die Konfigurationsdatei application-prod.yml aus dem Verzeichnis <service-manager>\config\ wird der Kontextpfad angegeben. Beispiel: gateway-context-path: '/yuuvis'

        Angegeben werden beliebig viele Pfadsegmente mit führendem /, aber ohne abschließendem /.

      • Die Konfigurationsdatei extend.json im Verzeichnis <service-manager-data>\webresource\resources\client\assets\_default\config\ anlegen und den untenstehenden Block (alle Basisadressen) einfügen. Die aktuellen Basisadressen können bei Bedarf unter <service-manager-data>\webresource\public\client\assets\_default\config\main.json eingesehen werden.

        {
          "uri": {
            "serviceBase": "/yuuvis/rest-ws/service",
            "searchBase": "/yuuvis/search",
            "contextBase": "/yuuvis/structure",
            "inboxBase": "/yuuvis/inboxservice",
            "bpmBase": "/yuuvis/bpm",
            "agentBase": "/yuuvis/agent",
            "statusBase": "/yuuvis/status",
            "loginBase": "/yuuvis"
          }
        }
      • In yuuvis® RAD management-studio über Hauptmenü > System > Einstellungen > Core-Service > Global > Gateway access> client path den Kontextpfad angeben. Beispiel: yuuvis/app/client

    • Instanzen und Speicherzuweisungen
    • Über die Konfigurationsdatei servicewatcher-sw.yml aus dem Verzeichnis \service-manager\config\ können Microservice-Instanzen hinzugefügt und Microservices deaktiviert werden (instances: 0).

      Die Speicherzuweisung für die einzelnen Microservices kann geändert werden.

      Wird einem Microservice mehr als 1,5 GB Speicher zugewiesen, dann muss der Parameter arch: x64 hinzugefügt werden.

  12. Starten Sie den Dienst yuuvis® RAD service-manager.

    Der Start von yuuvis® RAD service-manager und der Microservices kann einige Minuten in Anspruch nehmen.

Falls yuuvis® RAD service-manager Microservices nicht startet, dann prüfen Sie die folgende Einstellung im Registrierungs-Editor: Schlüssel: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\PerfProc\Performance\Disable Performace Counters (REG_DWORD). Als Wert muss 0 angegeben werden.
Falls die Spracheinstellung des Betriebssystems geändert wurde und die Microservices nicht starten, dann prüfen Sie die folgenden Einstellungen im Registrierungs-Editor: Schlüssel: HKEY_LOCAL_MACHINE\Microsoft\Windows NT\CurrentVersion\Perflib\009. Die Werte müssen in englisch vorliegen. Das Zurücksetzen der Sprachumstellung löst in der Regel das Problem. Informationen finden Sie ebenfalls bei Microsoft.

Deinstallation von yuuvis® RAD service-manager

Bei der Installation von yuuvis® RAD service-manager wird ein Deinstallations-Programm im Installationsverzeichnis erstellt, das yuuvis® RAD service-manager und alle Microservices deinstalliert.

Passwörter in yuuvis® RAD service-manager

Passwörter in folgenden Konfigurationsdateien werden bei der Installation verschlüsselt gespeichert:

  • archive-prod.yml, application-dbs.yml, application-es.yml, application-red.yml, erm-prod.yml, gateway-prod.yml, repositorymanager-prod.yml, servicewatcher-sw.yml

Passwörter in Konfigurationsdateien aus vorherigen Version von yuuvis® RAD sind nicht verschlüsselt und werden durch ein Update nicht verschlüsselt. Diese Passwörter können wie folgt verschlüsselt werden:

  • Öffnen Sie die Eingabeaufforderung als Administrator und wechseln Sie in das Verzeichnis \service-manager\tools\.

  • Führen Sie folgenden Befehl aus: encode.bat password

    Das verschlüsselte Password wird mit führendem 'ENC' und in runden Klammern angezeigt: ENC(encryptedpassword)

  • Kopieren Sie das verschlüsselte Passwort mit führendem 'ENC' und mit den runden Klammern und tragen Sie es in die Konfigurationsdatei ein.

  • Speichern Sie die Konfigurationsdatei.