Everything within this section is only visible while editing. Use Page Properties ID "STUB", "REFACTURE", "PROGRESS", "rDEV", "rDOC", "rLANG" and "DONE". Everything contained within the table is displayed in the (INTERNAL) Reports page. | Product Version | 2022 Autumn |
|---|
| Report Note |
|
|---|
| Assignee | Antje |
|---|
Resources & Remarks Modification History Add a new line to this table and fill it whenever you edit the page. | Name | Date | Product Version | Action |
|---|
| Antje | 12 JUL 2022 | 2022 Autumn | page created and writing started | | Agnieszka | 06 SEP 2022 | 2022 Autumn | rLANG |
|
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 | | 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 serviceThe 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. CONFIGSERVICEA refresh leads to a synchronization of local resources and the git server in addition to the regular synchronization cycle.
>> CONFIGSERVICE |