Table of Contents |
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.
Resources & Remarks https://wiki.optimal-systems.de/display/devarchitektur/SystemService Modification History Add a new line to this table and fill it whenever you edit the page.
|
This core service manages schemata, role sets and app sets. Find here characteristics and configuration options. |
|
| Service Name | system |
|---|---|
| Port Range | 7400 |
| Profiles | prod,docker,redis,kubernetes,metrics |
| Helm Chart | yuuvis |
Schemata and role sets are important customizable configuration files. While role sets define access permissions, schemata define properties and object types that can be global, tenant- or app-specific. As of version 2021 Summer, the tenant-specific app sets define the availability of the different apps for each tenant.
The SYSTEM service treats calls of the public GET and POST endpoints for managing those configuration files. Any update of an active role set, app set or schema is communicated with other services that require this information. The behavior of the SYSTEM service can partially be configured according to the customer's needs.
The following endpoints provided by the API gateway are forwarded to the SYSTEM service.
Those endpoints deal with either global, tenant-specific or app-specific definitions of a role set or schema. The GET endpoints return the corresponding active configurations. The POST.../validation endpoints check whether a user-definded file is a valid configuration for the corresponding purpose. Also, the POST endpoints without /validation check whether the passed file is valid for the corresponding purpose. If valid, the new configuration is activated replacing the previous one. If invalid, an error will be thrown and the current configuration stays active.
| Availability | Role Set | Schema |
|---|---|---|
| global | ||
| tenant-specific | ||
| app-specific |
As of version 2021 Summer, the availability of an app for a specified tenant is managed in an app set via the following endpoints:
The yuuvis® Momentum configuration files for the operation in the Kubernetes cluster are stored on the Git Server configured in the system. In order to change the configuration of a service, you need to access the Git repository.
Note: The schema.xml, roleset.xml and apps.xml files are stored via the configuration service (CONFIG). Thus, they are also saved in Git. In contrast to the service configuration files, these files (schema, role set etc.) should only be changed using the yuuvis® Momentum API.
The following parameters are referenced from the corresponding profiles. Click a profile in order to display descriptions and default values of the corresponding parameters.
| Profile | Parameter |
|---|---|
| system-prod.yml | schema.changed.observers |
schema.tenant.properties.limit | |
|
The values for the parameters can be modified as described here.
>> Configuring Services using Profiles.
Read on
|