All Kaa services, including DCX, are distributed as Helm charts. You can run these charts using Kubernetes.

Installing DCX chart on Kubernetes


These steps should be done once for your entire Kaa cluster in Kubernetes.

  1. Install Kubernetes.

  2. Install Helm client and Tiller server.

  3. Create a Kaa license secret (remember to put in your Kaa license key file contents and password):

     export HISTCONTROL=ignorespace # Prevent saving your key password in the shell history; note the leading space in the next line
      cat << EOF > /tmp/kaa-licence.yaml
     apiVersion: v1
       file: < your licence key file contents, base64-encoded >
       password: < your licence key password >
     kind: Secret
       name: license
       type: Opaque
     kubectl create -f /tmp/kaa-licence.yaml
  4. Specify the image pull secret for the official KaaIoT docker registry. To define this secret, use your KaaID credentials:

     export HISTCONTROL=ignorespace  # Prevent saving your credentials in the shell history; note the leading space in the next line
      export KAAID_EMAIL=<your KaaID email, eg.> KAAID_PASSWORD=<your KaaID password>
     kubectl create secret docker-registry kaaid --docker-username=$KAAID_EMAIL --docker-email=$KAAID_EMAIL --docker-password=$KAAID_PASSWORD
  5. If you want to enable API security in your Kaa cluster (recommended), you should create an auth server backend secret for the service to be able to request PAT tokens.

     export HISTCONTROL=ignorespace # Prevent saving your client ID amd secret in the shell history; note the leading space in the next line
      cat << EOF > /tmp/keycloak-backend-secret.yaml
     apiVersion: v1
       client-id: < your client-id, base64-encoded >
       client-secret: < your client-secret, base64-encoded >
     kind: Secret
       name: "keycloak-backend"
       labels: "kaa-name" "kaa-chart-version" "kaa-instance-name" "release-service-name"
     kubectl create -f /tmp/keycloak-backend-secret.yaml
  6. Add the KaaIoT Helm repository:

     helm repo add kaa-museum


Once you have completed the preparation steps, everything is ready for deploying DCX on your Kubernetes cluster. To deploy the service, run the following command (observe the reference to the previously created license secret):

helm install --set global.license.secretName=license kaa-museum/dcx --name kaa-dcx

Check that pods are running:

kubectl get pods

Once the service initialization is complete, you should observe the output similar to the below:

NAME                                          READY   STATUS             RESTARTS   AGE
kaa-dcx                                       1/1     Running            0          2m


Repository Name Version
@bitnami redis 10.5.7
@kaa service-chart 0.0.48


Key Type Default Description
affinity object {}  
annotations.deployment object {}  
annotations.pod object {}  
autoscaling.enabled bool false  
autoscaling.maxReplicas int 10  
autoscaling.minReplicas int 1  
autoscaling.targetCustomMetric object {}  
config string "" Content for the service config map, automatically mounted as a config file into the pod.
env object {} Defines the environment variables that Kubernetes passes to the service replica.
extraPodSpecs.automountServiceAccountToken bool false  
fullnameOverride string ""  
global.image.pullSecrets list [] List of image pull secret names. Each must be defined as a record with the name field. Overrides image.pullSecrets.
global.kaaIngress.tls.issuerKind string "Issuer"  
global.kaaIngress.tls.issuerName string "letsencrypt-stage"  
global.kaaIngress.tls.selfSigned bool false  
global.keycloak.backend.existingSecret string "-keycloak-backend"  
global.keycloak.enabled string "" Enables API security using the auth provider. Overrides keycloak.enabled.
global.keycloak.privateUrl string ""  
global.keycloak.publicUrl string ""  
global.license.secretName string "" Name of the license secret, which must contain two base64-encoded fields: file (license file contents in PKCS #12) and password. Overrides license.secretName.
global.monitoring.enabled bool false  
global.nats.url string "" NATS URL. Overrides nats.url.
global.redis.url string "" Redis URL. Overrides redis.url.
global.tekton.enabled string "" Enables Tekton integration. When disabled, the service will expect Kaa application configs to be defined in the config map. Overrides tekton.enabled.
global.tekton.url string "" Tekton URL. Overrides tekton.url.
global.tenantManager.baseUrl string "" Tenant manager base URL.
global.tenantManager.enabled string "" Enables multitenancy using the Kaa Tenant Manager. Overrides tenantManager.enabled.
image.pullPolicy string "IfNotPresent" Docker image pull policy.
image.pullSecrets list [] List of image pull secret names. Each must be defined as a record with the name field.
image.repository string "" Docker image repository image URL.
image.tag string "" Docker image tag version to pull and run.
metadata.component string "backend"  
metadata.partOf string "kaa"  
nameOverride string ""  
nodeSelector object {}  
probes.enabled bool true Enables liveness, readiness, and startup probes for containers.
probes.liveness.initialDelaySeconds int 15  
probes.liveness.periodSeconds int 3  
probes.readiness.initialDelaySeconds int 5  
probes.readiness.periodSeconds int 1  
redis.cluster.enabled bool false  
redis.enabled bool true For detailed info please look in
redis.master.persistence.enabled bool true  
redis.url string "redis://--master:6379/0" Redis url
redis.urlOverride string "" Redis URL. Overrides global.redis.url and redis.url.
redis.usePassword bool false  
replicaCount int 1 The number of service instance replicas to run.
resources.limits.cpu int 1  
resources.limits.memory string "512Mi"  
resources.requests.cpu string "100m"  
resources.requests.memory string "128Mi"  
rules[0].alert string "The DCX receiver epts response error."  
rules[0].annotations.message string "Got more then 100 epts response error on the pod [/] for last 10 minutes."  
rules[0].annotations.runbook string ""  
rules[0].expr string "increase(kaa_dcx_receiver_epts_response_errors_total{}[10m]) > 100"  
rules[0].for string "10m"  
rules[0].labels.severity string "error"  
rules[1].alert string "The DCX receiver epts response error."  
rules[1].annotations.message string "Got more then 100 kdca response error on the pod [/] for last 10 minutes."  
rules[1].annotations.runbook string ""  
rules[1].expr string "increase(kaa_dcx_receiver_kdca_response_errors_total{}[10m]) > 100"  
rules[1].for string "10m"  
rules[1].labels.severity string "error"  
runbookUrl string ""  
securityContext object {}  
service.type string "ClusterIP"  
terminationMessagePolicy string "FallbackToLogsOnError" Kubernetes termination message policy.
tolerations list []  
updateStrategy.type string "RollingUpdate" Deployment update strategy.
waitContainers.curl.image string ""  
waitContainers.curl.tag string "0.0.2"  
waitContainers.enabled bool true Waiting for dependent on services.
waitContainers.timeout int 300 Waiting for dependent on services in seconds.

The keys with no description are standard Kubernetes values. Refer to the official Kubernetes documentation for more information on these.

Environment variables

The table below summarizes the variables supported by the DCX Docker image and provides default values along with descriptions.

Variable name Default value Description
APP_CONFIG_PATH /srv/dcx/service-config.yml Path to the service configuration YAML file inside container. In case of running in Kubernetes, consider using K8s Volumes for externalization.
NATS_URLS "nats://nats:4222" NATS connection URLs. May include connection credentials, e.g. "nats://derek:pass@localhost:4222".
KAA_REDIS_URL "redis://redis-dcx:6379/0" Redis URL.
KAA_TEKTON_ENABLED false Enables Tekton integration.
KAA_TEKTON_URL "http://tekton" URL of the Tekton service.
KAA_SECURITY_ENABLED false Enables authentication and authorization for outbound REST API calls.
KAA_SECURITY_ISSUER_PUBLIC_URL   OAuth 2.0 issuer public URL for the system tenant (“kaa”).
KAA_SECURITY_ISSUER_PRIVATE_URL   OAuth 2.0 issuer private URL for the system tenant (“kaa”).
KAA_SECURITY_CLIENT_ID   Client ID for making requests in the system tenant scope.
KAA_SECURITY_CLIENT_SECRET   Client secret for making requests in the system tenant scope.
KAA_SECURITY_MULTITENANCY_ENABLED false Enables multitenancy via integration with the Kaa Tenant Manager. Only effective when is set to true.
KAA_SECURITY_MULTITENANCY_TENANT_MANAGER_URL "http://tenant-manager" URL of the Kaa Tenant Manager that provides security configurations for tenants.
KAA_LICENSE_CERT_PATH /run/license/license.p12 Path to the Kaa platform license certificate file in PKCS #12 format.
KAA_LICENSE_CERT_PASSWORD   License certificate password. Required.
SERVICE_DEBUG false Enables debug level logging.