rework/rework-web-service

Deployment configuration settings

Those are defined as environment variables and typically do not need to change during runtime. Below is a description of those available.

Table 1. Deployment configuration settings
Environment Variable	Description	Default Value
Logging Settings
NEXEED_REWORK_WEB_Logging__LogLevel__Default	Sets the default log level for log messages.	Information
NEXEED_REWORK_WEB_Logging__LogLevel__Microsoft	Sets the default log level for log messages with scope of Microsoft.	Warning
NEXEED_REWORK_WEB_Logging__LogLevel__Microsoft.Hosting.Lifetime	Sets the default log level for log messages with scope of Microsoft.Hosting.Lifetime.	Information
NEXEED_REWORK_WEB_ReworkBackendBaseUrl	Sets the base URL of Rework Control backend service.	Placeholder value <url>. In Helm deployments, value is set automatically to match the URL of the backend service.
Tenant Settings
NEXEED_REWORK_WEB_TenantConfig__Tenant0	The tenant0 identifier.	Placeholder value <tenant-id>, which is invalid. In Helm deployments, value is set automatically to match the tenant for the umbrella chart deployment.
NEXEED_REWORK_WEB_Portal__TenantId	The tenant identifier to be used for portal registration.	Placeholder value <tenant-id>, which is invalid. In Helm deployments, value is set automatically to match the tenant for the umbrella chart deployment.
OpenID Connect (OIDC) Settings
NEXEED_REWORK_WEB_OIDC__ServiceUrl	The URL of MACMA.	Placeholder value <server>/iam/, which is invalid. In Helm deployments, value matches the MACMA deployment via the umbrella chart.
NEXEED_REWORK_WEB_OIDC__ClientId	The client ID value for Rework Control defined in MACMA.	Placeholder value <rework-client-id>, which is invalid. In Helm deployments, value is set automatically to match the MACMA deployment via the umbrella chart.
NEXEED_REWORK_WEB_OIDC__PublicClientId	The public client ID value for Rework Control defined in MACMA.	Placeholder value <rework-client-id>-frontend, which is invalid. In Helm deployments, value is set automatically to match the MACMA deployment via the umbrella chart.
NEXEED_REWORK_WEB_OIDC__ClientSecret	The client Secret value for Rework Control defined in MACMA.	Placeholder value <rework-client-secret>, which is invalid. In Helm deployments, value is set automatically to match the MACMA deployment via the umbrella chart.
NEXEED_REWORK_WEB_OIDC__Acl__RefreshInterval	How often the ACLs should be refreshed in seconds.	60
NEXEED_REWORK_WEB_OIDC__Introspection__EnableCaching	Whether or not caching should be enabled for results returned by the introspection endpoint.	false
NEXEED_REWORK_WEB_OIDC__Introspection__CachingDuration	How long introspection results should be cached in seconds. It is recommended to be less than 1 minute.	30
OIDC Clients Settings
NEXEED_REWORK_WEB_OIDC__NamedHttpClients__DefaultTokenEndpoint	The default endpoint to use for fetching access tokens from MACMA.	Placeholder value <server>/iam/auth/realms/<tenant-id>/protocol/openid-connect/token which is invalid. In Helm deployments, value is set automatically to match the MACMA deployment via the umbrella chart.
NEXEED_REWORK_WEB_OIDC__NamedHttpClients__Clients__PortalClient__Scopes__0	The scope needed when requesting access token for Nexeed Web Portal API.	Placeholder value aud:<portal-client-id> which is invalid. In Helm deployments, value is set automatically to match the client ID of Nexeed Web Portal generated in MACMA.
Nexeed Web Portal Integration Settings
NEXEED_REWORK_WEB_Portal__TenantId	This is the identifier for the tenant which owns Rework Control module ("software providing tenant"), this is the tenant on which the module is registered at MACMA. This will fall back to the root tenant (TenantConfig:Tenant0) if the value is not provided.	Placeholder value <tenant-id> which is invalid.
NEXEED_REWORK_WEB_Portal__Url	The base URL of the Nexeed Web Portal to register with.	Placeholder value <server> which is invalid. In Helm deployments, value is set automatically to match the Nexeed Web Portal deployment via the umbrella chart.
NEXEED_REWORK_WEB_Portal__Info__Id	The ID of Rework Control module to use in the portal. It is typically set to match the client ID in MACMA.	Placeholder value <client-id> which is invalid. In Helm deployments, value is set automatically to match the client ID of Rework Controll generated in MACMA.
NEXEED_REWORK_WEB_Portal__Info__Version	The version of Rework Control to display in the portal.	Placeholder value 0.0.0 which is invalid. In Helm deployments, value is automatically set to the version 6.3, which matches the image version.
NEXEED_REWORK_WEB_Portal__Info__BaseUrl	The base URL of Rework Control.	Placeholder value <server> which is invalid. In Helm deployments, value is automatically set to the base URL of 6.3.
NEXEED_REWORK_WEB_Portal__Info__AuthProviderClientId	The client ID of Rework Control. This is included in the scope field when the portal authorizes its client for calling the portal-related known endpoints in Rework Control.	Placeholder value <client-id> which is invalid. In Helm deployments, value is set automatically to match the client ID of Rework Controll generated in MACMA.
Health Checks Settings In the keys below, <CheckName> is the name of the health check. The name is used to identify the check in the logs and in the health check endpoint response. The name is also used to identify the check in the configuration settings. The values that are defined by default for this placeholder are MACMA and ReworkBackend.
NEXEED_REWORK_WEB_HealthChecks__S2s__<CheckName>_BaseUrl	The base URL of the service for which to check its health.	empty string
NEXEED_REWORK_WEB_HealthChecks__S2s__<CheckName>_BaseUrlConfigKey	The configuration key path to the base URL for the service to check. This setting is used only if NEXEED_REWORK_WEB_HealthChecks__S2s__<CheckName>_BaseUrl is not set.	For MACMA the value OIDC:ServiceUrl. For Rework Backend the value ReworkBackendBaseUrl.
NEXEED_REWORK_WEB_HealthChecks__S2s__<CheckName>_CheckType	The type of endpoint to check for health of the corresponding service. Allowed values are Ping (for <baseUrl>/ping) and Health (for <baseUrl>/health).	Ping
NEXEED_REWORK_WEB_HealthChecks__S2s__<CheckName>_Required	Whether the check is mandatory or optional to pass. If it is required and the result was `unhealthy`, then it will make the backend service also `unhealthy`, and it will stop receiving external requests. If it was optional and failed, the backend service health will be `degraded`, and it will continue serving external requests.	true: for MACMA, LineControl, DataBrowser and DataCollector false: otherwise.
NEXEED_REWORK_WEB_HealthChecks__S2s__<CheckName>_Enabled	Whether the check is enabled. If false, then the corresponding check won’t be made at all and won’t be included in the backend health checks.	true.