For yuuvis® Momentum version updates, we recommend the usage of our Helm Charts.
>> Version Updates

When updating your yuuvis® Momentum installation from version 2022 Autumn to version 2022 Winter LTS, manual configuration changes are required for some services.

If you update from version 2021 Winter LTS, please refer to the summarized update instructions:
>> Update Instructions 2021 - 2022 Winter LTS

Table of Contents

Breaking Changes
Configurations Enabling new Features
- Artificial Intelligence Platform
  - ML Training Pipeline

Breaking Changes

The following Breaking Changes are incompatible changes we had to deploy into operation, and therefore you—as a yuuvis® user—need to be aware of them and take action accordingly.

Infrastructure

Support of Keycloak Version 19

To use Keycloak version 19, it is required to manually adjust the endSessionUri parameter for each tenant in the application-oauth2.yml configuration file.
Action: In each tenant configuration, remove the redirect URI from the URL as shown below for the testyuuvis example tenant.

up to Keycloak version 15:

endSessionUri: http://${keycloak.host}/auth/realms/testyuuvis/protocol/openid-connect/logout?redirect_uri=${redir}

for Keyclaoak version 19:

endSessionUri: http://${keycloak.host}/auth/realms/testyuuvis/protocol/openid-connect/logout

Core

Tenant-specific Database Configuration

It is now possible to configure different databases to be used for storing metadata of individual tenants. Configurations for previous product versions are not supported any longer. The spring.datasource parameters in the application-dbs.yml configuration file are ignored.

Action: If you use the TENANT-MANAGEMENT service in your installation, apply the breaking change for the METRICS service configuration first. Afterwards, apply the new configuration to the core services as described here. To continue using the same database for all tenants, replace the spring.datasource parameters as shown in the example below in your application-dbs.yml configuration in the Git root directory.

The spring.datasource parameters used up to product version 2022 Autumn:

spring.datasource.url: jdbc:postgresql://abc/def
spring.datasource.username: yuuvis
spring.datasource.password: changeme123
spring.datasource.driver-class-name: org.postgresql.Driver

The new configuration structure used as of product version 2022 Winter LTS:

storage:
    databases:
        defaultdb:
            datasource: defaultds
            predicate: 'spel:false'
            default: true
    datasources:
        defaultds:
            url: 'jdbc:postgresql://abc/def'
            username: yuuvis
            password: changeme123
            driver-class-name: 'org.postgresql.Driver'

To use different databases for individual tenants, please read the documentation of the application-dbs.yml configuration file.

Client Services & Client Development

Developer Libraries

Task Properties in Inbox

The inbox provided by the @yuuvis/core library uses the briefRepresentation parameter of the Web-API gateway bpm-controller endpoints as described below. Thus, the retrieved tasks are presented with a reduced data set to the users of a client application.
Action: If you want to display the full property set of tasks, set disableBriefRepresentation for the inbox service.

Web-API Gateway

bpm-controller Endpoints

The optional query parameter briefRepresentation is available for the task retrieval endpoints. Per default, the response will contain only a reduced data set in order to reduce the processing time.
Action: In order to keep the behavior of the previous versions, set the query parameter briefRepresentation=false for each request to the corresponding endpoint.

Tenant Management

METRICS Service

As the METRICS service still uses only one database for the data of all tenants, it uses an own configuration file with its own database connection parameters now.

Actions:

Create a copy of the previoulsy used application-dbs.yml configuration file and save it as application-dbstmp.yml configuration file. The file should now contain the spring.datasource parameters as shown in the following example.
```
spring.datasource.url: jdbc:postgresql://abc/def
spring.datasource.username: yuuvis
spring.datasource.password: changeme123
spring.datasource.driver-class-name: org.postgresql.Driver
```
In the METRICS service deployment, replace the dbs profile by the dbstmp profile.
Continue with the database reconfiguration of the core services.

Configurations Enabling new Features

Some new features require manual configuration in order to operate properly after the update to the new yuuvis® Momentum version.

Artificial Intelligence Platform

ML Training Pipeline

New Model Response Format

The ML Training Pipeline uses MLflow 2.0 now. Thus, the response format is not compatible with models of the beta version that was available for previous yuuvis® Momentum versions. If you already trained some beta version models, you need to

update your system to yuuvis® Momentum 2022 Winter including the Docker images for the AI platform,
retrain the models and
rebuild your docker images that contain the retrained models.

Browser not supported