yuuvis® RAD service-manager installieren

Gültig für: yuuvis® RAD Version 8.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

    Elasticsearch:

    Server und Port

    IP-Adresse von Elasticsearch und Port. Default: 9200

    Elasticsearch:

    Passwort

    Passwort der Elasticsearch-Installation.

    Das Passwort wird in der Datei application-es.yml gespeichert.

    Sprachkürzel

    Sprache für das Linguistic Plugin.

    Aktiviert werden kann eine Sprache: Deutsch (de), Englisch (en), Französisch (fr), Spanisch (es), Italienisch (it). Lizenzen für mehrere und weitere Sprachen können eingebunden werden.

    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. 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
  8. 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'.

      Wenn die Domain der Benutzer beim Login berücksichtigt werden soll, weil diese in der Benutzerverwaltung angegeben ist, dann kann ein zusätzlicher Parameter angegeben werden:

      authentication.ntlm.usersubstitutionpattern: Default: '#USER#'

      Geben Sie das Muster an, in der Benutzername und Domain in der Benutzerverwaltung angegeben sind.

      Beispiele:

      '#USER#@#DOMAIN#.com'

      '#USER#@#FQDOMAIN#'

      Werte:

      '#USER#', '#DOMAIN#', '#FQDOMAIN#'

      #FQDOMAIN# ist der 'Fully Qualified Domain Name'.

      Ebenfalls angegeben werden kann das Protokoll: NTLM (Default) oder Negotiate. Negotiate geben Sie für Anmeldungen per Kerberos an:

      authentication.ntlm.protocol: Default: 'NTLM'

      Geben Sie 'Negotiate' für Anmeldung per Kerberos an.

      Falls ein LDAP-Verzeichnisdienst eingebunden werden soll, kann 'LDAP' aktiviert werden. Mit 'LDAP' muss immer auch 'FORM' oder 'BASIC' aktiviert werden. Die Authentifizierung erfolgt dann gegen den Verzeichnisdienst, die Benutzer müssen ebenfalls als yuuvis® RAD-Benutzer angelegt sein.

      Zusätzlich müssen die Daten für die Verbindung zum Verzeichnisdienst angegeben werden:

      authentication.filter.ldap: true

      ldap:
        defaultpostfix: '@DOMAIN1.local'
        usedefaultforlogin: false
        provider:
          - domain: 'DOMAIN1.local'
            providerurl: 'ldap://10.6.0.119:389'
          - domain: 'DOMAIN2.local'
            providerurl: 'ldap://10.6.0.120:389'
            domain: 'DOMAIN3\'
            providerurl: 'ldap://10.6.0.121:389'
        excludeuser:
          - root2
          - root

      Parameter:

      provider

      Provider geben Sie mit der Domain und einer gültigen voll qualifizierten LDAP-Server URL an.

      Mehrere Provider sind möglich.

      defaultpostfix

      Benutzernamen können mit einem Domain-Postfix erweitert an den entsprechenden Provider aus der Liste zur Anmeldung weitergeleitet werden. Dadurch müssen Benutzer nur noch den Benutzernamen ohne Domain angeben, können also statt 'Name@Domain' nur ihren Namen eingeben.

      Falls Benutzer den Benutzernamen '@' eintragen, dann wird der Eintrag nicht erweitert

      usedefaultforlogin

      Wenn yuuvis® RAD-Benutzerbezeichnungen mit einem Domain-Praefix oder -Postfix angelegt sind, dann geben Sie hier 'true' an, andernfalls 'false'.

      Benutzer aus Verzeichnisdiensten können über eine Synchronisierungs-Operation in die yuuvis® RAD-Benutzerverwaltung übernommen werden. Dabei können Daten strukturiert und mit Postfix angelegt werden.

      excludeuser Liste von Benutzern, die nicht über den Verzeichnisdienst, sondern als yuuvis® RAD-Benutzer angemeldet werden.

    • 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.servlet.context-path: ${gateway-context-path}
        management.server.port: 7396

        management.server.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 Management-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.server.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.server.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.

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

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

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.