Skip to main content

Values reference

To adjust your OpenLM Platform installation, change the settings on this page. The chart has thousands of settings, because each component has its own, but you rarely need more than these. Every other setting keeps its chart default.

Global settings​

These settings sit under global in the values file:

SettingDefaultWhat it does
global.useOpenShiftfalsetrue: create OpenShift Routes instead of Ingresses, and leave pod user/group IDs to OpenShift.
global.securityContext.omitIdsfalsetrue: leave pod user/group IDs out without switching to Routes (for clusters that assign IDs, other than OpenShift).
global.affinity.enabledtrueRequire nodes labeled openlm.com/role. The installation guide sets false. See Node placement.
global.taints.enabledtrueTolerate openlm.com/role taints. The installation guide sets false.
global.masterIngress.enabledfalsetrue: one Ingress for the whole platform. The installation guide sets true.
global.masterIngress.hostname(empty)Your DOMAIN
global.masterIngress.ingressClassNamepublicYour ingress class
global.masterIngress.secretNameopenlm-lb-certTLS secret for the Ingress
global.masterIngress.apiBackendServicegateway-svc-openlm-gateway-tyk-gatewayService that receives /api. Matches the gateway release name openlm-gateway.
global.ingressAnnotationsnginx rewrite rulesAnnotations on the Ingress(es). The installation guide removes the rewrite rules.
global.routeSecurity.enabledtrueOpenShift Routes: add HSTS and security headers
global.routeSecurity.hstsMaxAge31536000HSTS max-age in seconds
global.routeSecurity.hstsIncludeSubDomainstrueHSTS includeSubDomains
global.traefikRoutes.enabledfalseAlternative routing with Traefik IngressRoutes instead of the API gateway. Leave off.
Defaults that differ from the guide

Several defaults differ from what the guide uses (affinity, taints, masterIngress). The guide's values file always sets them explicitly, so the defaults don't matter as long as you start from it.

Shared configuration​

Every service reads the settings in openlm_config_generic.configmap.vars_list. The values file sets the ones that depend on your installation, as the following table shows. Sign-in and identity or the comments of step 4 explain each one.

SettingSet to
LB_FQDN, INFRASTRUCTURE__LBFQDNDOMAIN
AUTHORITY_URL, INFRASTRUCTURE__AUTHORITYURL, IssuerUri, UI_BASE_HREF_URL, UI_OAUTH_ISSUER_URLhttps://DOMAIN/identity
OLM__K8s__ServiceNamespaceopenlm
INFRASTRUCTURE__ServerDbPrefix<DB_PREFIX>_operational
INFRASTRUCTURE__USESECURITYtrue
DbType, DB_TYPE, DbConnectionConfig__DbTypeSqlServer_SQLServerAuth

The guide sets openlm_telemetry_config_generic.configmap.vars_list.TELEMETRY__ENABLED to false. To send traces and metrics to your OpenTelemetry collector, set it to true together with TELEMETRY__COLLECTORENDPOINT.

Per-component settings​

Each component is a top-level key named after it (identity:, licensesui:, ...). You might need these settings for a component:

SettingWhat it does
<component>.enabledSwitch the component on or off
<component>.configmap.vars_list.<NAME>One configuration value of that service
<component>.resourcesCPU and memory requests and limits
<component>.pvc.storageClassNameStorage class, for the components that have a volume
<component>.ingress.hostnameHost name on its Route (OpenShift)
<component>.securityContext.podPod security context
<component>.secretsList of Secrets the component reads. Replacing it replaces the whole list.
One entry per component

Write each component once in your values file. A second entry with the same name replaces the first, including all its settings. If you need settings in a second place, put them in a second values file and pass both with -f. Helm merges files, but not duplicate entries inside one file.

See the defaults​

To see the top-level defaults, run:

helm show values openlm/openlm-platform --version "$OPENLM_VERSION" | less

A component's own defaults are in the chart package. To read them, pull and unpack the chart:

helm pull openlm/openlm-platform --version "$OPENLM_VERSION" --untar --untardir /tmp/openlm-chart
less /tmp/openlm-chart/openlm-platform/charts/<component>/values.yaml

The documentation team might draft this page using a large language model. A technical writer reviews every page and verifies it against the product before publishing it. A human makes the final decision.