For the complete documentation index, see llms.txt. This page is also available as Markdown.

Helm Chart Reference

All configuration parameters available in the Connectware Helm Chart.

The Connectware Helm Chart provides the configuration parameters that are required to deploy and manage Connectware in Kubernetes. This reference lists every available value defined in the Helm chart’s values.yaml file and explains its function and usage.

Because the connectware chart uses other Helm charts as subcharts, their values show up in separate tables in this document. Each section will list the Helm value context under which you can use them in the connectware Helm chart.

Use this reference together with the Connectware Helm Chart documentation to configure Connectware according to your specific deployment needs.

Connectware Helm Chart Values Reference

Helm configuration values for the connectware Helm chart

Property
Type
Required
Possible values
Default
Description

validVersion

string

string

Expected chart version for this values file

global

object

object

Global configuration, which is applied to multiple components

global.licenseKey

string

string

Your Connectware license key

global.existingLicenseKeySecret

string

string

Name of an existing Kubernetes Secret containing your Connectware license key

global.licenseFile

string

string

Your Connectware license file content (base64) or leave it empty if Cybus portal is used

global.existingLicenseFileSecret

string

string

Name of an existing Kubernetes Secret containing your Connectware license file

global.podSecurityContextOverride

object or null

object

Override default Kubernetes security context for all Pods as defined by Kubernetes https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

global.containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for all containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

global.initContainerSecurityContextOverride

object or null

object

Override default Kubernetes security context for all included init containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

global.image

object

object

Configuration for global container image usage

global.image.registry

string

string

"registry.cybus.io/cybus"

Container image registry that will be pulled from

global.image.tag

string

string

"2.4.2"

Container image tag to use

global.image.pullPolicy

string

Always Never IfNotPresent

"IfNotPresent"

Kubernetes image pull policy used for all images

global.image.pullSecrets

array

object

Existing Kubernetes image pull Secrets used by workloads

global.image.pullSecrets[].name

string

string

Name of the image pull Secret

global.ingressDNSNames

array

string

List of DNS names under which you will connect to Connectware externally

global.proxy

object

object

Configuration for HTTP proxy usage by Connectware

global.proxy.url

string

string

Address of an HTTP proxy server to be used

global.proxy.exceptions

array

string

List of of hosts, for which the proxy is ignored

global.proxy.existingSecret

string

string

Name of an existing Kubernetes Secret which contains the proxy configuration as the keys 'url' and 'exceptions'

global.persistence

object

object

Configuration for persistent storage

global.persistence.storageClassName

string

string

Name of the Kubernetes StorageClass to use for all Volumes

global.persistence.certs

object

object

Configuration specific to the shared certs Volume

global.persistence.certs.size

string

string

"50Mi"

Size of the shared certs Volume

global.persistence.certs.storageClassName

string

string

Name of the Kubernetes StorageClass to use for the shared certs Volume

global.authentication

object

object

Configuration for Connectware authentication

global.authentication.adminUser

object

object

Configuration for Connectware default admin

global.authentication.adminUser.enabled

boolean

boolean

true

Enable the default admin user

global.authentication.adminUser.initialPassword

string

string

Custom password for the default admin user as plain text

global.authentication.adminUser.existingSecret

string

string

Name of an existing Kubernetes Secret containing initial password for the 'admin' account as key 'initialPassword'

global.authentication.passwordPolicyRules

string

string

"default"

JSON string representing the configuration for password rules, see https://docs.cybus.io/latest/user/users.html

global.authentication.tokenExpiryHours

number

0 < x

12

Number of hours after which login tokens will expire

global.authentication.ldap

object

object

Configuration for LDAP client authentication, see https://docs.cybus.io/documentation/user-management/single-sign-on-sso/single-sign-on-with-ldap

global.authentication.ldap.enabled

boolean

boolean

false

Enable LDAP client authentication

global.authentication.ldap.url

string

URL of LDAP server in format schema://hostname:port

global.authentication.ldap.mode

string

group attribute GROUP ATTRIBUTE Group Attribute

"group"

Authentication mode for LDAP

global.authentication.ldap.bindDn

string

string

Either the LDAP base DN to generate the bind DN of users logging in, or the bind DN of a user, who is able to search through the LDAP directory

global.authentication.ldap.bindPassword

string

string

Password of the dedicated bind user specified in bindDn

global.authentication.ldap.existingBindSecret

string

string

Name of an existing Kubernetes Secret containing the bind Secrets. Must contain keys 'bindDn' and 'bindPassword'

global.authentication.ldap.existingBindSecretDnKey

string

string

Override the key for 'bindDn' in the manually created Secret

global.authentication.ldap.existingBindSecretPasswordKey

string

string

Override the key for 'bindPassword' in the manually created Secret

global.authentication.ldap.searchBase

string

string

LDAP path shared between Connectware users

global.authentication.ldap.searchFilter

string

string

Filter expression describing how to match users within the searchBase against LDAP

global.authentication.ldap.userRdn

string

string

"cn"

LDAP user property containing the username as it is typed into the Connectware login prompt

global.authentication.ldap.memberAttribute

string

string

"memberOf"

LDAP user property indicating the group memberships. Only valid for group mode

global.authentication.ldap.rolesAttribute

string

string

"employeeType"

LDAP user property common to all Connectware users in the user directory. This attribute has to contain all roles the Connectware user is assigned to

global.authentication.ldap.nestedGroupSupport

boolean

boolean

Define if the LDAP server supports searching for nested groups

global.authentication.ldap.caChain

object

object

Configuration for LDAP Certificate Authority chain

global.authentication.ldap.caChain.trustAllCertificates

boolean

boolean

false

Disable certificate verification. Allows any LDAP server TLS certificates

global.authentication.ldap.caChain.cert

string

string

Complete CA certificate chain for the LDAP server in PEM format

global.authentication.ldap.caChain.existingConfigMap

string

string

Name of an existing ConfigMap that contains the complete CA certificate chain for the LDAP server in PEM format in a file called ca.crt

global.authentication.ldap.autoEnforceMfa

boolean

boolean

false

Force new LDAP users to use Multi-Factor-Authentication

global.authentication.mfa

object

object

Configuration for Multi-Factor-Authentication

global.authentication.mfa.enabled

boolean

boolean

false

Enable Multi-Factor-Authentication

global.authentication.mfa.encryptionSecret

string

string

Secret key that is used to encrypt MFA secrets in clear text

global.authentication.mfa.encryptionSalt

string

string

Salt that is used to encrypt MFA secrets in clear text

global.authentication.mfa.existingSecret

string

string

Name of an existing Kubernetes Secret providing encryption salt and Secret. Must contain keys 'encryptionSecret' and 'encryptionSalt', which must contain base64 encoded strings

global.authentication.mfa.issuer

string

string

Entity name displayed in the MFA app for authentication

global.authentication.mfa.label

string

string

Identifier shown in the MFA app, typically the username or account name

global.authentication.entraId

object

object

Configuration for Microsoft Entra ID SSO client authentication

global.authentication.entraId.enabled

boolean

boolean

false

Enable Entra ID for client authentication

global.authentication.entraId.clientId

string

string

Unique identifier assigned to your application by Entra ID to facilitate OAuth transactions

global.authentication.entraId.tenantId

string

string

Identifier that specifies the tenant (or directory) within Entra ID where your application is registered

global.authentication.entraId.callbackDomain

string

string

Domain where Connectware users will be redirected to after authentication with Entra ID

global.authentication.entraId.clientSecret

string

string

Confidential key used by your application to authenticate with Entra ID

global.authentication.entraId.existingClientSecret

string

string

Name of an existing Kubernetes Secret containing the client secret used by your application to authenticate with Entra ID. Must contain key 'clientSecret'

global.authentication.entraId.issuerUrl

string

string

Identity provider's token issuing URL

global.authentication.entraId.usernameMappingField

string

preferred_username name oid

"preferred_username"

Specifies which personal information field is selected as a username when a user logs into Connectware using Entra ID

global.authentication.brokerCacheDuration

object

object

Configuration for authentication caching in CybusMQ broker

global.authentication.brokerCacheDuration.okSeconds

integer

integer

300

Amount of seconds the CybusMQ broker will cache successful authentication

global.authentication.brokerCacheDuration.failedSeconds

integer

integer

60

Amount of seconds the CybusMQ broker will cache failed authentication

global.commonLabels

object

object

{}

Labels applied all Connectware resources

global.nodeSelector

object or null

object

{}

Node labels that must be present for a Node to be eligible for Pod placement

global.tolerations

array or null

object

[]

Tolerations for Pod assignment

global.podPriorityClassName

string

string

""

PodPriorityClass to be used as global values

global.defaultInitContainer

object

object

Configuration for container image usage of the default init container

global.defaultInitContainer.image

object

object

Configures the version of the default initContainer

global.defaultInitContainer.image.registry

string

string

Container image registry that will be pulled from (Defaults to registry used by core-container)

global.defaultInitContainer.image.tag

string

string

"1.36.1"

Container image tag to use for the default init container

global.defaultInitContainer.image.name

string

string

"busybox"

Image used for default init container

authServer

object

object

Configuration for the auth-server component

authServer.enabled

boolean

boolean

true

Enable auth-server component

authServer.image

object

object

Configuration for container image usage of this component

authServer.image.registry

string

string

Container image registry that will be pulled from

authServer.image.name

string

string

"auth-server"

Name of the container image to pull

authServer.image.tag

string

string

Container image tag to use

authServer.image.pullPolicy

string

Always Never IfNotPresent

Kubernetes image pull policy used for the auth-server image

authServer.podSecurityContextOverride

object or null

object

Override default Kubernetes security context the Pod as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

authServer.containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

authServer.initContainerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the init containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

authServer.replicas

integer

integer

2

Number of auth-server replicas

authServer.rollingUpdate

object

object

Configurations for auth-server rolling update behavior

authServer.rollingUpdate.maxSurge

string or integer

Maximum number or percentage of Pods that can be created exceeding the desired number of Pods

authServer.rollingUpdate.maxUnavailable

string or integer

Maximum number or percentage of Pods that can be unavailable during the update process

authServer.labels

object

object

Labels applied to auth-server resources

authServer.annotations

object

object

Annotations applied to auth-server resources

authServer.podLabels

object

object

Labels applied to auth-server Pods

authServer.podAnnotations

object

object

Annotations applied to auth-server Pods

authServer.proxy

object

object

Configuration for HTTP proxy usage by auth-server

authServer.proxy.url

string

string

""

Address of an HTTP proxy server to be used

authServer.proxy.exceptions

array

string

List of of hosts, for which the proxy is ignored

authServer.proxy.existingSecret

string

string

Name of an existing Kubernetes Secret which contains the proxy configuration as the keys 'url' and 'exceptions'

authServer.service

object

object

Configuration for Kubernetes Service of the component

authServer.service.labels

object

object

Labels applied to auth-server Service

authServer.service.annotations

object

object

Annotations applied to auth-server Service

authServer.resources

object

object

Define the Kubernetes compute resources for the component

authServer.resources.limits

object

object

Limits for the Kubernetes compute resources for the component

authServer.resources.limits.cpu

string or null

Kubernetes Quantity describing the component CPU limits

authServer.resources.limits.memory

string or null

Kubernetes Quantity describing the component memory limits

authServer.resources.requests

object

object

Requests for the Kubernetes compute resources for the component

authServer.resources.requests.cpu

string or null

"1000m"

Kubernetes Quantity describing the component CPU requests

authServer.resources.requests.memory

string or null

"500Mi"

Kubernetes Quantity describing the component memory requests

authServer.podPriorityClassName

string

string

""

Name of the PodPriorityClass to be used

authServer.podAntiAffinity

string

none soft hard

"soft"

podAntiAffinity behavior for auth-server

authServer.podAntiAffinityTopologyKey

string

string

"kubernetes.io/hostname"

podAntiAffinityTopologyKey for auth-server Pod assignment

authServer.nodeSelector

object or null

object

{}

Node labels that must be present for a Node to be eligible for Pod placement

authServer.tolerations

array or null

object

[]

Tolerations for Pod assignment

authServer.env

array or null

object

Environment variables as name and value pairs applied to auth-server component

authServer.env[].name

string

string

Name of the environment variable

authServer.env[].value

string

string

Value of the environment variable

authServer.extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to the Pod

authServer.extraVolumes

array or null

Any type

Additional Volumes to be added to the Pod

authServer.extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to the core-container

authServer.extraInitContainers

array or null

Any type

Additional init containers to be added to the Pod

connectwareIngress

object

object

Configuration for the connectware-ingress component

connectwareIngress.enabled

boolean

boolean

true

Enable connectware-ingress component

connectwareIngress.image

object

object

Configuration for container image usage of this component

connectwareIngress.image.registry

string

string

Container image registry that will be pulled from

connectwareIngress.image.name

string

string

"ingress"

Name of the container image to pull

connectwareIngress.image.tag

string

string

Container image tag to use

connectwareIngress.image.pullPolicy

string

Always Never IfNotPresent

Kubernetes image pull policy used for the connectware-ingress image

connectwareIngress.podSecurityContextOverride

object or null

object

Override default Kubernetes security context for the Pod as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

connectwareIngress.containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

connectwareIngress.labels

object

object

Labels applied to connectware-ingress resources

connectwareIngress.annotations

object

object

Annotations applied to connectware-ingress resources

connectwareIngress.podLabels

object

object

Labels applied to connectware-ingress Pods

connectwareIngress.podAnnotations

object

object

Annotations applied to connectware-ingress Pods

connectwareIngress.service

object

object

Configuration for Kubernetes Service of the component

connectwareIngress.service.type

string

string

"LoadBalancer"

Type of Service to create

connectwareIngress.service.labels

object

object

Labels applied to connectware-ingress Service

connectwareIngress.service.annotations

object

object

Annotations applied to connectware-ingress Service

connectwareIngress.service.ports

array

array

[{"name": "1883", "port": 1883, "targetPort": 1883}, {"name": "nats-wss", "port": 4223, "targetPort": 4223}, {"name": "nats", "port": 4222, "targetPort": 4222}, {"name": "8883", "port": 8883, "targetPort": 8883}, {"name": "443", "port": 443, "targetPort": 8443}, {"name": "80", "port": 80, "targetPort": 8081}, {"name": "8443", "port": 8443, "targetPort": 8443}, {"name": "4841", "port": 4841, "targetPort": 4841}]

Ports to expose in the connectware-ingress Service

connectwareIngress.service.loadBalancerIP

string

string

Load balancer IP address to use for the Service

connectwareIngress.service.loadBalancerClass

string

string

Load balancer class to use for the Service

connectwareIngress.service.externalTrafficPolicy

string

string

External traffic policy to use for the Service

connectwareIngress.service.clusterIP

string

string

Cluster IP to use for the Service

connectwareIngress.resources

object

object

Kubernetes compute resources for the component

connectwareIngress.resources.limits

object

object

Limits for the Kubernetes compute resources for the component

connectwareIngress.resources.limits.cpu

string or null

Kubernetes Quantity describing the component CPU limits

connectwareIngress.resources.limits.memory

string or null

Kubernetes Quantity describing the component memory limits

connectwareIngress.resources.requests

object

object

Requests for the Kubernetes compute resources for the component

connectwareIngress.resources.requests.cpu

string or null

"400m"

Kubernetes Quantity describing the component CPU requests

connectwareIngress.resources.requests.memory

string or null

"250Mi"

Kubernetes Quantity describing the component memory requests

connectwareIngress.podPriorityClassName

string

string

""

Name of the PodPriorityClass to be used

connectwareIngress.nodeSelector

object or null

object

{}

Node labels that must be present for a Node to be eligible for Pod placement

connectwareIngress.tolerations

array or null

object

[]

Tolerations for Pod assignment

connectwareIngress.env

array or null

object

Environment variables as name and value pairs applied to connectware-ingress component

connectwareIngress.env[].name

string

string

Name of the environment variable

connectwareIngress.env[].value

string

string

Value of the environment variable

connectwareIngress.extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to the Pod

connectwareIngress.extraVolumes

array or null

Any type

Additional Volumes to be added to the Pod

connectwareIngress.extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to the core-container

connectwareIngress.extraInitContainers

array or null

Any type

Additional init containers to be added to the Pod

containerManager

object

object

Configuration for the container-manager component

containerManager.enabled

boolean

boolean

true

Enable container-manager component

containerManager.image

object

object

Configuration for container image usage of this component

containerManager.image.registry

string

string

Container image registry that will be pulled from

containerManager.image.name

string

string

"container-manager"

Name of the container image to pull

containerManager.image.tag

string

string

Container image tag to use

containerManager.image.pullPolicy

string

Always Never IfNotPresent

Kubernetes image pull policy used for the container-manager image

containerManager.podSecurityContextOverride

object or null

object

Override default Kubernetes security context for the Pod as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

containerManager.containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

containerManager.initContainerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the init containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

containerManager.labels

object

object

Labels applied to container-manager resources

containerManager.annotations

object

object

Annotations applied to container-manager resources

containerManager.podLabels

object

object

Labels applied to container-manager Pods

containerManager.podAnnotations

object

object

Annotations applied to container-manager Pods

containerManager.service

object

object

Configuration for Kubernetes Service of the component

containerManager.service.labels

object

object

Labels applied to container-manager Service

containerManager.service.annotations

object

object

Annotations applied to container-manager Service

containerManager.resources

object

object

Kubernetes compute resources for the component

containerManager.resources.limits

object

object

Limits for the Kubernetes compute resources for the component

containerManager.resources.limits.cpu

string or null

Kubernetes Quantity describing the component CPU limits

containerManager.resources.limits.memory

string or null

Kubernetes Quantity describing the component memory limits

containerManager.resources.requests

object

object

Requests for the Kubernetes compute resources for the component

containerManager.resources.requests.cpu

string or null

"150m"

Kubernetes Quantity describing the component CPU requests

containerManager.resources.requests.memory

string or null

"200Mi"

Kubernetes Quantity describing the component memory requests

containerManager.podPriorityClassName

string

string

""

Name of the PodPriorityClass to be used

containerManager.nodeSelector

object or null

object

{}

Node labels that must be present for a Node to be eligible for Pod placement

containerManager.tolerations

array or null

object

[]

Tolerations for Pod assignment

containerManager.env

array or null

object

Environment variables as name and value pairs applied to service-manager component

containerManager.env[].name

string

string

Name of the environment variable

containerManager.env[].value

string

string

Value of the environment variable

containerManager.extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to the Pod

containerManager.extraVolumes

array or null

Any type

Additional Volumes to be added to the Pod

containerManager.extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to the core-container

containerManager.extraInitContainers

array or null

Any type

Additional init containers to be added to the Pod

ingressController

object

object

Configuration for the ingress-controller component

ingressController.enabled

boolean

boolean

true

Enable ingress-controller component

ingressController.image

object

object

Configuration for container image usage of this component

ingressController.image.registry

string

string

Container image registry that will be pulled from

ingressController.image.name

string

string

"ingress-controller"

Name of the container image to pull

ingressController.image.tag

string

string

Container image tag to use

ingressController.image.pullPolicy

string

Always Never IfNotPresent

Kubernetes image pull policy used for the ingress-controller image

ingressController.podSecurityContextOverride

object or null

object

Override default Kubernetes security context for the Pod as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

ingressController.containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

ingressController.labels

object

object

Labels applied to ingress-controller resources

ingressController.annotations

object

object

Annotatfions that will be applied to ingress-controller resources

ingressController.podLabels

object

object

Labels applied to ingress-controller Pods

ingressController.podAnnotations

object

object

Annotations applied to ingress-controller Pods

ingressController.service

object

object

Configuration for Kubernetes Service of the component

ingressController.service.labels

object

object

Labels applied to ingress-controller Service

ingressController.service.annotations

object

object

Annotations applied to ingress-controller Service

ingressController.resources

object

object

Kubernetes compute resources for the component

ingressController.resources.limits

object

object

Limits for the Kubernetes compute resources for the component

ingressController.resources.limits.cpu

string or null

Kubernetes Quantity describing the component CPU limits

ingressController.resources.limits.memory

string or null

Kubernetes Quantity describing the component memory limits

ingressController.resources.requests

object

object

Requests for the Kubernetes compute resources for the component

ingressController.resources.requests.cpu

string or null

"150m"

Kubernetes Quantity describing the component CPU requests

ingressController.resources.requests.memory

string or null

"100Mi"

Kubernetes Quantity describing the component memory requests

ingressController.podPriorityClassName

string

string

""

Name of the PodPriorityClass to be used

ingressController.nodeSelector

object or null

object

{}

Node labels that must be present for a Node to be eligible for Pod placement

ingressController.tolerations

array or null

object

[]

Tolerations for Pod assignment

ingressController.env

array or null

object

Environment variables as name and value pairs applied to ingress-controller component

ingressController.env[].name

string

string

Name of the environment variable

ingressController.env[].value

string

string

Value of the environment variable

ingressController.extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to the Pod

ingressController.extraVolumes

array or null

Any type

Additional Volumes to be added to the Pod

ingressController.extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to the core-container

ingressController.extraInitContainers

array or null

Any type

Additional init containers to be added to the Pod

nats

object

object

Configuration for the NATS component

nats.enabled

boolean

boolean

true

Enable NATS component

nats.image

object

object

Configuration for container image usage of this component

nats.image.registry

string

string

Container image registry that will be pulled from

nats.image.name

string

string

"nats"

Name of the container image to pull

nats.image.tag

string

string

Container image tag to use

nats.image.pullPolicy

string

Always Never IfNotPresent

Kubernetes image pull policy used for the NATS image

nats.podSecurityContextOverride

object or null

object

Override default Kubernetes security context for the Pod as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

nats.containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

nats.initContainerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the init containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

nats.replicas

integer

integer

3

Number of NATS replicas

nats.labels

object

object

Labels applied to NATS resources

nats.annotations

object

object

Annotations applied to NATS resources

nats.podLabels

object

object

Labels applied to NATS Pods

nats.podAnnotations

object

object

Annotations applied to NATS Pods

nats.service

object

object

Configuration for Kubernetes Service of the component

nats.service.labels

object

object

Labels applied to NATS Services

nats.service.annotations

object

object

Annotations applied to NATS Services

nats.resources

object

object

Kubernetes compute resources for the component

nats.resources.limits

object

object

Limits for the Kubernetes compute resources for the component

nats.resources.limits.cpu

string or null

Kubernetes Quantity describing the component CPU limits

nats.resources.limits.memory

string or null

Kubernetes Quantity describing the component memory limits

nats.resources.requests

object

object

Requests for the Kubernetes compute resources for the component

nats.resources.requests.cpu

string or null

"500m"

Kubernetes Quantity describing the component CPU requests

nats.resources.requests.memory

string or null

"750Mi"

Kubernetes Quantity describing the component memory requests

nats.podPriorityClassName

string

string

""

Name of the PodPriorityClass to be used

nats.podAntiAffinity

string

none soft hard

"soft"

podAntiAffinity behavior for NATS

nats.podAntiAffinityTopologyKey

string

string

"kubernetes.io/hostname"

podAntiAffinityTopologyKey for NATS Pod assignment

nats.nodeSelector

object or null

object

{}

Node labels that must be present for a Node to be eligible for Pod placement

nats.tolerations

array or null

object

[]

Tolerations for Pod assignment

nats.persistence

object

object

Configuration for NATS JetStream Volume

nats.persistence.size

string

string

"16Gi"

Size of the NATS JetStream Volume

nats.persistence.storageClassName

string

string

""

Name of the Kubernetes StorageClass to use for the NATS JetStream Volume

nats.metrics

object

object

Configuration for NATS metrics

nats.metrics.enabled

boolean

boolean

false

Enable Prometheus exporter sidecar for NATS

nats.metrics.resources

object

object

Kubernetes compute resources for for the Prometheus sidecar

nats.metrics.resources.limits

object

object

Limits for the Kubernetes compute resources for the Prometheus sidecar

nats.metrics.resources.limits.cpu

string or null

Kubernetes Quantity describing the metrics CPU limits

nats.metrics.resources.limits.memory

string or null

Kubernetes Quantity describing the metrics memory limits

nats.metrics.resources.requests

object

object

Requests for the Kubernetes compute resources for the Prometheus sidecar

nats.metrics.resources.requests.cpu

string or null

Kubernetes Quantity describing the metrics CPU requests

nats.metrics.resources.requests.memory

string or null

Kubernetes Quantity describing the metrics memory requests

nats.metrics.serviceMonitor

object

object

Configuration for NATS Prometheus ServiceMonitor

nats.metrics.serviceMonitor.enabled

boolean

boolean

false

Enable NATS ServiceMonitor

nats.metrics.serviceMonitor.namespace

string

string

Namespace for the ServiceMonitor

nats.metrics.serviceMonitor.labels

object

object

Labels applied to NATS ServiceMonitor

nats.metrics.serviceMonitor.jobLabel

string

string

Label whose value will be used to replace the job name in metrics

nats.metrics.serviceMonitor.interval

string

string

Prometheus scrape interval for the ServiceMonitor endpoint

nats.metrics.serviceMonitor.scrapeTimeout

string

string

Prometheus scrape timeout for the ServiceMonitor endpoint

nats.metrics.serviceMonitor.metricRelabelings

array

object

Metric relabeling configurations applied to samples before ingestion

nats.metrics.serviceMonitor.relabelings

array

object

Relabeling configurations applied to targets before scraping

nats.livenessProbe

object

object

Configuration for NATS liveness probe

nats.livenessProbe.initialDelaySeconds

integer

0 <= x

5

Delay in seconds before attempting first liveness probe check

nats.livenessProbe.periodSeconds

integer

1 <= x

2

Interval of liveness probe checks

nats.livenessProbe.timeoutSeconds

integer

1 <= x

10

Timeout of liveness probe checks

nats.livenessProbe.failureThreshold

integer

1 <= x

3

Number of liveness probe check failures required to terminate a Pod

nats.env

array or null

object

Environment variables as name and value pairs applied to NATS component

nats.env[].name

string

string

Name of the environment variable

nats.env[].value

string

string

Value of the environment variable

nats.extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to the Pod

nats.extraVolumes

array or null

Any type

Additional Volumes to be added to the Pod

nats.extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to the core-container

nats.extraInitContainers

array or null

Any type

Additional init containers to be added to the Pod

nats.extraVolumeClaimTemplates

array

Any type

Additional volume claim templates to be added to all Pods on the StatefulSet

postgresql

object

object

Configuration for the postgresql component

postgresql.enabled

boolean

boolean

true

Enable postgresql component

postgresql.image

object

object

Configuration for container image usage of this component

postgresql.image.registry

string

string

Container image registry that will be pulled from

postgresql.image.name

string

string

"postgresql"

Name of the container image to pull

postgresql.image.tag

string

string

Container image tag to use

postgresql.image.pullPolicy

string

Always Never IfNotPresent

Kubernetes image pull policy used for the postgresql image

postgresql.podSecurityContextOverride

object or null

object

Override default Kubernetes security context for the Pod as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

postgresql.containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

postgresql.labels

object

object

Labels applied to postgresql resources

postgresql.annotations

object

object

Annotations applied to postgresql resources

postgresql.podLabels

object

object

Labels applied to postgresql Pods

postgresql.podAnnotations

object

object

Annotations applied to postgresql Pods

postgresql.service

object

object

Configuration for Kubernetes Service of the component

postgresql.service.labels

object

object

Labels applied to postgresql Service

postgresql.service.annotations

object

object

Annotations applied to postgresql Service

postgresql.persistence

object

object

Configuration for postgresql Volume

postgresql.persistence.size

string

string

"5Gi"

Size of the postgresql Volume

postgresql.persistence.storageClassName

string

string

""

Name of the Kubernetes StorageClass to use for the postgresql Volume

postgresql.persistence.accessMode

string

ReadWriteOnce ReadWriteMany ReadWriteOncePod

Kubernetes access mode for the postgresql Volume

postgresql.persistence.preprovisionedNFS

object

object

postgresql.persistence.preprovisionedNFS.enabled

boolean

boolean

false

Enable using a preprovisioned NFS Volume for the postgresql Volume

postgresql.persistence.preprovisionedNFS.server

string

string

""

NFS server for the preprovisioned postgresql Volume

postgresql.persistence.preprovisionedNFS.path

string

string

"/nfs_data/postgresql"

Exported path on NFS server for the preprovisioned postgresql Volume

postgresql.resources

object

object

Kubernetes compute resources for the component

postgresql.resources.limits

object

object

Limits for the Kubernetes compute resources for the component

postgresql.resources.limits.cpu

string or null

Kubernetes Quantity describing the component CPU limits

postgresql.resources.limits.memory

string or null

Kubernetes Quantity describing the component memory limits

postgresql.resources.requests

object

object

Requests for the Kubernetes compute resources for the component

postgresql.resources.requests.cpu

string or null

"500m"

Kubernetes Quantity describing the component CPU requests

postgresql.resources.requests.memory

string or null

"750Mi"

Kubernetes Quantity describing the component memory requests

postgresql.podPriorityClassName

string

string

""

Name of the PodPriorityClass to be used

postgresql.nodeSelector

object or null

object

{}

Node labels that must be present for a Node to be eligible for Pod placement

postgresql.tolerations

array or null

object

[]

Tolerations for Pod assignment

postgresql.sharedBuffers

string

string

(Advanced) Override amount of memory used for PostgreSQL shared buffers

postgresql.env

array or null

object

Environment variables as name and value pairs applied to postgresql component

postgresql.env[].name

string

string

Name of the environment variable

postgresql.env[].value

string

string

Value of the environment variable

postgresql.extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to the Pod

postgresql.extraVolumes

array or null

Any type

Additional Volumes to be added to the Pod

postgresql.extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to the core-container

postgresql.extraInitContainers

array or null

Any type

Additional init containers to be added to the Pod

protocolMapper

object

object

Configuration for the protocol-mapper component

protocolMapper.enabled

boolean

boolean

true

Enable protocol-mapper component

protocolMapper.image

object

object

Configuration for container image usage of this component

protocolMapper.image.registry

string

string

Container image registry that will be pulled from

protocolMapper.image.name

string

string

"protocol-mapper"

Name of the container image to pull

protocolMapper.image.tag

string

string

Container image tag to use

protocolMapper.image.pullPolicy

string

Always Never IfNotPresent

Kubernetes image pull policy used for the protocol-mapper image

protocolMapper.podSecurityContextOverride

object or null

object

Override default Kubernetes security context for the Pod as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

protocolMapper.containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

protocolMapper.initContainerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the init containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

protocolMapper.labels

object

object

Labels applied to protocol-mapper resources

protocolMapper.annotations

object

object

Annotations applied to protocol-mapper resources

protocolMapper.podLabels

object

object

Labels applied to protocol-mapper Pods

protocolMapper.podAnnotations

object

object

Annotations applied to protocol-mapper Pods

protocolMapper.service

object

object

Configuration for Kubernetes Service of the component

protocolMapper.service.labels

object

object

Labels applied to protocol-mapper Service

protocolMapper.service.annotations

object

object

Annotations applied to protocol-mapper Service

protocolMapper.resources

object

object

Kubernetes compute resources for the component

protocolMapper.resources.limits

object

object

Limits for the Kubernetes compute resources for the component

protocolMapper.resources.limits.cpu

string or null

Kubernetes Quantity describing the component CPU limits

protocolMapper.resources.limits.memory

string or null

Kubernetes Quantity describing the component memory limits

protocolMapper.resources.requests

object

object

Requests for the Kubernetes compute resources for the component

protocolMapper.resources.requests.cpu

string or null

"1000m"

Kubernetes Quantity describing the component CPU requests

protocolMapper.resources.requests.memory

string or null

"1000Mi"

Kubernetes Quantity describing the component memory requests

protocolMapper.podPriorityClassName

string

string

""

Name of the PodPriorityClass to be used

protocolMapper.env

array or null

object

Environment variables as name and value pairs applied to protocol-mapper component

protocolMapper.env[].name

string

string

Name of the environment variable

protocolMapper.env[].value

string

string

Value of the environment variable

protocolMapper.extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to the Pod

protocolMapper.extraVolumes

array or null

Any type

Additional Volumes to be added to the Pod

protocolMapper.extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to the core-container

protocolMapper.extraInitContainers

array or null

Any type

Additional init containers to be added to the Pod

resourceStatusTracking

object

object

Configuration for the resource-status-tracking component

resourceStatusTracking.enabled

boolean

boolean

true

Enable resource-status-tracking component

resourceStatusTracking.image

object

object

Configuration for container image usage of this component

resourceStatusTracking.image.registry

string

string

Container image registry that will be pulled from

resourceStatusTracking.image.name

string

string

"resource-status-tracking"

Name of the container image to pull

resourceStatusTracking.image.tag

string

string

Container image tag to use

resourceStatusTracking.image.pullPolicy

string

Always Never IfNotPresent

Kubernetes image pull policy used for the resource-status-tracking image

resourceStatusTracking.podSecurityContextOverride

object or null

object

Override default Kubernetes security context for the Pod as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

resourceStatusTracking.containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

resourceStatusTracking.replicas

integer

integer

2

Number of resource-status-tracking replicas

resourceStatusTracking.labels

object

object

Labels applied to resource-status-tracking resources

resourceStatusTracking.annotations

object

object

Annotations applied to resource-status-tracking resources

resourceStatusTracking.podLabels

object

object

Labels applied to resource-status-tracking Pods

resourceStatusTracking.podAnnotations

object

object

Annotations applied to resource-status-tracking Pods

resourceStatusTracking.service

object

object

Configuration for Kubernetes Service of the component

resourceStatusTracking.service.labels

object

object

Labels applied to resource-status-tracking Service

resourceStatusTracking.service.annotations

object

object

Annotations applied to resource-status-tracking Service

resourceStatusTracking.resources

object

object

Kubernetes compute resources for the component

resourceStatusTracking.resources.limits

object

object

Limits for the Kubernetes compute resources for the component

resourceStatusTracking.resources.limits.cpu

string or null

Kubernetes Quantity describing the component CPU limits

resourceStatusTracking.resources.limits.memory

string or null

Kubernetes Quantity describing the component memory limits

resourceStatusTracking.resources.requests

object

object

Requests for the Kubernetes compute resources for the component

resourceStatusTracking.resources.requests.cpu

string or null

"250m"

Kubernetes Quantity describing the component CPU requests

resourceStatusTracking.resources.requests.memory

string or null

"500Mi"

Kubernetes Quantity describing the component memory requests

resourceStatusTracking.podPriorityClassName

string

string

""

Name of the PodPriorityClass to be used

resourceStatusTracking.nodeSelector

object or null

object

{}

Node labels that must be present for a Node to be eligible for Pod placement

resourceStatusTracking.tolerations

array or null

object

[]

Tolerations for Pod assignment

resourceStatusTracking.minReadySeconds

integer

0 <= x

0

Minimum number of seconds a Pod must be ready before being considered available

resourceStatusTracking.podAntiAffinity

string

none soft hard

"soft"

podAntiAffinity behavior for resource-status-tracking

resourceStatusTracking.podAntiAffinityTopologyKey

string

string

"kubernetes.io/hostname"

podAntiAffinityTopologyKey for resource-status-tracking Pod assignment

resourceStatusTracking.env

array or null

object

Environment variables as name and value pairs applied to resource-status-tracking component

resourceStatusTracking.env[].name

string

string

Name of the environment variable

resourceStatusTracking.env[].value

string

string

Value of the environment variable

resourceStatusTracking.rollingUpdate

object

object

Configurations for resource-status-tracking rolling update behavior

resourceStatusTracking.rollingUpdate.maxSurge

string or integer

Maximum number or percentage of Pods that can be created exceeding the desired number of Pods

resourceStatusTracking.rollingUpdate.maxUnavailable

string or integer

Maximum number or percentage of Pods that can be unavailable during the update process

resourceStatusTracking.extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to the Pod

resourceStatusTracking.extraVolumes

array or null

Any type

Additional Volumes to be added to the Pod

resourceStatusTracking.extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to the core-container

resourceStatusTracking.extraInitContainers

array or null

Any type

Additional init containers to be added to the Pod

resourceStatusTracking.livenessProbe

object

object

Configuration for resource-status-tracking liveness probe

resourceStatusTracking.livenessProbe.initialDelaySeconds

integer

0 <= x

5

Delay in seconds before attempting first liveness probe check

resourceStatusTracking.livenessProbe.periodSeconds

integer

1 <= x

2

Interval of liveness probe checks

resourceStatusTracking.livenessProbe.timeoutSeconds

integer

1 <= x

10

Timeout of liveness probe checks

resourceStatusTracking.livenessProbe.failureThreshold

integer

1 <= x

3

Number of liveness probe check failures required to terminate a Pod

serviceManager

object

object

Configuration for the service-manager component

serviceManager.enabled

boolean

boolean

true

Enable service-manager component

serviceManager.image

object

object

Configuration for container image usage of this component

serviceManager.image.registry

string

string

Container image registry that will be pulled from

serviceManager.image.name

string

string

"service-manager"

Name of the container image to pull

serviceManager.image.tag

string

string

Container image tag to use

serviceManager.image.pullPolicy

string

Always Never IfNotPresent

Kubernetes image pull policy used for the service-manager image

serviceManager.podSecurityContextOverride

object or null

object

Override default Kubernetes security context for the Pod as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

serviceManager.containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

serviceManager.initContainerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the init containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

serviceManager.labels

object

object

Labels applied to service-manager resources

serviceManager.annotations

object

object

Annotations applied to service-manager resources

serviceManager.podLabels

object

object

Labels applied to service-manager Pods

serviceManager.podAnnotations

object

object

Annotations applied to service-manager Pods

serviceManager.service

object

object

Configuration for Kubernetes Service of the component

serviceManager.service.labels

object

object

Labels applied to service-manager Service

serviceManager.service.annotations

object

object

Annotations applied to service-manager Service

serviceManager.resources

object

object

Kubernetes compute resources for the component

serviceManager.resources.limits

object

object

Limits for the Kubernetes compute resources for the component

serviceManager.resources.limits.cpu

string or null

Kubernetes Quantity describing the component CPU limits

serviceManager.resources.limits.memory

string or null

Kubernetes Quantity describing the component memory limits

serviceManager.resources.requests

object

object

Requests for the Kubernetes compute resources for the component

serviceManager.resources.requests.cpu

string or null

Kubernetes Quantity describing the component CPU requests

serviceManager.resources.requests.memory

string or null

Kubernetes Quantity describing the component memory requests

serviceManager.podPriorityClassName

string

string

""

Name of the PodPriorityClass to be used

serviceManager.nodeSelector

object or null

object

{}

Node labels that must be present for a Node to be eligible for Pod placement

serviceManager.tolerations

array or null

object

[]

Tolerations for Pod assignment

serviceManager.env

array or null

object

Environment variables as name and value pairs applied to service-manager component

serviceManager.env[].name

string

string

Name of the environment variable

serviceManager.env[].value

string

string

Value of the environment variable

serviceManager.extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to the Pod

serviceManager.extraVolumes

array or null

Any type

Additional Volumes to be added to the Pod

serviceManager.extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to the core-container

serviceManager.extraInitContainers

array or null

Any type

Additional init containers to be added to the Pod

systemControlServer

object

object

Configuration for the system-control-server component

systemControlServer.enabled

boolean

boolean

true

Enable system-control-server component

systemControlServer.image

object

object

Configuration for container image usage of this component

systemControlServer.image.registry

string

string

Container image registry that will be pulled from

systemControlServer.image.name

string

string

"system-control-server"

Name of the container image to pull

systemControlServer.image.tag

string

string

Container image tag to use

systemControlServer.image.pullPolicy

string

Always Never IfNotPresent

Kubernetes image pull policy used for the system-control-server image

systemControlServer.podSecurityContextOverride

object or null

object

Override default Kubernetes security context for the Pod as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

systemControlServer.containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

systemControlServer.labels

object

object

Labels applied to system-control-server resources

systemControlServer.annotations

object

object

Annotations applied to system-control-server resources

systemControlServer.podLabels

object

object

Labels applied to system-control-server Pods

systemControlServer.podAnnotations

object

object

Annotations applied to system-control-server Pods

systemControlServer.proxy

object

object

Configuration for HTTP proxy usage by system-control-server

systemControlServer.proxy.url

string

string

Address of an HTTP proxy server to be used

systemControlServer.proxy.exceptions

array

string

List of of hosts, for which the proxy is ignored

systemControlServer.proxy.existingSecret

string

string

Name of an existing Kubernetes Secret which contains the proxy configuration as the keys 'url' and 'exceptions'

systemControlServer.service

object

object

Configuration for Kubernetes Service of the component

systemControlServer.service.labels

object

object

Labels applied to system-control-server Service

systemControlServer.service.annotations

object

object

Annotations applied to system-control-server Service

systemControlServer.persistence

object

object

Configuration for system-control-server Volume

systemControlServer.persistence.size

string

string

"300Mi"

Size of the system-control-server Volume

systemControlServer.persistence.storageClassName

string

string

""

Name of the Kubernetes StorageClass to use for the system-control-server Volume

systemControlServer.resources

object

object

Kubernetes compute resources for the component

systemControlServer.resources.limits

object

object

Limits for the Kubernetes compute resources for the component

systemControlServer.resources.limits.cpu

string or null

Kubernetes Quantity describing the component CPU limits

systemControlServer.resources.limits.memory

string or null

Kubernetes Quantity describing the component memory limits

systemControlServer.resources.requests

object

object

Requests for the Kubernetes compute resources for the component

systemControlServer.resources.requests.cpu

string or null

"300m"

Kubernetes Quantity describing the component CPU requests

systemControlServer.resources.requests.memory

string or null

"200Mi"

Kubernetes Quantity describing the component memory requests

systemControlServer.podPriorityClassName

string

string

""

Name of the PodPriorityClass to be used

systemControlServer.nodeSelector

object or null

object

{}

Node labels that must be present for a Node to be eligible for Pod placement

systemControlServer.tolerations

array or null

object

[]

Tolerations for Pod assignment

systemControlServer.env

array or null

object

Environment variables as name and value pairs applied to system-control-server component

systemControlServer.env[].name

string

string

Name of the environment variable

systemControlServer.env[].value

string

string

Value of the environment variable

systemControlServer.extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to the Pod

systemControlServer.extraVolumes

array or null

Any type

Additional Volumes to be added to the Pod

systemControlServer.extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to the core-container

systemControlServer.extraInitContainers

array or null

Any type

Additional init containers to be added to the Pod

topicExplorer

object

object

Configuration for the topic-explorer component

topicExplorer.enabled

boolean

boolean

true

Enable topic-explorer component

topicExplorer.replicas

integer

integer

2

Number of topic-explorer replicas

topicExplorer.labels

object

object

{}

Labels applied to topic-explorer resources

topicExplorer.annotations

object

object

{}

Annotations applied to topic-explorer resources

topicExplorer.podLabels

object

object

{}

Labels applied to topic-explorer Pods

topicExplorer.podAnnotations

object

object

{}

Annotations applied to topic-explorer Pods

topicExplorer.image

object

object

Configuration for container image usage of this component

topicExplorer.image.registry

string

string

Container image registry that will be pulled from

topicExplorer.image.name

string

string

"topic-explorer"

Name of the container image to pull

topicExplorer.image.tag

string

string

Container image tag to use

topicExplorer.image.pullPolicy

string

Always Never IfNotPresent

Kubernetes image pull policy used for the topic-explorer image

topicExplorer.podSecurityContextOverride

object or null

object

Override default Kubernetes security context for the Pod as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

topicExplorer.containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

topicExplorer.service

object

object

Configuration for Kubernetes Service of the component

topicExplorer.service.labels

object

object

{}

Labels applied to topic-explorer service

topicExplorer.service.annotations

object

object

{}

Annotations applied to topic-explorer service

topicExplorer.resources

object

object

Kubernetes compute resources for the component

topicExplorer.resources.limits

object

object

{}

Limits for the Kubernetes compute resources for the component

topicExplorer.resources.limits.cpu

string or null

Kubernetes Quantity describing the component CPU limits

topicExplorer.resources.limits.memory

string or null

Kubernetes Quantity describing the component memory limits

topicExplorer.resources.requests

object

object

Requests for the Kubernetes compute resources for the component

topicExplorer.resources.requests.cpu

string or null

"200m"

Kubernetes Quantity describing the component CPU requests

topicExplorer.resources.requests.memory

string or null

"500Mi"

Kubernetes Quantity describing the component memory requests

topicExplorer.podPriorityClassName

string

string

""

Name of the PodPriorityClass to be used

topicExplorer.podAntiAffinity

string

none soft hard

"soft"

podAntiAffinity behavior for topic-explorer

topicExplorer.podAntiAffinityTopologyKey

string

string

"kubernetes.io/hostname"

podAntiAffinityTopologyKey for topic-explorer Pod assignment

topicExplorer.nodeSelector

object or null

object

{}

Node labels that must be present for a Node to be eligible for Pod placement

topicExplorer.tolerations

array or null

object

[]

Tolerations for Pod assignment

topicExplorer.minReadySeconds

integer

0 <= x

0

Minimum number of seconds a Pod must be ready before being considered available

topicExplorer.env

array or null

object

Environment variables as name and value pairs applied to topic-explorer component

topicExplorer.env[].name

string

string

Name of the environment variable

topicExplorer.env[].value

string

string

Value of the environment variable

topicExplorer.extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to the Pod

topicExplorer.extraVolumes

array or null

Any type

Additional Volumes to be added to the Pod

topicExplorer.extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to the core-container

topicExplorer.extraInitContainers

array or null

Any type

Additional init containers to be added to the Pod

topicExplorer.livenessProbe

object

object

Configuration for topic-explorer liveness probe

topicExplorer.livenessProbe.initialDelaySeconds

integer

0 <= x

5

Delay in seconds before attempting first liveness probe check

topicExplorer.livenessProbe.periodSeconds

integer

1 <= x

2

Interval of liveness probe checks

topicExplorer.livenessProbe.timeoutSeconds

integer

1 <= x

10

Timeout of liveness probe checks

topicExplorer.livenessProbe.failureThreshold

integer

1 <= x

3

Number of liveness probe check failures required to terminate a Pod

topicExplorer.rollingUpdate

object

object

Configurations for topic-explorer rolling update behavior

topicExplorer.rollingUpdate.maxSurge

string or integer

Maximum number or percentage of Pods that can be created exceeding the desired number of Pods

topicExplorer.rollingUpdate.maxUnavailable

string or integer

Maximum number or percentage of Pods that can be unavailable during the update process

workbench

object

object

Configuration for the workbench component

workbench.enabled

boolean

boolean

true

Enable workbench component

workbench.image

object

object

Configuration for container image usage of this component

workbench.image.registry

string

string

Container image registry that will be pulled from

workbench.image.name

string

string

"workbench"

Name of the container image to pull

workbench.image.tag

string

string

Container image tag to use

workbench.image.pullPolicy

string

Always Never IfNotPresent

Kubernetes image pull policy used for the workbench image

workbench.podSecurityContextOverride

object or null

object

Override default Kubernetes security context for the Pod as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

workbench.containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

workbench.labels

object

object

Labels applied to workbench resources

workbench.annotations

object

object

Annotations applied to workbench resources

workbench.podLabels

object

object

Labels applied to workbench Pods

workbench.podAnnotations

object

object

Annotations applied to workbench Pods

workbench.service

object

object

Configuration for Kubernetes Service of the component

workbench.service.labels

object

object

Labels applied to workbench Service

workbench.service.annotations

object

object

Annotations applied to workbench Service

workbench.persistence

object

object

Configuration for workbench Volume

workbench.persistence.size

string

string

"300Mi"

Size of the workbench Volume

workbench.persistence.storageClassName

string

string

""

Name of the Kubernetes StorageClass to use for the workbench Volume

workbench.resources

object

object

Kubernetes compute resources for the component

workbench.resources.limits

object

object

Limits for the Kubernetes compute resources for the component

workbench.resources.limits.cpu

string or null

Kubernetes Quantity describing the component CPU limits

workbench.resources.limits.memory

string or null

Kubernetes Quantity describing the component memory limits

workbench.resources.requests

object

object

Requests for the Kubernetes compute resources for the component

workbench.resources.requests.cpu

string or null

Kubernetes Quantity describing the component CPU requests

workbench.resources.requests.memory

string or null

Kubernetes Quantity describing the component memory requests

workbench.podPriorityClassName

string

string

""

Name of the PodPriorityClass to be used

workbench.nodeSelector

object or null

object

{}

Node labels that must be present for a Node to be eligible for Pod placement

workbench.tolerations

array or null

object

[]

Tolerations for Pod assignment

workbench.env

array or null

object

Environment variables as name and value pairs applied to workbench component

workbench.env[].name

string

string

Name of the environment variable

workbench.env[].value

string

string

Value of the environment variable

workbench.extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to the Pod

workbench.extraVolumes

array or null

Any type

Additional Volumes to be added to the Pod

workbench.extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to the core-container

workbench.extraInitContainers

array or null

Any type

Additional init containers to be added to the Pod

Connectware Broker Component Values Reference

This Helm chart is used as a subchart for the connectware Helm chart. Specify these values in the broker context of your values.yaml file.

Helm configuration values for the broker Helm chart

Property
Type
Required
Possible values
Default
Description

validVersion

string

string

Expected chart version for this values file

licenseKey

string

string

Your Connectware license key

image

object

object

Configuration for container image usage of this component

image.registry

string

string

"registry.cybus.io/cybus"

Container image registry that will be pulled from

image.name

string

string

"broker"

Name of the container image to pull

image.tag

string

string

Container image tag to use

image.pullPolicy

string

Always Never IfNotPresent

"IfNotPresent"

Kubernetes image pull policy used for the broker image

defaultInitContainer

object

object

Configuration for container image usage of the default init container

defaultInitContainer.image

object

object

defaultInitContainer.image.registry

string

string

Container image registry that will be pulled from (Defaults to registry used by core-container)

defaultInitContainer.image.name

string

string

"busybox"

Name of the container image to pull

defaultInitContainer.image.tag

string

string

"1.36.1"

Container image tag to use

podSecurityContextOverride

object or null

object

Override default Kubernetes security context for the Pod as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

initContainerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the init containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

nodeSelector

object or null

object

{}

Node labels that must be present for a Node to be eligible for Pod placement

tolerations

array or null

object

[]

Tolerations for Pod assignment

clusterSecret

string

Length: string >= 5 or string

Secret value used by the Broker cluster to allow nodes to join

existingClusterSecret

string

string

Name of an existing Kubernetes Secret with the key 'clusterSecret' holding a secret value used by the Broker cluster to allow nodes to join

replicas

integer

integer

3

Number of Broker cluster replicas

terminationGracePeriodSeconds

integer

1 <= x

240

Termination grace period in seconds

allowRegisterDuringClusterFormation

boolean

boolean

true

Allow clients to register at a degraded cluster

allowPublishDuringClusterFormation

boolean

boolean

true

Allow clients to publish to a degraded cluster

allowSubscribeDuringClusterFormation

boolean

boolean

true

Allow clients to subscribe at a degraded cluster

allowUnsubscribeDuringClusterFormation

boolean

boolean

true

Allow clients to unsubscribe from a degraded cluster

onlineMessageQueueSize

integer

0 < x

10000

Size of the queue for online MQTT clients. This value avoids the occurrence of dropped messages by subscribers during heavy traffic periods by using more memory in the Broker. If this value is increased the resources assigned to the Broker need to be increased in the broker.resources section

offlineMessageQueueSize

integer

0 < x

10000

Size of the queue for offline MQTT clients. This value avoids the occurrence of dropped messages by subscribers during heavy traffic periods by using more memory in the Broker. If this value is increased the resources assigned to the Broker need to be increased in the broker.resources section

persistence

object

object

Configuration for broker message queue and metadata Volume

persistence.data

object

object

Configuration for broker message queue and metadata Volume

persistence.data.size

string

string

"1Gi"

Size of the broker message queue and metadata Volume

persistence.data.storageClassName

string

string

""

Name of the Kubernetes StorageClass to use for the broker message queue and metadata Volume

persistence.log

object

object

Configuration for broker logging Volume

persistence.log.size

string

string

"200Mi"

Size of the broker logging Volume

persistence.log.storageClassName

string

string

""

Name of the Kubernetes StorageClass to use for the broker logging Volume

labels

object

object

Labels applied to broker resources

annotations

object

object

Annotations applied to broker resources

podLabels

object

object

Labels applied to broker Pods

podAnnotations

object

object

Annotations applied to broker Pods

service

object

object

Configuration for Kubernetes Service of the component

service.labels

object

object

Labels applied to broker Service

service.annotations

object

object

Annotations applied to broker Service

resources

object

object

Kubernetes compute resources for the component

resources.limits

object

object

Limits for the Kubernetes compute resources for the component

resources.limits.cpu

string or null

Kubernetes Quantity that describes the component CPU limits

resources.limits.memory

string or null

Kubernetes Quantity that describes the component memory limits

resources.requests

object

object

Requests for the Kubernetes compute resources for the component

resources.requests.cpu

string or null

"600m"

Kubernetes Quantity that describes the component CPU requests

resources.requests.memory

string or null

"1000Mi"

Kubernetes Quantity that describes the component memory requests

podPriorityClassName

string

string

""

Name of the PodPriorityClass

podAntiAffinity

string

none soft hard

"soft"

podAntiAffinity behavior for broker

podAntiAffinityTopologyKey

string

string

"kubernetes.io/hostname"

podAntiAffinityTopologyKey for broker

env

array or null

object

Environment variables as name and value pairs applied to broker component

env[].name

string

string

Name of the environment variable

env[].value

string

string

Value of the environment variable

extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to the Pod

extraVolumes

array or null

Any type

Additional Volumes to be added to the Pod

extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to core-container

extraInitContainers

array or null

Any type

Additional init containers to be added to the Pod

extraVolumeClaimTemplates

array

Any type

Additional volume claim templates to be added to the StatefulSet

Connectware Admin-UI Component Values Reference

This Helm chart is used as a subchart for the connectware Helm chart. Specify these values in the adminWebApp context of your values.yaml file.

Helm configuration values for the admin-web-app Helm chart

Property
Type
Required
Possible values
Default
Description

validVersion

string

string

Expected chart version for this values file

licenseKey

string

string

Your Connectware license key

displayVersion

string

string

(Advanced) Connectware version assumed by the Admin UI. Will default to the installed version

image

object

object

Configuration for container image usage of this component

image.registry

string

string

"registry.cybus.io/cybus"

Container image registry that will be pulled from

image.name

string

string

"admin-web-app"

Name of the container image to pull

image.tag

string

string

Container image tag to use

image.pullPolicy

string

Always Never IfNotPresent

"IfNotPresent"

Kubernetes image pull policy used for the admin-web-app image

podSecurityContextOverride

object or null

object

Override default Kubernetes security context for the Pod as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

nodeSelector

object or null

object

{}

Node labels that must be present for a Node to be eligible for Pod placement

tolerations

array or null

object

[]

Tolerations for Pod assignment

labels

object

object

Labels applied to admin-web-app resources

annotations

object

object

Annotations applied to admin-web-app resources

podLabels

object

object

Labels applied to admin-web-app Pods

podAnnotations

object

object

Annotations applied to admin-web-app Pods

service

object

object

Configuration for Kubernetes Service of the component

service.labels

object

object

Labels applied to admin-web-app Service

service.annotations

object

object

Annotations applied to admin-web-app Service

resources

object

object

Kubernetes compute resources for the component

resources.limits

object

object

Limits for the Kubernetes compute resources for the component

resources.limits.cpu

string or null

Kubernetes Quantity that describes the component CPU limits

resources.limits.memory

string or null

Kubernetes Quantity that describes the component memory limits

resources.requests

object

object

Requests for the Kubernetes compute resources for the component

resources.requests.cpu

string or null

"50m"

Kubernetes Quantity that describes the component CPU requests

resources.requests.memory

string or null

"50Mi"

Kubernetes Quantity that describes the component memory requests

podPriorityClassName

string

string

""

Name of the PodPriorityClass

env

array or null

object

Environment variables as name and value pairs applied to admin-web-app component

env[].name

string

string

Name of the environment variable

env[].value

string

string

Value of the environment variable

extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to the Pod

extraVolumes

array or null

Any type

Additional Volumes to be added to the Pod

extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to core-container

extraInitContainers

array or null

Any type

Additional init containers to be added to the Pod

Connectware-Agent Helm Chart Values Reference

When used as a subchart in the connectware Helm chart, you specify these values in the connectwareAgent context of your values.yaml file.

Helm configuration values for the connectware-agent Helm chart

Property
Type
Required
Possible values
Default
Description

protocolMapperAgentDefaults

object

object

Configuration applied to all agents, unless specific values are overriden

protocolMapperAgentDefaults.annotations

object

object

Annotations applied to all agent resources (default value)

protocolMapperAgentDefaults.connectwareHost

string

string

"connectware"

DNS name under which the Connectware installation is available to an agent (default value)

protocolMapperAgentDefaults.dataPlane

object

object

Configuration for data plane connection (default value)

protocolMapperAgentDefaults.dataPlane.tls

boolean

boolean

false

Enable TLS for data plane connection (default value)

protocolMapperAgentDefaults.dataPlane.host

string

string

Host for data plane connection (default value, will default to the value of connectwareHost)

protocolMapperAgentDefaults.dataPlane.port

integer

1 <= x <= 65535

"1883/8883"

Port for data plane connection (default value, changes depending on value of dataPlane.tls)

protocolMapperAgentDefaults.streamServer

object

object

Configuration for streaming server (default value)

protocolMapperAgentDefaults.streamServer.host

string

string

Host for streaming server connection (default value, will default to the value of connectwareHost)

protocolMapperAgentDefaults.streamServer.port

integer

1 <= x <= 65535

"4223/4222"

Port for streaming server connection (default value, changes depending on value of mTLS.enabled)

protocolMapperAgentDefaults.progressiveServiceDeployment

object

object

Configuration for a progressive service deployment

protocolMapperAgentDefaults.progressiveServiceDeployment.enabled

boolean

boolean

false

Enable progressive service deployment

protocolMapperAgentDefaults.progressiveServiceDeployment.warmupDuration

integer

1 <= x

Number of minutes the warmup period will be active for

protocolMapperAgentDefaults.progressiveServiceDeployment.warmupMinDelay

integer

1 <= x

Minimum delay in milliseconds an agent will use

protocolMapperAgentDefaults.progressiveServiceDeployment.warmupMaxDelay

integer

3001 <= x

Maximum delay in milliseconds an agent will use

protocolMapperAgentDefaults.existingAgentPasswordSecret

string

string

Name of existing Kubernetes Secret which holds the agents password as key 'agentPassword' (default value)

protocolMapperAgentDefaults.env

array or null

object

Environment variables as name and value pairs applied to an agent (default value)

protocolMapperAgentDefaults.env[].name

string

string

Name of the environment variable to be passed to an agent

protocolMapperAgentDefaults.env[].value

string

string

Value of the environment variable to be passed to an agent

protocolMapperAgentDefaults.image

object

object

Configuration for container image usage for an agent (default value)

protocolMapperAgentDefaults.image.registry

string

string

"registry.cybus.io/cybus"

Container image registry that will be pulled from (default value)

protocolMapperAgentDefaults.image.name

string

string

"protocol-mapper"

Name of the container image to pull (default value)

protocolMapperAgentDefaults.image.tag

string

string

Container image tag to use (default value)

protocolMapperAgentDefaults.image.pullPolicy

string

Always Never IfNotPresent

"IfNotPresent"

Kubernetes image pull policy used for an agent (default value)

protocolMapperAgentDefaults.image.pullSecrets

array

object

Existing Kubernetes image pull Secrets used by an agent (default value)

protocolMapperAgentDefaults.image.pullSecrets[].name

string

string

Name of the image pull Secret

protocolMapperAgentDefaults.labels

object

object

Labels applied to agent resources (default value)

protocolMapperAgentDefaults.tls

object

object

Configuration for TLS (default value)

protocolMapperAgentDefaults.tls.ca

object

object

Certificate Authority certificate chain used for TLS/mTLS (default value)

protocolMapperAgentDefaults.tls.ca.certChain

string

string

Certificate Authority certificate chain as a literal string in PEM format (default value)

protocolMapperAgentDefaults.tls.ca.existingConfigMap

string

string

"<installation-fullname>-tls-ca-cert"

Existing Kubernetes ConfigMap containing the Certificate Authority certificate chain in a PEM formatted file named ca-chain.pem (default value)

protocolMapperAgentDefaults.mTLS

object

object

Configuration for Mutual TLS (mTLS) (default value)

protocolMapperAgentDefaults.mTLS.enabled

boolean

boolean

false

Enable mTLS (default value, CA certificate chain can be set through tls.ca configuration values)

protocolMapperAgentDefaults.nodeSelector

object or null

object

{}

Node labels that must be present for a Node to be eligible for Pod placement (default value)

protocolMapperAgentDefaults.tolerations

array or null

object

[]

Tolerations for agent Pod assignment

protocolMapperAgentDefaults.persistence

object

object

Configuration for agent PersistentVolume (default value)

protocolMapperAgentDefaults.persistence.accessMode

string

ReadWriteOnce ReadWriteMany ReadWriteOncePod

"ReadWriteOnce"

Kubernetes access mode to request for the PersistentVolume (default value)

protocolMapperAgentDefaults.persistence.size

string

"40Mi"

Kubernetes Quantity to request as size for the PersistentVolume (default value)

protocolMapperAgentDefaults.persistence.storageClassName

string

string

Name of the Kubernetes StorageClass to request for the PersistentVolume (default value)

protocolMapperAgentDefaults.podAnnotations

object

object

Annotations applied to the agent Pods (default value)

protocolMapperAgentDefaults.podAntiAffinity

string

none soft hard

"soft"

podAntiAffinity behavior for an agent (default value)

protocolMapperAgentDefaults.podAntiAffinityOptions

object

object

Configuration for podAntiAffinity (default value)

protocolMapperAgentDefaults.podAntiAffinityOptions.key

string

string

"app.kubernetes.io/instance"

Key for the match expression (default value)

protocolMapperAgentDefaults.podAntiAffinityOptions.operator

string

In NotIn Exists DoesNotExist Gt Lt

"In"

Operator for the match expression (default value)

protocolMapperAgentDefaults.podAntiAffinityOptions.value

string

string

"<Release.Name>"

Value for the match expression (default value)

protocolMapperAgentDefaults.podAntiAffinityOptions.topologyKey

string

string

"kubernetes.io/hostname"

TopologyKey for podAntiAffinity (default value)

protocolMapperAgentDefaults.podLabels

object

object

Labels applied to the agent Pod (default value)

protocolMapperAgentDefaults.podSecurityContextOverride

object or null

object

Override default Kubernetes security context for an agent Pod (default value)

protocolMapperAgentDefaults.containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for an agent container (default value)

protocolMapperAgentDefaults.extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to an agent Pod (default value)

protocolMapperAgentDefaults.extraVolumes

array or null

Any type

Additional Volumes to be added to an agent Pod (default value)

protocolMapperAgentDefaults.extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to an agent core-container (default value)

protocolMapperAgentDefaults.extraInitContainers

array or null

Any type

Additional init containers to be added to an agent Pod (default value)

protocolMapperAgentDefaults.podPriorityClassName

string

string

""

Name of the PodPriorityClass (default value)

protocolMapperAgentDefaults.resources

object or null

object

Kubernetes compute resources for an agent (default value)

protocolMapperAgentDefaults.resources.limits

object

object

Limits for the Kubernetes compute resources for an agent (default value)

protocolMapperAgentDefaults.resources.limits.cpu

string or null

Kubernetes Quantity that describes the agents CPU limits (default value)

protocolMapperAgentDefaults.resources.limits.memory

string or null

Kubernetes Quantity that describes the agents memory limits (default value)

protocolMapperAgentDefaults.resources.requests

object

object

Requests for the Kubernetes compute resources for an agent (default value)

protocolMapperAgentDefaults.resources.requests.cpu

string or null

"1000m"

Kubernetes Quantity that describes the agents CPU requests (default value)

protocolMapperAgentDefaults.resources.requests.memory

string or null

"1000Mi"

Kubernetes Quantity that describes the agents memory requests (default value)

protocolMapperAgentDefaults.service

object

object

Configuration for Kubernetes Service of an agent (default value)

protocolMapperAgentDefaults.service.annotations

object

object

Annotations applied to the agents Service (default value)

protocolMapperAgentDefaults.service.labels

object

object

Labels applied to the agents Service (default value)

protocolMapperAgents

array

object

Collection of Connectware agents to be deployed. Each collection entry can contain configuration to override the defaults from protocolMapperAgentDefaults

protocolMapperAgents[].connectwareHost

string

string

DNS name under which the Connectware installation is available to this agent

protocolMapperAgents[].dataPlane

object

object

Configuration for data plane connection for this agent

protocolMapperAgents[].dataPlane.tls

boolean

boolean

false

Enable TLS for data plane connection for this agent

protocolMapperAgents[].dataPlane.host

string

string

Override the default host for the data plane connection for this agent

protocolMapperAgents[].dataPlane.port

integer

1 <= x <= 65535

"1883/8883"

Override the default port for the data plane connection for this agent

protocolMapperAgents[].streamServer

object

object

Configuration for streaming server for this agent

protocolMapperAgents[].streamServer.host

string

string

Override the default host for the stream server connection for this agent

protocolMapperAgents[].streamServer.port

integer

1 <= x <= 65535

"4223/4222"

Override the default port for the stream server connection for this agent

protocolMapperAgents[].progressiveServiceDeployment

object

object

Configuration for a progressive service deployment for this agent

protocolMapperAgents[].progressiveServiceDeployment.enabled

boolean

boolean

false

Enable progressive service deployment for this agent

protocolMapperAgents[].progressiveServiceDeployment.warmupDuration

integer

1 <= x

Number of minutes the warmup period will be active for

protocolMapperAgents[].progressiveServiceDeployment.warmupMinDelay

integer

1 <= x

Minimum delay in milliseconds this agent will use

protocolMapperAgents[].progressiveServiceDeployment.warmupMaxDelay

integer

3001 <= x

Maximum delay in milliseconds this agent will use

protocolMapperAgents[].existingAgentPasswordSecret

string

string

Name of existing Kubernetes Secret which holds the agents password as key 'agentPassword'

protocolMapperAgents[].env

array or null

object

Environment variables as name and value pairs applied to this agent

protocolMapperAgents[].env[].name

string

string

Name of the environment variable to be passed to this agent

protocolMapperAgents[].env[].value

string

string

Value of the environment variable to be passed to this agent

protocolMapperAgents[].image

object

object

Configuration for container image usage for this agent

protocolMapperAgents[].image.registry

string

string

"registry.cybus.io/cybus"

Container image registry that will be pulled from. Set to "" to not specify a registry

protocolMapperAgents[].image.name

string

string

"protocol-mapper"

Name of the container image to pull for this agent

protocolMapperAgents[].image.tag

string

string

Container image tag to use for this agent

protocolMapperAgents[].image.pullPolicy

string

Always Never IfNotPresent

"IfNotPresent"

Kubernetes image pull policy used for this agent

protocolMapperAgents[].labels

object

object

Labels applied to agent resources

protocolMapperAgents[].tls

object

object

Configuration for TLS

protocolMapperAgents[].tls.ca

object

object

Certificate Authority certificate chain used for TLS/mTLS

protocolMapperAgents[].tls.ca.certChain

string

string

Certificate Authority certificate chain as a literal string in PEM format

protocolMapperAgents[].tls.ca.existingConfigMap

string

string

"<agent-fullname>-tls-ca-cert"

Existing Kubernetes ConfigMap containing the Certificate Authority certificate chain in a PEM formatted file named ca-chain.pem

protocolMapperAgents[].mTLS

object

object

Configuration for Mutual TLS (mTLS)

protocolMapperAgents[].mTLS.enabled

boolean

boolean

false

Enable mTLS (CA certificate chain can be set through tls.ca configuration values)

protocolMapperAgents[].mTLS.keyPair

object

object

TLS keypair for mTLS. Provide cert and key to create a new Secret, or use existingSecret to reference an existing Kubernetes TLS Secret

protocolMapperAgents[].mTLS.keyPair.cert

string

string

TLS certificate in PEM format, as a literal string

protocolMapperAgents[].mTLS.keyPair.key

string

string

TLS private key in PEM format, as a literal string

protocolMapperAgents[].mTLS.keyPair.existingSecret

string

string

"<agent-fullname>-mtls"

Name of an existing Kubernetes TLS Secret containing the keypair. Must contain both key & cert as secret data with the keys: cert & key

protocolMapperAgents[].name

string

string

Name of the Connectware agent. If you use mTLS this must match the certificate's CN/SAN

protocolMapperAgents[].nodeSelector

object or null

object

Node labels that must be present for a Node to be eligible for Pod placement

protocolMapperAgents[].tolerations

array or null

object

Tolerations for agent Pod assignment

protocolMapperAgents[].persistence

object

object

Configuration for agent PersistentVolume

protocolMapperAgents[].persistence.accessMode

string

ReadWriteOnce ReadWriteMany ReadWriteOncePod

"ReadWriteOnce"

Kubernetes access mode to request for the PersistentVolume

protocolMapperAgents[].persistence.size

string

"40Mi"

Kubernetes Quantity to request as size for the PersistentVolume

protocolMapperAgents[].persistence.storageClassName

string

string

Name of the Kubernetes StorageClass to request for the PersistentVolume

protocolMapperAgents[].podAnnotations

object

object

Annotations applied to this agent Pod

protocolMapperAgents[].podAntiAffinity

string

none soft hard

"soft"

podAntiAffinity behavior for this agent

protocolMapperAgents[].podAntiAffinityOptions

object

object

Configuration for podAntiAffinity

protocolMapperAgents[].podAntiAffinityOptions.key

string

string

"app.kubernetes.io/instance"

Key for the match expression

protocolMapperAgents[].podAntiAffinityOptions.operator

string

In NotIn Exists DoesNotExist Gt Lt

"In"

Operator for the match expression

protocolMapperAgents[].podAntiAffinityOptions.value

string

string

"<Release.Name>"

Value for the match expression

protocolMapperAgents[].podAntiAffinityOptions.topologyKey

string

string

"kubernetes.io/hostname"

TopologyKey for podAntiAffinity

protocolMapperAgents[].podLabels

object

object

Labels applied to this agent Pod

protocolMapperAgents[].podSecurityContextOverride

object or null

object

Override default Kubernetes security context for this agent Pod

protocolMapperAgents[].containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for this agent container

protocolMapperAgents[].extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to this agent Pod

protocolMapperAgents[].extraVolumes

array or null

Any type

Additional Volumes to be added to this agent Pod

protocolMapperAgents[].extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to this agent core-container

protocolMapperAgents[].extraInitContainers

array or null

Any type

Additional init containers to be added to this agent Pod

protocolMapperAgents[].podPriorityClassName

string

string

""

Name of the PodPriorityClass for this agent

protocolMapperAgents[].resources

object or null

object

Kubernetes compute resources for this agent

protocolMapperAgents[].resources.limits

object

object

Limits for the Kubernetes compute resources for this agent

protocolMapperAgents[].resources.limits.cpu

string or null

Kubernetes Quantity that describes this agents CPU limits

protocolMapperAgents[].resources.limits.memory

string or null

Kubernetes Quantity that describes this agents memory limits

protocolMapperAgents[].resources.requests

object

object

Requests for the Kubernetes compute resources for this agent

protocolMapperAgents[].resources.requests.cpu

string or null

"1000m"

Kubernetes Quantity that describes this agents CPU requests

protocolMapperAgents[].resources.requests.memory

string or null

"1000Mi"

Kubernetes Quantity that describes this agents memory requests

protocolMapperAgents[].service

object

object

Configuration for Kubernetes Service of this agent

protocolMapperAgents[].service.annotations

object

object

Annotations applied to this agents Service

protocolMapperAgents[].service.labels

object

object

Labels applied to this agents Service

fullnameOverride

string

string

Override the full name of this installation, which is used as a name prefix. Use "" to remove prefixing

licenseKey

string

string

Your Connectware license key

nameOverride

string

string

Override the chart name of this installation, which is used as part of the name prefix

validVersion

string

string

Expected chart version for this values file

Connectware Toolkit Component Values Reference

When used as a subchart in the connectware Helm chart, you specify these values in the toolkit context of your values.yaml file.

Helm configuration values for the connectware-toolkit Helm chart

Property
Type
Required
Possible values
Default
Description

licenseKey

string

string

Connectware license key used to create the image pull secret

validVersion

string

string

Expected chart version for this values file

image

object

object

Configuration for container image usage

image.registry

string

string

"registry.cybus.io/cybus"

Container image registry that will be pulled from

image.name

string

string

"connectware-toolkit"

Name of the container image to pull

image.tag

string

string

Container image tag to use

image.pullPolicy

string

Always IfNotPresent Never

"IfNotPresent"

Kubernetes image pull policy used for the connectware-toolkit image

image.pullSecrets

array

object

Existing Kubernetes image pull Secrets used

image.pullSecrets[].name

string

string

Name of the image pull secret

mountCertsVolume

boolean

boolean

false

Mount the Connectware certs Volume (must be available in same namespace)

nodeSelector

object or null

object

Node labels that must be present for a Node to be eligible for Pod placement

tolerations

array or null

object

Tolerations for Pod assignment

labels

object

object

Labels applied to connectware-toolkit resources

annotations

object

object

Annotations applied to connectware-toolkit resources

podLabels

object

object

Labels applied to connectware-toolkit Pods

podAnnotations

object

object

Annotations applied to connectware-toolkit Pods

service

object

object

Configuration for Kubernetes Service

service.labels

object

object

Labels applied to the connectware-toolkit Service

service.annotations

object

object

Annotations applied to the connectware-toolkit Service

service.type

string

ClusterIP NodePort LoadBalancer

"ClusterIP"

Type of Service to create

service.loadBalancerIP

string

string

IP address for the LoadBalancer Service type

service.loadBalancerClass

string

string

LoadBalancer class for the Service

service.clusterIP

string

string

Cluster IP for the Service

service.externalTrafficPolicy

string

Cluster Local

External traffic policy for the Service

service.ports

array

object

Ports to expose in the connectware-toolkit Service

service.ports[].name

string

string

Name of the Service port

service.ports[].port

integer

integer

Port number for the Service

service.ports[].targetPort

integer

integer

Target port on the container

service.ports[].protocol

string

TCP UDP

"TCP"

Protocol used by the Service port

service.ports[].nodePort

integer

integer

Node port for NodePort Service

resources

object

object

Kubernetes compute resources for connectware-toolkit

resources.limits

object

object

resources.limits.cpu

string or null

Kubernetes Quantity that describes the component CPU limits

resources.limits.memory

string or null

Kubernetes Quantity that describes the service component limits

resources.requests

object

object

resources.requests.cpu

string or null

"200m"

Kubernetes Quantity that describes the componen CPU requests

resources.requests.memory

string or null

"250Mi"

Kubernetes Quantity that describes the component memory requests

podSecurityContextOverride

object or null

object

Override default Kubernetes security context for the Pod as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

containerSecurityContextOverride

object or null

object

Override default Kubernetes security context for the containers as defined by Kubernetes, see https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container

env

array or null

object

Environment variables as name and value pairs applied to connectware-toolkit Service

env[].name

string

string

Name of the environment variable

env[].value

string

string

Value of the environment variable

extraContainers

array or null

Any type

Additional containers (e.g. sidecars) to be added to the Pod

extraVolumes

array or null

Any type

Additional Volumes to be added to the Pod

extraVolumeMounts

array or null

Any type

Additional volume mounts to be added to the core-container

extraInitContainers

array or null

Any type

Additional init containers to be added to the Pod

podPriorityClassName

string

string

""

Name of the PodPriorityClass

Last updated

Was this helpful?