Diese Seite ist nur auf Englisch verfügbar.
Helm Configuration
Standardized Helm Configuration Parameters
This module in general follows the general IAS Operations Manual and the helm parameters that are described there e.g. for logging, databases, messaging, …
Module Helm Configuration Parameters
| Helm Parameter |
.Values.global.modules.macma.keycloakBCIMasterdataClientId |
| Description |
The environment’s MACMA client id. |
| Mandatory |
No |
| Default Value |
- |
| Helm Parameter |
.Values.global.modules.macma.keycloakBCIMasterdataClientSecret |
| Description |
The environment’s MACMA client secret. |
| Mandatory |
Yes |
| Default Value |
- |
| Helm Parameter |
.Values.global.nexeedMacmaTenant0Id |
| Description |
The ID of the root tenant. Default realm for registration at portal and login. |
| Mandatory |
Yes |
| Default Value |
- |
| Helm Parameter |
.Values.global.modules.macma.tenant0InitialName |
| Description |
The initial name of the root tenant. After the initial setup, changing this value will have no effect. |
| Mandatory |
No (but highly recommended to set the correct value for the initial setup) |
| Default Value |
first customer tenant |
| Helm Parameter |
.Values.global.modules.macma.keycloakClientSecret |
| Description |
Client secret of the admin client in the master realm, which is required by MACMA to control Keycloak. |
| Mandatory |
Yes |
| Default Value |
- |
| Helm Parameter |
.Values.global.modules.portal.macmaPortalAdminUser |
| Description |
Name of the admin user created on bootstrapping. |
| Mandatory |
No, but if not provided no admin user will be created. |
| Default Value |
- |
| Helm Parameter |
.Values.global.modules.portal.macmaPortalAdminPassword |
| Description |
Password of the admin user created on bootstrapping. Has to be changed on first login. |
| Mandatory |
No, but required if .Values.global.modules.portal.macmaPortalAdminUser is set. |
| Default Value |
- |
| Helm Parameter |
.Values.local.tokenIntrospection.recommendedUserTokenTrustInSeconds |
| Description |
Maximum recommended cache time (in s) for introspection results sent by MACMA for user tokens (should be small). |
| Mandatory |
No |
| Default Value |
5 |
| Helm Parameter |
.Values.local.tokenIntrospection.recommendedClientTokenTrustInSeconds |
| Description |
Maximum recommended cache time (in s) for introspection results sent by MACMA for client tokens. |
| Mandatory |
No |
| Default Value |
150 |
| Helm Parameter |
.Values.local.fileUploadMaxSizeInMB |
| Description |
Maximum allowed filesize for file upload e.g. for configuration file. Increasing the value can cause OutOfMemory errors. The value for defaultMaxBodySizeInMB has to be larger or equal to fileUploadMaxSizeInMB. |
| Mandatory |
No |
| Default Value |
8 |
| Helm Parameter |
.Values.local.defaultMaxBodySizeInMB |
| Description |
Maximum allowed request body size. |
| Mandatory |
No |
| Default Value |
8 |
| Helm Parameter |
.Values.local.logging.default with default .Values.global.logging.default |
| Description |
Default loglevel except for the following explicit settings. |
| Mandatory |
No |
| Default Value |
WARN |
| Helm Parameter |
.Values.local.logging.spring.default |
| Description |
Loglevel for everything Spring (but not Spring Boot). |
| Mandatory |
No |
| Default Value |
WARN |
| Helm Parameter |
.Values.local.logging.spring.boot |
| Description |
Loglevel for everything Spring Boot. |
| Mandatory |
No |
| Default Value |
WARN |
| Helm Parameter |
.Values.local.logging.spring.security |
| Description |
Loglevel for everything Spring SECURITY. |
| Mandatory |
No |
| Default Value |
WARN |
| Helm Parameter |
.Values.local.logging.application with default .Values.global.logging.application |
| Description |
Loglevel for Bosch Components. |
| Mandatory |
No |
| Default Value |
WARN |
| Helm Parameter |
.Values.local.logging.netty |
| Description |
Loglevel for Netty. |
| Mandatory |
No |
| Default Value |
WARN |
| Helm Parameter |
.Values.local.logging.hibernate |
| Description |
Loglevel for Hibernate. |
| Mandatory |
No |
| Default Value |
WARN |
| Helm Parameter |
.Values.local.logging.liquibase |
| Description |
Loglevel for Liquibase. |
| Mandatory |
No |
| Default Value |
WARN |
| Helm Parameter |
.Values.local.logging.security |
| Description |
Loglevel for security logger. |
| Mandatory |
No |
| Default Value |
INFO |
| Helm Parameter |
.Values.local.logging.lifecycle |
| Description |
Loglevel for lifecycle logger. |
| Mandatory |
No |
| Default Value |
INFO |
| Helm Parameter |
.Values.local.logging.activityLogsRetentionTimeInDays |
| Description |
Activity Logs Retention time in days |
| Mandatory |
No |
| Default Value |
90 |
| Helm Parameter |
.Values.local.activityLogsCleanupInitialDelayInMinutes |
| Description |
Delay (in minutes) after application startup when the Activity Logs Clean-up task is started |
| Mandatory |
No |
| Default Value |
1 |
| Helm Parameter |
.Values.local.activityLogsCleanupFixedDelayInHours |
| Description |
Scheduled period (in hours) when the Activity Logs Clean-up task is executed |
| Mandatory |
No |
| Default Value |
24 |
| Helm Parameter |
.Values.local.keycloakDatabaseBackgroundValidationDuration |
| Description |
Specify the Duration between liveness-checks for pooled DB connections (optional, default is '55S' as it should not be the same value as idle-timeout(minutes)); the format for durations uses the standard java.time.Duration format. You can learn more about it in the [Duration#parse() javadoc](https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html#parse-java.lang.CharSequence-). Influences failover behavior. |
| Mandatory |
No |
| Default Value |
55S |
| Helm Parameter |
.Values.global.modules.macma.keycloakUser |
| Description |
Admin user for Keycloak. |
| Mandatory |
Yes |
| Default Value |
- |
| Helm Parameter |
.Values.global.modules.macma.keycloakPassword |
| Description |
Password for admin user for Keycloak. |
| Mandatory |
Yes |
| Default Value |
- |
| Helm Parameter |
.Values.global.modules.macma.contextPath |
| Description |
Context path "in between" the origin and specific paths offered by Keycloak. If MACMA is offered under a sub-path (e.g. `https://testSystemA.de.bosch.com:8088/iam/`) (instead of a sub-domain like `https://iam.testSystemA.de.bosch.com:8088/`) this should be set to the sub-path (here `iam`). |
| Mandatory |
No |
| Default Value |
"iam" |
| Helm Parameter |
.Values.local.keycloak.macmaMigrationsTimeoutSeconds |
| Description |
Sets the timeout in seconds for MACMA’s Keycloak migrations that run during startup. |
| Mandatory |
No |
| Default Value |
3600 |
| Helm Parameter |
.Values.local.keycloak.quarkus.transactionManager.defaultTransactionTimeout |
| Description |
Sets the timeout that applies to all Keycloak transactions managed by the transaction manager; the format for durations uses the standard java.time.Duration format (https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)) |
| Mandatory |
No |
| Default Value |
PT3600S |
| Helm Parameter |
.Values.local.keycloakSocketTimeout |
| Description |
Socket inactivity timeout in milliseconds. Can be increased if you have integrated slow IDPs and get sporadic `Unexpected error when authenticating with identity provider` while authenticating with an identity provider _and_ you have ruled out other possibilities. |
| Mandatory |
No |
| Default Value |
15000 |
| Helm Parameter |
.Values.local.logging.keycloak.default |
| Description |
Loglevel for everything Keycloak |
| Mandatory |
No |
| Default Value |
WARN |
| Helm Parameter |
.Values.local.logging.keycloak.security |
| Description |
Loglevel for keycloak security logger. |
| Mandatory |
No |
| Default Value |
INFO |
| Helm Parameter |
.Values.local.logging.keycloak.lifecycle |
| Description |
Loglevel for keycloak lifecycle logger. |
| Mandatory |
No |
| Default Value |
INFO |
| Helm Parameter |
.Values.local.logging.keycloak.infinispan |
| Description |
Loglevel for keycloak infinispan cache logger. |
| Mandatory |
No |
| Default Value |
WARN |
| Helm Parameter |
.Values.local.logging.keycloak.jGroups |
| Description |
Loglevel for JGroups |
| Mandatory |
No |
| Default Value |
WARN |
| Helm Parameter |
.Values.local.infinispan.enableStatistics |
| Description |
Enable cache statistics on the /metrics endpoint. |
| Mandatory |
No |
| Default Value |
false |
| Helm Parameter |
.Values.local.infinispan.realmCacheSize |
| Description |
Size of cache persisted realm data. |
| Mandatory |
No |
| Default Value |
10000 |
| Helm Parameter |
.Values.local.infinispan.realmCacheMaxIdle |
| Description |
Specifies the maximum amount of time, in milliseconds, that realm data cache entries can remain idle. Can be disabled with a value of -1. |
| Mandatory |
No |
| Default Value |
-1 |
| Helm Parameter |
.Values.local.infinispan.usersCacheSize |
| Description |
Size of cache persisted users data |
| Mandatory |
No |
| Default Value |
10000 |
| Helm Parameter |
.Values.local.infinispan.usersCacheMaxIdle |
| Description |
Specifies the maximum amount of time, in milliseconds, that users data cache entries can remain idle. Can be disabled with a value of -1. |
| Mandatory |
No |
| Default Value |
-1 |
| Helm Parameter |
.Values.local.infinispan.authorizationCacheSize |
| Description |
Size of cache persisted authorization data. |
| Mandatory |
No |
| Default Value |
10000 |
| Helm Parameter |
.Values.local.infinispan.authorizationCacheMaxIdle |
| Description |
Specifies the maximum amount of time, in milliseconds, that authorization data cache entries can remain idle. Can be disabled with a value of -1. |
| Mandatory |
No |
| Default Value |
-1 |
| Helm Parameter |
.Values.local.infinispan.keysCacheSize |
| Description |
Size of cache persisted external public keys. |
| Mandatory |
No |
| Default Value |
1000 |
| Helm Parameter |
.Values.local.infinispan.keysMaxIdle |
| Description |
Specifies the maximum amount of time, in milliseconds, that keys data cache entries can remain idle. Can be disabled with a value of -1. |
| Mandatory |
No |
| Default Value |
3600000 |
| Helm Parameter |
.Values.local.infinispan.remoteTimeout |
| Description |
The timeout (in ms) used to wait for an acknowledgment when making a remote call to another keycloak instance, after which the call is aborted and an exception is thrown. |
| Mandatory |
No |
| Default Value |
15000 |
| Helm Parameter |
.Values.local.infinispan.lockAcquisitionTimeout |
| Description |
Maximum time to attempt a particular lock acquisition. |
| Mandatory |
No |
| Default Value |
10000 |
| Helm Parameter |
.Values.local.infinispan.sessionsCacheSize |
| Description |
Size of cache persisted user session data. |
| Mandatory |
No |
| Default Value |
10000 |
| Helm Parameter |
.Values.local.infinispan.clientSessionsCacheSize |
| Description |
Size of cache persisted client session data. |
| Mandatory |
No |
| Default Value |
10000 |
| Helm Parameter |
.Values.local.infinispan.offlineSessionsCacheSize |
| Description |
Size of cache persisted offline user session data. |
| Mandatory |
No |
| Default Value |
10000 |
| Helm Parameter |
.Values.local.infinispan.offlineClientSessionsCacheSize |
| Description |
Size of cache persisted offline client session data. |
| Mandatory |
No |
| Default Value |
10000 |
| Helm Parameter |
.Values.local.infinispan.lockingType |
| Description |
The locking mode for all keycloak infinispan cache, one of OPTIMISTIC or PESSIMISTIC. |
| Mandatory |
No |
| Default Value |
OPTIMISTIC |
| Helm Parameter |
.Values.local.keycloak.initialRamPercentage |
| Description |
Specify the initial Java heap size percentage from the containers limit (optional, default is `20`) |
| Mandatory |
No |
| Default Value |
20 |
| Helm Parameter |
.Values.local.keycloak.maxRamPercentage |
| Description |
Specify the maximum Java heap size percentage from the containers limit (optional, default is `80`) |
| Mandatory |
No |
| Default Value |
60 |
| Helm Parameter |
.Values.local.keycloak.liquibase.defaultIndexCreationThreshold |
| Description |
If the number of records in a database table exceeds this threshold, the index is not created. Instead, you will find a warning in the server logs with the SQL commands that you can apply manually. To disable this threshold set a value ≤ 0. (optional, default is `0`) |
| Mandatory |
No |
| Default Value |
0 |
| Helm Parameter |
.Values.global.modules.macma.portalName |
| Description |
Name of the portal module. For registration the id of the portal’s client is searched by this name to get a proper token. |
| Mandatory |
No |
| Default Value |
0 |
| Helm Parameter |
.Values.local.observability.otelAutoInjectEnvParams |
| Description |
Whether the standardized Open Telemetry environment variables should be automatically injected into the pods. See the general Nexeed IAS operations manual 'Open Telemetry integration' chapter for more details. |
| Mandatory |
No |
| Default Value |
true |
| Helm Parameter |
.Values.local.core.initialRamPercentage |
| Description |
Specify the initial Java heap size percentage from the containers limit (optional) |
| Mandatory |
No |
| Default Value |
25 |
| Helm Parameter |
.Values.local.core.maxRamPercentage |
| Description |
Specify the maximum Java heap size percentage from the containers limit (optional) |
| Mandatory |
No |
| Default Value |
70 |
| Helm Parameter |
.Values.local.webapp.initialRamPercentage |
| Description |
Initial Java heap size as a percentage of the container memory limit (`-XX:InitialRAMPercentage`). |
| Mandatory |
No |
| Default Value |
10 |
| Helm Parameter |
.Values.local.webapp.maxRamPercentage |
| Description |
Maximum Java heap size as a percentage of the container memory limit (`-XX:MaxRAMPercentage`). Leave room for non-heap and native memory. Very small limits may use JVM `MinRAMPercentage` sizing instead. |
| Mandatory |
No |
| Default Value |
40 |