Install configuration

There is a small amount of configuration required to deploy kdb Insights Enterprise. The CLI install wizard provides a wizard to simplify this process and setup the required parameters. In addition you can apply more advanced configurations using the values file it produces. kdb Insights Enterprise is deployed as a Helm chart and is configured using a values file. This is a YAML formatted file used to set chart parameters.

Helm values

The required parameters for kdb Insights Enterprise involve setting up chart and image repositories, TLS certificates, credentials and similar configs. A sample values file looks something like below. The CLI creates some resources in Kubernetes and the values below reference those.

global:
  image:
    repository: registry.dl.kx.com
  imagePullSecrets:
  - name: kx-insights-nexus
  license:
    secretName: kxi-license
  caIssuer:
    name: kxi-certificate
    secretName: kxi-certificate
  ingress:
    host: "sample.kxi.example.com"

keycloak:
  auth:
    existingSecret: kxi-keycloak
  postgresql:
    auth:
      existingSecret: kxi-postgresql

The following sections detail more advanced options, which can be configured after running the install setup step. These can then be applied using the command below:

kxi install run --filepath values.yaml

Global values

Some configuration options can be applied globally across all components. Helm has special handling for the global key. For example the global.image.repository key in the example above sets the image registry for all components of kdb Insights Enterprise. In the following pages, config options will be flagged as global as it applies to them.

Conversely, the keycloak object defines configuration for the Keycloak component of the application.

The following pages will cover the available configuration by area, highlighting what they're used for, their default values and example usages.

YAML indexing notation

As explained above configuration consists of YAML objects. The documentation here will use . indexing to indicate values in a nested YAML object. For example, the repository object in the block below would be represented by global.image.repository.

global:
  image:
    repository: registry.dl.kx.com