Appendix C: Mapping KOTS configuration to Helm values

Amanda Jennewein
Amanda Jennewein
  • Updated

If you have an existing KOTS stack and want to copy settings from the KOTS Config tab, use the following tables to find the equivalent Helm value for each field.

Core Jama Application Settings

KOTS config field

Equivalent Helm chart value

Core Jama Application Settings > Requests CPU

core.resources.requests.cpu

Core Jama Application Settings > Max CPU

core.resources.limits.cpu

Core Jama Application Settings > Requests Memory

core.resources.requests.memory

Core Jama Application Settings > Max Memory

core.application.env.MAX_HEAP

Core Jama Application Settings > Max Memory for Container

core.resources.limits.memory

Core Jama Application Settings > Enable Horizontal Scaling

global.core.enableHorizontalScaling

Core Jama Application Settings > Minimum amount of ingress nodes

core.replicaCounts.ingress

Core Jama Application Settings > Minimum amount of job nodes

core.replicaCounts.jobs

Core Jama Application Settings > Minimum amount of report nodes

core.replicaCounts.reports

Core Jama Application Settings > Liveness Probe > Initial Delay

core.container.livenessInitialDelay

Core Jama Application Settings > Liveness Probe > Period

core.container.livenessPeriod

Core Jama Application Settings > Liveness Probe > Timeout

core.container.livenessTimeout

Core Jama Application Settings > Liveness Probe > Success Threshold

core.container.livenessSuccessThreshold

Core Jama Application Settings > Liveness Probe > Failure Threshold

core.container.livenessFailureThreshold

Core Jama Application Settings > Readiness Probe > Initial Delay

core.container.readinessInitialDelay

Core Jama Application Settings > Readiness Probe > Period

core.container.readinessPeriod

Core Jama Application Settings > Readiness Probe > Timeout

core.container.readinessTimeout

Core Jama Application Settings > Readiness Probe > Success Threshold

core.container.readinessSuccessThreshold

Core Jama Application Settings > Readiness Probe > Failure Threshold

core.container.readinessFailureThreshold

Ingress

KOTS config field

Equivalent Helm chart value

Kubernetes Configuration > Ingress Class Name 

ingress.className

Web Server > Context path

global.url.contextPath

Web Server > Use TLS

global.url.secure

Web Server > Port

global.url.httpPort

If using the bundled Traefik:

traefik.ports.web.nodePort

SSL Settings > TLS port

global.url.httpsPort

If using the bundled Traefik:

traefik.ports.websecure.nodePort

Host Name > Host name

global.url.domain

Host Name > TLS Key Pair Source > Custom TLS Configuration
TLS Configuration > Private Key
TLS Configuration > Certificate

ingress.tls.key
ingress.tls.cert

Host Name > TLS Key Pair Source > Generate New

ingress.tls.generateSelfSigned

Trusted Certificates > Upload certificate file

core.secrets.trustedCertificates.data

External SSL Settings > TLS managed externally

traefik.ports.web.forwardedHeaders.insecure
traefik.ports.websecure.forwardedHeaders.insecure

Storage

KOTS config field Equivalent Helm chart value
Storage > Storage Class global.storageClass
Storage > Assets Size core.application.storage.sharedVolume.request
Storage > Assets Storage Class core.application.storage.sharedVolume.storageClass
Storage > Assets PVC Access Mode core.application.storage.sharedVolume.accessMode

Database

KOTS config field Equivalent Helm chart value
Database Settings > Type/vendor global.database.type
Database Settings > Host global.database.host
Database Settings > Port global.database.port
Database Settings > Database global.database.schema
Database Settings > User name core.application.database.connect.username
Database Settings > Password core.application.database.connect.password
Database Settings > SAML database schema core.saml.application.database.schema
Database Settings > SAML user name core.saml.application.database.username
Database Settings > SAML password core.saml.application.database.password
Database Settings > OAuth database schema core.oauth.application.database.schema
Database Settings > OAuth user name core.oauth.application.database.username
Database Settings > OAuth password core.oauth.application.database.password
Database Settings > Quartz database schema core.application.database.quartz.schema
Database Settings > Quartz user name core.application.database.quartz.username
Database Settings > Quartz password core.application.database.quartz.password
Advanced DB Settings > Database connection parameters global.database.connectionParameters
Advanced DB Settings > SAML database schema connection parameters core.saml.application.database.connectionParameters
Advanced DB Settings > OAuth database schema connection parameters core.oauth.application.database.connectionParameters
Advanced DB Settings > Database driver global.database.driver
Possible values:
net.sourceforge.jtds.jdbc.Driver
com.microsoft.sqlserver.jdbc.SQLServerDriver

OpenSearch Settings

KOTS config field Equivalent Helm chart value
OpenSearch Settings > Max CPU core.search.opensearch.resources.limits.cpu
OpenSearch Settings > Max Memory core.search.opensearch.application.env.MAX_HEAP
OpenSearch Settings > Max Memory for Container core.search.opensearch.resources.limits.memory
OpenSearch Settings > Volume Size core.search.opensearch.application.storage.request
OpenSearch Settings > Amount of OpenSearch nodes core.search.opensearch.replicaCount
OpenSearch Settings > Liveness Probe > Initial Delay core.search.opensearch.container.livenessInitialDelay
OpenSearch Settings > Liveness Probe > Period core.search.opensearch.container.livenessPeriod
OpenSearch Settings > Liveness Probe > Timeout core.search.opensearch.container.livenessTimeout
OpenSearch Settings > Liveness Probe > Success Threshold core.search.opensearch.container.livenessSuccessThreshold
OpenSearch Settings > Liveness Probe > Failure Threshold core.search.opensearch.container.livenessFailureThreshold
OpenSearch Settings > Readiness Probe > Initial Delay core.search.opensearch.container.readinessInitialDelay
OpenSearch Settings > Readiness Probe > Period core.search.opensearch.container.readinessPeriod
OpenSearch Settings > Readiness Probe > Timeout core.search.opensearch.container.readinessTimeout
OpenSearch Settings > Readiness Probe > Success Threshold core.search.opensearch.container.readinessSuccessThreshold
OpenSearch Settings > Readiness Probe > Failure Threshold core.search.opensearch.container.readinessFailureThreshold

Search Service Settings

KOTS config field Equivalent Helm chart value
Search Service Settings > Max CPU core.search.resources.limits.cpu
Search Service Settings > Max Memory For Service core.search.application.env.MAX_HEAP
Search Service Settings > Max Memory for Container core.search.resources.limits.memory
Search Service Settings > Number of primary shards core.search.application.env.DEFAULT_NUMBER_OF_SHARDS
Search Service Settings > Number of replicas core.search.application.env.DEFAULT_NUMBER_OF_REPLICAS
Search Service Settings > Liveness Probe > Initial Delay core.search.container.livenessInitialDelay
Search Service Settings > Liveness Probe > Period core.search.container.livenessPeriod
Search Service Settings > Liveness Probe > Timeout core.search.container.livenessTimeout
Search Service Settings > Liveness Probe > Success Threshold core.search.container.livenessSuccessThreshold
Search Service Settings > Liveness Probe > Failure Threshold core.search.container.livenessFailureThreshold
Search Service Settings > Readiness Probe > Initial Delay core.search.container.readinessInitialDelay
Search Service Settings > Readiness Probe > Period core.search.container.readinessPeriod
Search Service Settings > Readiness Probe > Timeout core.search.container.readinessTimeout
Search Service Settings > Readiness Probe > Success Threshold core.search.container.readinessSuccessThreshold
Search Service Settings > Readiness Probe > Failure Threshold core.search.container.readinessFailureThreshold

ActiveMQ Service Settings

KOTS config field Equivalent Helm chart value
ActiveMQ Service Settings > Max CPU core.activemq.resources.limits.cpu
ActiveMQ Service Settings > Max Memory core.activemq.application.java.xmx
ActiveMQ Service Settings > Max Memory for Container core.activemq.resources.limits.memory
ActiveMQ Service Settings > Min Large Message Size in Bytes core.activemq.application.client.minLargeMessageSizeInBytes
ActiveMQ Service Settings > Liveness Probe > Initial Delay core.activemq.container.livenessInitialDelay
ActiveMQ Service Settings > Liveness Probe > Period core.activemq.container.livenessPeriod
ActiveMQ Service Settings > Liveness Probe > Timeout core.activemq.container.livenessTimeout
ActiveMQ Service Settings > Liveness Probe > Success Threshold core.activemq.container.livenessSuccessThreshold
ActiveMQ Service Settings > Liveness Probe > Failure Threshold core.activemq.container.livenessFailureThreshold
ActiveMQ Service Settings > Readiness Probe > Initial Delay core.activemq.container.readinessInitialDelay
ActiveMQ Service Settings > Readiness Probe > Period core.activemq.container.readinessPeriod
ActiveMQ Service Settings > Readiness Probe > Timeout core.activemq.container.readinessTimeout
ActiveMQ Service Settings > Readiness Probe > Success Threshold core.activemq.container.readinessSuccessThreshold
ActiveMQ Service Settings > Readiness Probe > Failure Threshold core.activemq.container.readinessFailureThreshold

Diff Service Settings

KOTS config field Equivalent Helm chart value
Diff Service Settings > Max CPU core.diff.resources.limits.cpu
Diff Service Settings > Max Memory core.diff.application.env.MAX_HEAP
core.diff.resources.limits.memory
Diff Service Settings > Liveness Probe > Initial Delay core.diff.container.livenessInitialDelay
Diff Service Settings > Liveness Probe > Period core.diff.container.livenessPeriod
Diff Service Settings > Liveness Probe > Timeout core.diff.container.livenessTimeout
Diff Service Settings > Liveness Probe > Success Threshold core.diff.container.livenessSuccessThreshold
Diff Service Settings > Liveness Probe > Failure Threshold core.diff.container.livenessFailureThreshold
Diff Service Settings > Readiness Probe > Initial Delay core.diff.container.readinessInitialDelay
Diff Service Settings > Readiness Probe > Period core.diff.container.readinessPeriod
Diff Service Settings > Readiness Probe > Timeout core.diff.container.readinessTimeout
Diff Service Settings > Readiness Probe > Success Threshold core.diff.container.readinessSuccessThreshold
Diff Service Settings > Readiness Probe > Failure Threshold core.diff.container.readinessFailureThreshold

Hazelcast Service Settings

KOTS config field Equivalent Helm chart value
Hazelcast Service Settings > Max CPU core.hazelcast.resources.limits.cpu
Hazelcast Service Settings > Max Memory core.hazelcast.application.env.MAX_HEAP_SIZE
Hazelcast Service Settings > Max Memory for Container core.hazelcast.resources.limits.memory
Hazelcast Service Settings > Liveness Probe > Initial Delay core.hazelcast.container.livenessInitialDelay
Hazelcast Service Settings > Liveness Probe > Period core.hazelcast.container.livenessPeriod
Hazelcast Service Settings > Liveness Probe > Timeout core.hazelcast.container.livenessTimeout
Hazelcast Service Settings > Liveness Probe > Success Threshold core.hazelcast.container.livenessSuccessThreshold
Hazelcast Service Settings > Liveness Probe > Failure Threshold core.hazelcast.container.livenessFailureThreshold
Hazelcast Service Settings > Readiness Probe > Initial Delay core.hazelcast.container.readinessInitialDelay
Hazelcast Service Settings > Readiness Probe > Period core.hazelcast.container.readinessPeriod
Hazelcast Service Settings > Readiness Probe > Timeout core.hazelcast.container.readinessTimeout
Hazelcast Service Settings > Readiness Probe > Success Threshold core.hazelcast.container.readinessSuccessThreshold
Hazelcast Service Settings > Readiness Probe > Failure Threshold core.hazelcast.container.readinessFailureThreshold

Traefik Settings

KOTS config field Equivalent Helm chart value
Traefik > Max CPU traefik.resources.limits.cpu
Traefik > Max Memory for Container traefik.resources.limits.memory

OAuth Service Settings

KOTS config field Equivalent Helm chart value
OAuth Service Settings > Max CPU core.oauth.resources.limits.cpu
OAuth Service Settings > Max Memory core.oauth.application.env.MAX_HEAP
core.oauth.resources.limits.memory
OAuth Service Settings > Liveness Probe > Initial Delay core.oauth.container.livenessInitialDelay
OAuth Service Settings > Liveness Probe > Period core.oauth.container.livenessPeriod
OAuth Service Settings > Liveness Probe > Timeout core.oauth.container.livenessTimeout
OAuth Service Settings > Liveness Probe > Success Threshold core.oauth.container.livenessSuccessThreshold
OAuth Service Settings > Liveness Probe > Failure Threshold core.oauth.container.livenessFailureThreshold
OAuth Service Settings > Readiness Probe > Initial Delay core.oauth.container.readinessInitialDelay
OAuth Service Settings > Readiness Probe > Period core.oauth.container.readinessPeriod
OAuth Service Settings > Readiness Probe > Timeout core.oauth.container.readinessTimeout
OAuth Service Settings > Readiness Probe > Success Threshold core.oauth.container.readinessSuccessThreshold
OAuth Service Settings > Readiness Probe > Failure Threshold core.oauth.container.readinessFailureThreshold

SAML Service Settings

KOTS config field Equivalent Helm chart value
SAML Service Settings > Max CPU core.saml.resources.limits.cpu
SAML Service Settings > Max Memory core.saml.application.env.MAX_HEAP
core.saml.resources.limits.memory
SAML Service Settings > Liveness Probe > Initial Delay core.saml.container.livenessInitialDelay
SAML Service Settings > Liveness Probe > Period core.saml.container.livenessPeriod
SAML Service Settings > Liveness Probe > Timeout core.saml.container.livenessTimeout
SAML Service Settings > Liveness Probe > Success Threshold core.saml.container.livenessSuccessThreshold
SAML Service Settings > Liveness Probe > Failure Threshold core.saml.container.livenessFailureThreshold
SAML Service Settings > Readiness Probe > Initial Delay core.saml.container.readinessInitialDelay
SAML Service Settings > Readiness Probe > Period core.saml.container.readinessPeriod
SAML Service Settings > Readiness Probe > Timeout core.saml.container.readinessTimeout
SAML Service Settings > Readiness Probe > Success Threshold core.saml.container.readinessSuccessThreshold
SAML Service Settings > Readiness Probe > Failure Threshold core.saml.container.readinessFailureThreshold

Wiris

KOTS config field Equivalent Helm chart value
WIRIS Connection Settings > Use custom Wiris connection core.application.env.WIRIS_CUSTOM_CONFIG_ENABLED
WIRIS Connection Settings > Wiris Host core.application.env.WIRIS_HOST
WIRIS Connection Settings > Wiris Path core.application.env.WIRIS_PATH
WIRIS Connection Settings > Wiris Port core.application.env.WIRIS_PORT
WIRIS Connection Settings > Wiris Protocol core.application.env.WIRIS_PROTOCOL
WIRIS Connection Settings > Use proxy for Wiris core.application.env.WIRIS_PROXY_ENABLED
WIRIS Connection Settings > Wiris Proxy Host core.application.env.WIRIS_PROXY_PORT
WIRIS Connection Settings > Wiris Proxy User core.secrets.wirisProxy.username
WIRIS Connection Settings > Wiris Proxy Password core.secrets.wirisProxy.password

Advanced Startup Settings

KOTS config field Equivalent Helm chart value
Advanced Startup Settings > Enable JMX remote for core Jama application core.application.env.ENABLE_JAVA_JMX_REMOTE
Advanced Startup Settings > JMX remote port number for core Jama application core.application.env.JAVA_JMX_REMOTE_PORT
Advanced Startup Settings > Additional JVM options for core Jama application core.application.env.ADDITIONAL_JAVA_OPTIONS
Advanced Startup Settings > Enable JMX remote for search service core.search.application.env.ENABLE_JAVA_JMX_REMOTE
Advanced Startup Settings > JMX remote port number for search service core.search.application.env.JAVA_JMX_REMOTE_PORT
Advanced Startup Settings > Additional JVM options for search service core.search.application.env.ADDITIONAL_JAVA_OPTIONS
Advanced Startup Settings > Enable JMX remote for OpenSearch core.search.opensearch.application.env.ENABLE_JAVA_JMX_REMOTE
Advanced Startup Settings > JMX remote port number for OpenSearch core.search.opensearch.application.env.JAVA_JMX_REMOTE_PORT
Advanced Startup Settings > Additional JVM options for OpenSearch core.search.opensearch.application.env.ADDITIONAL_JAVA_OPTIONS
Advanced Startup Settings > Enable JMX remote for diff service core.diff.application.env.ENABLE_JAVA_JMX_REMOTE
Advanced Startup Settings > JMX remote port number for diff service core.diff.application.env.JAVA_JMX_REMOTE_PORT
Advanced Startup Settings > Additional JVM options for diff service core.diff.application.env.ADDITIONAL_JAVA_OPTIONS
Advanced Startup Settings > Additional JVM options for Hazelcast service core.hazelcast.application.env.ADDITIONAL_JAVA_OPTIONS
Advanced Startup Settings > Java RMI server host name global.jmx.javaRmiHostName

Miscellaneous

KOTS config field Equivalent Helm chart value
Tenant Manager Settings > Enabled? core.tenant-manager.job.enabled
Restore Jama Backup > Backup file core.tenant-manager.application.env.RESTORE_BACKUP_FILE

KOTS only

The following KOTS config fields do not have a direct equivalent in Helm values.

  • Kubernetes Configuration > Allow Master Nodes
  • Kubernetes Configuration > Issuer Name
  • Kubernetes Configuration > Is this a cluster-scoped Issuer?
  • Host Name > TLS Key Pair Source > Cluster Managed
  • Host Name > TLS Key Pair Source > Reuse Admin Console TLS Configuration
  • SSL Settings > TLSv1.2 TLSv1.3
  • Jama Cloud > Authorization token
  • Jama Cloud > SAML URL
  • ActiveMQ Service Settings > Migration Job > Enable Migration Job
  • ActiveMQ Service Settings > Migration Job > Max CPU for Migration JobJama Connect: Kubernetes-Native Deployment
  • ActiveMQ Service Settings > Migration Job > Max Memory for Migration Job
  • ActiveMQ Service Settings > Migration Job > Max Memory for Migration Job Container
  • OpenSearch Settings > Include OpenSearch in Replicated Snapshots
  • AWS Resources > Enable EFS Storage Class
  • AWS EFS Storage Class > Name
  • AWS EFS Storage Class > File System ID
  • AWS EFS Storage Class > Base Path

In This Section

 

 

 

 

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.