Notes on Helm Charts

Overview

This page contains useful notes on configuring Helm Charts that can used as a resource when setting up SMI.

Digital Twin Platform Helm Chart

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

By default, this means that the Digital Twin Platform can only be installed once in a Kubernetes namespace. While it might be possible with the appropriate changes to chart values, it is not suggested.

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

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 settings used across much of the platform.

Key	Description	Default
config.global.name	Name of environment	Digital Twin Platform
config.global.description	Description of environment	Platform to Digital Twin Anything
config.global.shortname	Short (alpahnumeric) string to represent environment name	prod1
config.global.email	Email used for delivery of transactional emails	do-not-reply@yourdomain.com
config.global.from	Name used in From: field of emails	Digital Twin Platform
config.global.owner	Platform manager/owner email address to create initial user	first.last@yourdomain.com
config.global.initial_password	Platform manager/owner password (will be autogenerated and presented in installation output or found in passportsvc-internal secret)	${INITIAL_OWNER_PASSWORD}
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.cloud.provider	Allowed values are aws (Amazon Web Services), oci Oracle Cloud Infrastructure	aws
config.global.cloud.region	Cloud region where platform is installed	us-west-2
config.global.cloud.namespace	Object Storage namespace (only for oci installations)	""
config.global.cloud.bucket.kafka	Bucket name for Kafka-based Request/Reply process	XXXXX-dtplatform-prod1-kafka
config.global.cloud.bucket.filesvc	Bucket name for File Service storage	XXXXX-dtplatform-prod1-filesvc
config.global.cloud.bucket.scriptmanager	Bucket name for Script Manager storage	XXXXX-dtplatform-prod1-scriptmanager
config.global.cloud.bucket.datasourcesvc	Bucket name for Datasource Service storage	XXXXX-dtplatform-prod1-datasourcesvc
config.global.cloud.cdn.filesvc.domain	CloudFront distribution domain (only required for aws installations)	XXXXX.cloudfront.net
config.global.cloud.cdn.filesvc.key_id	CloudFront distribution domain (only required for aws installations)	${FILESVC_AWS_CLOUDFRONT_KEYID}
config.global.cloud.cdn.filesvc.key_file	CloudFront distribution domain (only required for aws installations)	${FILESVC_AWS_CLOUDFRONT_KEYFILE}
config.global.theme	Theme for installation (platform is only available value)	platform

Internal

The settings at config.internal.* configure the platform services to communicate with one another and share secrets. No changes or overrides should made unless specifically directed by the support team.

External

The settings at config.external.* configure the external services that the platform services communicate with (such as database, queue, cache, etc.).

Chart Settings

Key	Description	Default
image.registry	The image registry for	repo.yourdomain.com
image.prefix	Prefix to add to the image name used by dtplatform	""
image.suffix	Suffix to add to the image name used by dtplatform	""
image.pullPolicy	Kubernetes pull policy for image	Always
image.tag.platform	The image tag/label for the core DT Platform components	4.3.162
image.tag.platformiam	The image tag/label for the DT Platform identity component	1.0.149
image.tag.platformplugins	The image tag/label for the DT Platform CAD plugin component	4.3.5
image.tag.platformconsoleapp	The image tag/label for the DT Platform console application component	2.0.75
image.tag.platformreferenceapp	The image tag/label for the DT Platform reference application component	3.1.51
nameOverride	Name of the chart to use on resource names	""
fullnameOverride	Name of the chart and release to use on resource names (not used)	""
createPlaceholderSecrets	Special flag to create "empty" Kubernetes secret objects for external secrets as a placeholder	false
opentelemetry.enabled	Boolean to enable 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
secretDef.*	Definitions for each required secret along with description (DO NOT CHANGE, but see below for more details)	Varies