Deployment
All Kaa services, including DCX, are distributed as Helm charts. You can run these charts using Kubernetes.
Installing DCX chart on Kubernetes
Preparation
These steps should be done once for your entire Kaa cluster in Kubernetes.
-
Install Helm client and Tiller server.
-
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 data: file: < your licence key file contents, base64-encoded > password: < your licence key password > kind: Secret metadata: name: license type: Opaque EOF kubectl create -f /tmp/kaa-licence.yaml
-
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. bob@example.com> KAAID_PASSWORD=<your KaaID password> kubectl create secret docker-registry kaaid --docker-server=hub.kaaiot.net --docker-username=$KAAID_EMAIL --docker-email=$KAAID_EMAIL --docker-password=$KAAID_PASSWORD
-
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 data: client-id: < your client-id, base64-encoded > client-secret: < your client-secret, base64-encoded > kind: Secret metadata: name: "keycloak-backend" labels: app.kubernetes.io/name: "kaa-name" helm.sh/chart: "kaa-chart-version" app.kubernetes.io/instance: "kaa-instance-name" app.kubernetes.io/managed-by: "release-service-name" EOF kubectl create -f /tmp/keycloak-backend-secret.yaml
-
Add the KaaIoT Helm repository:
helm repo add kaa-museum https://museum.kaaiot.net/
Installation
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
...
Chart Requirements
Repository | Name | Version |
---|---|---|
@stable | nats | 2.0.6 |
Chart Values
Key | Type | Default | Description |
---|---|---|---|
affinity | object | {} |
|
annotations.deployment | object | {} |
|
annotations.pod | 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.keycloak.backendSecretName | string | "" |
Name of the backend auth server secret, which must contain base64-encoded client-id and client-secret . Required. |
global.keycloak.baseUrl | string | "" |
Auth provider base URL. Required. |
global.keycloak.enabled | string | "" |
Enables API security using the auth provider. Overrides keycloak.enabled . |
global.keycloak.realm | string | "" |
Auth provider realm. Required. |
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.nats.url | string | "" |
NATS URL. Overrides nats.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 . |
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 | "hub.kaaiot.net/core/service/dcx/dcx" |
Docker image repository image URL. |
image.tag | string | "" |
Docker image tag version to pull and run. |
keycloak.enabled | string | "" |
Enables API security using the auth provider. Overrides global.keycloak.enabled . |
license.secretName | string | "" |
Name of the license secret, which must contain two base64-encoded fields: file (license file contents in PKCS #12) and password . |
metadata.component | string | "backend" |
|
metadata.partOf | string | "kaa" |
|
nameOverride | string | "" |
|
nats.auth.enabled | bool | false |
|
nats.enabled | bool | true |
Enables NATS dependency. For detailed info refer https://github.com/helm/charts/tree/master/stable/nats. |
nats.url | string | "nats://-nats-client:4222" |
NATS URL. |
nats.urlOverride | string | "" |
NATS URL. Overrides global.nats.url and nats.url . |
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 |
|
replicaCount | int | 1 |
The number of service instance replicas to run. |
resources | object | {} |
|
securityContext | object | {} |
|
tekton.enabled | string | "false" |
Enables Tekton integration. When disabled, the service will expect Kaa application configs to be defined in config . |
tekton.url | string | "http://-tekton" |
Tekton URL. |
tekton.urlOverride | string | "" |
Tekton URL. Overrides global.tekton.url and tekton.url . |
terminationMessagePolicy | string | "FallbackToLogsOnError" |
Kubernetes termination message policy. |
tolerations | list | [] |
|
updateStrategy.type | string | "RollingUpdate" |
Deployment update strategy. |
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_TEKTON_ENABLED |
false |
Enables Tekton integration. |
KAA_TEKTON_URL |
"http://tekton" |
URL of the Tekton service. |
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. |