Use monitoring and maintenance endpoints of a service running in your yuuvis® Momentum cluster.

Introduction

The core services offer /manage/* endpoints to retrieve service-specific operational information, reload configurations or execute other maintenance operations. These endpoints are intended to be called by other services within the cluster. Most services use the functionality of the Spring Boot Actuator. However, for some services, the basic behavior is adjusted or extended.
>> Spring Boot Actuator Web API Documentation.

The /manage/* endpoints provided by the AUTHENTICATION Service are available via a separate port which is protected from external access. Even if they are exposed for access without a specific authorization in the authentication-prod.yml file, they are accessible only for services inside the Kubernetes cluster. In order to call these endpoints, the ancillary Kubernetes Service authentication-manage-service controls the separate port. Thus, the endpoints are called via /authentication-manage/manage/*.

'`/manage/*`' Endpoints

Endpoint Usage in yuuvis® Momentum Services with adjusted behavior

GET <service>/manage/health

Check the current status of a service running in your yuuvis® Momentum cluster.

Available for all services including additional services.

The JSON structure always contains at least the "status" key with the value being either "UP" or "DOWN".

POST <service>/manage/refresh

As of version 2022 Autumn:
GET /authentication-internal/manage/refreshTenants

Reload configurations for the specified service without a service restart.

AUTHENTICATION service

The endpoint /authentication-internal/manage/refreshTenants can be used to activate changes in the tenant configuration instead of the conventional refresh endpoint. Only changes in the authentication.oauth2.tenants list in the application-oauth2.yml configuration file are considered. Thus, the creation or modification of tenants can be carried out much faster.
Note: Tenants that were removed from the configuration are NOT automatically deleted.

CONFIGSERVICE

A refresh leads to a synchronization of local resources and the git server in addition to the regular synchronization cycle.
>> CONFIGSERVICE

Read on

COMMANDER Service for System Maintenance

Perform low-level maintenance on your core system, access the database and carry out Elasticsearch queries. Keep reading

yuuvis® Postman Collections

Postman is a free API development tool with a multitude of useful functions for automated testing, documentation, and more. Our yuuvis® Postman Collections kick-start you right into the yuuvis® API world. Keep reading

Installation and Configuration

Guidelines and information for the installation and configuration of the core system. Keep reading

Browser not supported