Skip to content

Getting started

Running with Docker

Architecture

There are three images in total each perform it's own function.

  • gui-dash - core static Dashboard Direct web app files served by the web server

  • gui-gateway - q server handles dashboards queries and manages list of dashboards and connection

  • gui-data - q data server manages demo datasets requested from the gui-gateway

Screenshot

Containers structure constrains

There are certain limitations in terms of container names especially for the gui-gateway that is referenced under this name in the gui-dash nginx config. The gui-dash image has an Nginx server running that is responsible for redirecting API calls from the web app to the gui-gateway app server. In its core is the nginx.config file that provides configuration to the Nginx and tells it redirects API calls to the gui-gateway image container. The container name is static and is baked in the docker image file.

Prerequisites

To run the images one would require one of the following operating systems Mac, Windows or Linux, capable of running following software:

  1. Docker
  2. Docker compose

Running steps

1) Make sure that Docker is running on the host system.

Note: Depending on the user operating system a different command prompt will need to be used. On Windows, we recommend using the Powershell.

2) Login to KX Docker registry with the login credentials provided to you to pull images

docker login registry.dl.kx.com -u username -p password

Contact your Kx representative for further information on your username and password setup required for this step.

3) Create docker-compose.yml file to pull and execute docker images

An example Docker Compose file is provided here:

# docker-compose.yml
version: "3.7"
networks:
  kx:
    name: kx
    driver: bridge
volumes:
  gw-data:
services:
  gui-dash:
    image: "registry.dl.kx.com/kxi-gui-dash:0.9.0"
    ports: 
      - 9090:8080
    networks:
      - kx
    depends_on:
      - gui-gateway
  gui-gateway:   
    image: "registry.dl.kx.com/kxi-gui-gateway:0.9.0"
    ports:
      - 10001:10001
    networks:
      - kx
    # enable relative
    volumes:
      # Store app state in the gw-data volume
      - gw-data:/opt/kx/app/data
      ## Windows - create lic directory with valid kc.lic file
      #- ./lic:/opt/kx/lic
      ## Linux - make sure kc.lic file is present in ${HOME}/.qp.licenses
      #- ${HOME}/.qp.licenses:/opt/kx/lic
    depends_on:
      - gui-data
  gui-data:
    image: "registry.dl.kx.com/kxi-gui-data:0.9.0"
    ports:
      - 6812:6812
    volumes:
      - .:/opt/kx/app/sample/hdb/date
      ## Windows - create lic directory with valid kc.lic file
      #- ./lic:/opt/kx/lic
      ## Linux - make sure kc.lic file is present in ${HOME}/.qp.licenses
      #- ${HOME}/.qp.licenses:/opt/kx/lic
    networks:
      - kx

Note: This step requires that an appropriate kdb+ licence file is present on the host computer file system. The licence file is then mounted as a volume to the gui-gateway and qui-data. The recommended path to licence file on the host system vary between Linux and Windows; for example, in Windows your docker-compose.yml file could be in C:\Users\yourname\Desktop\Kx-Docker folder and your license file in C:\Users\yourname\Desktop\Kx-Docker\lic folder.

To enable licence volume mounting uncomment appropriate line in the volumes property of the docker-compose.yml file above.

Make sure to enable the volumes: block in the gui-gateway section of docker-compose.yml; uncomment one of the following lines:

Linux Make sure that kc.lic is present in the ${HOME}/.qp.licenses directory.

- ${HOME}/.qp.licenses:/opt/kx/lic 

Windows In the same directory as the docker-compose.yml create the lic folder and add your kc.lic license.

- ./lic:/opt/kx/lic

Info: For more information on kdb+ licenses refer to licensing.

3) To start the app, from the directory with the docker-compose.yml script file run:

docker-compose up

Open in the web browser http://localhost:9090 to view running Dashboards app.

4) To stop the app Press ctl-c to exit running process in terminal and execute:

docker-compose down

Gateway State persistence

The gui-gateway container is responsible for managing Dashboards’ states, including connections, dashboards and URLs. These states are saved in a data file within the container. To preserve the state in case of failure, a volume, gw-data, is used to preserve static data.

To view all available volumes run:

docker volume ls

To obtain information about a container, run:

docker volume inspect [volume name]

where [volume name] is the name generated by [directory-name]_gw.data. For example, direct-dash_gw_data

To remove the volume, stop all running gui-gateway containers with:

docker-compose down

Then run:

docker volume rm [volume name]

Running with Kubernetes

A Helm chart has been provided for installing the Dashboards service into a Kubernetes cluster.

Prerequisites

To run within Kubernetes there are a number of pre-requisites:

Kdb+ License

To start the Dashboards service within Kubernetes, a license Secret should be installed into the Kubernetes cluster.

First, print the base64 encoded license:

$ base64 -w 0 $QLIC/kc.lic

Then create and apply a Secret containing the encoded license text:

$ cat kx-license-secret.yaml
apiVersion: v1
kind: Secret
metadata:
  name: kx-license-info
type: Opaque
stringData:
  license: <base64 license string>

$ kubectl apply -f kx-license-secret.yaml

Helm

Add the KX Helm chart repository to your helm install:

$ helm repo add --username <username> --password <password> \
    kxi-repo https://nexus.dl.kx.com/repository/kx-insights-charts/
"kxi-repo" has been added to your repositories

Update your helm repo local chart cache:

$ helm repo update
Hang tight while we grab the latest from your chart repositories...
...Successfully got an update from the "internal-insights" chart repository
Update Complete. ⎈Happy Helming!⎈

Add a Secret to your cluster to allow access to the images:

$ kubectl create secret docker-registry kx-repo-access \
    --docker-username=<username> \
    --docker-password=<password> \
    --docker-server=registry.dl.kx.com

Note

In the case above the secret kx_repo_access has been created. When deploying the charts it will be necessary to reference this Secret in the imagePullSecrets within the configuration file.

Configuration file

A configuration file is required to run Dashboards with applied licence and repo access Secret. This will enable LoadBalancer, which will automatically assign an IP address to each pod so that Dashboards can be accessed externally.

Note: it is possible to remove LoadBalancing by removing service: type: LoadBalancer lines from the configuration (see below). In this case, to access Dashboards you must use port forwarding for local access; see Accessing the Dashboards Locally

$ cat dash.yaml
license:
  secretName: kx-license-info

imagePullSecrets:
  - name: kx-repo-access

service:
  type: LoadBalancer
livenessProbe:
  enabled: true
readinessProbe:
  enabled: true
startupProbe:
  enabled: true
gui-gateway:
  service:
    type: LoadBalancer
  livenessProbe:
    enabled: true
  readinessProbe:
    enabled: true
  startupProbe:
    enabled: true
  gui-data:
    service:
      type: LoadBalancer
    livenessProbe:
      enabled: true
    readinessProbe:
      enabled: true
    startupProbe:
      enabled: true

Installing Dashboards

$ helm install sp kxi-repo/gui-dash --version="0.9.0" -f path/to/dash.yml

Accessing Dashboards

Accessing Dashboards is possible using the EXTERNAL-IP address and port 8080, separated by a colon; i.e. EXTERNAL-IP:8080

To get the IP address use Kubernetes command:

kubectl get services/gui-dash

Accessing Dashboards Locally

To access Dashboards locally, use port forwarding of the pod running Dashboards.

Get pod names:

kubectl get po

This will return a list of pods. The required pod uses a name beginning with gui-dash, followed by some random ID number e.g. gui-dash-1234567890-12345

Then expose the pod port, run the command using the aforementioned gui-dash id unique to your pod:

kubectl port-forward gui-dash-1234567890-12345 8080:8080

Then go tho the localhost:8080 to view Dashboards.

Screenshot

Download

 KX Dashboards Windows   Linux   Mac

Prerequisites

KX Dashboards is a minimal portable install only requiring kdb+ 3.4+ to run.

  1. Install kdb
  2. Define q as a command

Install and run

  1. Extract Dashboards zip file...
  2. Run KX Dashboards and a sample data process.
    Windows : click dash.bat to launch from the Dashboards folder
    Linux  and MacOS : manually open a terminal and launch the processes.
$ q sample/demo.q -u 1 &
$ q dash.q -p 10001 -u 1

Options

-secure restricts dash.q to access only functions defined on the .api namespace
-p listening port to serve KX Dashboards
-u 1 disables system commands and no access above start directory
-u usr-pwd sets a password file for basic authentication
-E TLS server mode

See the full command-line reference for more detailed explanation

Upgrade

Follow the steps to upgrade your existing installation to the latest version of dashboards.

Upgrade

Open Dashboards

Dashboard starts with a Demo page in Viewer mode by default. To enable the dashboard editor, insert /edit/ between the URL and #dashboard reference. This will enable menu options to create your own dashboard.

Screenshot

  1. Drag a component from the left and arrange on the central canvas, e.g. Data Grid
  2. Configure properties on the right, e.g. set a new Data Source to view data
  3. Add a form component and link it using View States

Continue adding components and setting properties to build, style and share interactive visualisations