Update Instructions 2022 Spring

Owned by Technische Redaktion
Last updated: Jul 11, 2022
2 min read

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

Table of Contents

Breaking Changes

Each yuuvis® Momentum version update introduces changes in the system. In general, we try to deploy such changes in a non-breaking way. If this is not possible, you will find all necessary and vital information on this page. 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. An update to a new version that skips some of the previous versions is possible and does not require updating to each version in between. However, in this case, you must carry out all actions in the order in which they are listed below. Starting with your current version up to the version you want to update to.
>> Breaking Changes


Core

Performance Optimization for CONFIGSERVICE

This feature is a subsequent change applied to version 2022 Spring as well as 2021 Winter (LTS). Please find details in the release information and in the breaking change description for version 2021 Winter.
>> Product Version 2021 Winter LTS | Breaking Changes

Client Services & Client Development

Developer Libraries

Object Creation Permissions

The permission to create new objects is now enabled via a create permission within one of the roles defined via a role set. The YUUVIS_CREATE_OBJECT role does no longer allow object creation. You need to adjust your corresponding role set accordingly.

Action: Update your roles as described here. Use the following condition:

<condition>system:objectTypeId = 'appClient:minidoc' AND system.secondaryjectTypeIds = 'appClient:minidoc'</condition>

Web-API Gateway

New Swagger UI Version

The new Swagger version is available under a new URL.

Action: Adjust the endpoint URL pattern in authentication-prod.yml configuration file has follows:

...
### api-web
  - endpoints: /api-web/swagger-ui.html,/api-web/swagger-ui/**,/api-web/**/v3/api-docs/**
  ...
...

USERSERVICE

Migration of User Information Endpoints.

The user information endpoints GET /userservice/api/users and GET /userservice/api/users/{userId} are not available anymore.

Action: Use the endpoints GET /api-web/api/users/users and GET /api-web/api/users/{userId} instead.

Tenant Management

Tenant Management API

New Swagger UI Version

The new Swagger version is available under a new URL.

Action: Adjust the endpoint URL pattern in authentication-prod.yml configuration file has follows:

...
### tenant-management
  - endpoints: /tenant-management/swagger-ui.html,/tenant-management/swagger-ui/**,/tenant-management/**/v3/api-docs/**
  ...
...

Configurations Enabling new Features

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

Core

Fail-safe AUTHENTICATION Service

In order to enable the shared usage of the session state for multiple instances of the AUTHENTICATION service, the session state has to be stored in a Redis database. In the default configuration of yuuvis® Momentum, the session state is stored by the individual AUTHENTICATION service instances. Thus, in order to enable the central storage of the session state in Redis, manual configuration steps are required.

  • Extend the authentication-prod.yml configuration file by the following lines:

    spring.session.store-type: redis
management.health.redis.enabled: true


  • Add the redis profile to the AUTHENTICATION service:

    • Run the command:

      kubectl -n yuuvis edit deploy authentication


    • Extend the SPRING_PROFILES_ACTIVE environment variable with redis.
  • Restart all instances of the AUTHENTICATION service.

    • For example, instance 2 can be restarted using the following command:

      kubectl -n yuuvis scale deploy authentication --replicas=2