Notes on the dtconsole Helm Chart

Overview

The dtconsole Helm Chart deploys the Digital Twin Console web application. As of Release 5.1 the Digital Twin Console is no longer included in the dtplatform chart and must be installed separately.

All resource names are prefixed with the {{ dtconsole.name }} function. This will result in a prefix of {{ Chart.Name }}- (unless using .Values.nameOverride). For example, the prefix would be dtconsole- if there is no .Values.nameOverride.

Note: All settings names listed below do not have the dtconsole- prefix since it can be updated by the installer. The Helm Chart will adjust the names as necessary.

Deployment Modes

The Digital Twin Console can be deployed two ways:

1. As a standalone nginx/web service serving the application directly
2. As a migration job that copies the static files to a shared PersistentVolumeClaim which is served by the staticwebsvc created by the dtplatform chart

The default values deploy in mode 2, which matches the default behavior of dtplatform.

To deploy in mode 1, set the following values:

ingress.platform-console-app.enabled=trueservice.platform-console-app.enabled=truedeployment.platform-console-app.enabled=truejob.platform-console-app-migrations.enabled=false

In this mode the staticwebsvc ingress in the dtplatform chart should not be configured to serve the app URL.

To deploy in mode 2, set the following values:

ingress.platform-console-app.enabled=falseservice.platform-console-app.enabled=falsedeployment.platform-console-app.enabled=falsejob.platform-console-app-migrations.enabled=truejob.platform-console-app-migrations.persistentVolumeClaimName=staticwebsvc

In mode 2 the dtplatform chart must be installed first so that the staticwebsvc PersistentVolumeClaim exists when the migration job runs.

Configuration Maps

The configuration maps (ConfigMaps) have references to environment variables (secret values) in the form of ${VARIABLE_NAME}. These are interpolated at runtime to avoid adding secrets to the Helm Chart values.

Global

The settings at config.global.* configure URLs that must match those configured in the dtplatform chart.

Key	Description	Default
config.global.url.app	URL for platform management applications	https://app.yourdomain.com
config.global.url.id	URL for platform identity management	https://id.yourdomain.com
config.global.url.api	URL for REST API	https://api.yourdomain.com
config.global.theme	Theme for installation (platform is only available value)	platform

External

The settings at config.external.* configure external services. The default values are empty and customer overrides are not typically required.

Internal

The settings at config.internal.* configure internal communication between the chart's resources. No changes or overrides should be made unless specifically directed by the support team.

Override

The settings at config.override.* configure per-resource overrides. The default values are empty.

Key	Description	Default
config.override.platform-console-app.*	Overrides for the platform-console-app deployment	{}
config.override.platform-console-app-migrations.*	Overrides for the platform-console-app-migrations job	{}

Chart Settings

Key	Description	Default
image.registry	The image registry	repo.yourdomain.com
image.prefix	Prefix to add to the image name used by dtconsole	""
image.suffix	Suffix to add to the image name used by dtconsole	""
image.pullPolicy	Kubernetes pull policy for image	Always
image.pullSecrets	List of image pull secret names	[]
image.tag	The image tag/label for the console application (defaults to chart appVersion if unset)	""
nameOverride	Name of the chart to use on resource names	""
fullnameOverride	Name of the chart and release to use on resource names (not used)	""
enablePodRestartAnnotation	Restart pods on Helm upgrade by adding a timestamp annotation	true
newrelic.enabled	Enable the NewRelic module (expects NEW_RELIC_LICENSE_KEY in the external secret)	false
opentelemetry.enabled	Enable the OpenTelemetry agent	false
opentelemetry.provider	OpenTelemetry provider type	none
opentelemetry.endpoint	OpenTelemetry endpoint URL	none
ingress.*	Settings for each ingress resource	Varies
service.*	Settings for each service resource	Varies
deployment.*	Settings for each deployment resource	Varies
statefulset.*	Settings for each statefulset resource	Varies
job.*	Settings for each job resource	Varies
horizontalpodautoscaler.*	Settings for each horizontalpodautoscaler resource	Varies