CLI Configuration
This page explains how to configure the KXI Command Line Interface (CLI).
Prerequisite
You have installed the CLI from the KX Download Portal, following the instructions in the CLI installation guide.
Configure the CLI
The KXI Command Line Interface (CLI) tool is used for configuring and managing kdb Insights Enterprise. The configuration is handled through a configuration file; that is ~/.insights/cli-config. This file stores default values for options that are frequently used, such as the host you're interacting with, so you don't need to specify them every time you run a command.
Once you have installed the CLI, run the kxi configure command to create the ~/.insights/cli-config configuration file.
Supported Settings
The supported settings you can configure are:
|
setting |
default |
description |
|---|---|---|
|
hostname |
|
Hostname for the kdb Insights Enterprise installation to interact with |
|
namespace |
kxi |
Namespace for the kdb Insights Enterprise installation to interact with |
|
auth.serviceaccount.id |
|
Name of the default client |
|
auth.serviceaccount.secret |
|
Default client secret used to request access tokens |
|
license.secret |
kxi-license |
Secret containing kdb+ license |
|
license.as-env-var |
False |
Mount kdb+ license secret as an environment variable |
|
license.filepath |
|
File path and file name of kdb+ license file |
|
chart.repo.name |
kx-insights |
Name for chart repository |
|
chart.repo.url |
https://portal.dl.kx.com/assets/helm/ |
Repository URL to pull charts from |
|
chart.repo.username |
|
Username for the chart repository |
|
chart.repo.password |
|
Password for the chart repository |
|
image.pullSecret |
kxi-image-pull-secret |
Secret containing credentials for the image repository |
|
image.repository |
|
Repository to pull images from |
|
image.repository.user |
|
User name for image repository |
|
image.repository.password |
|
Password for image repository |
|
keycloak.secret |
kxi-keycloak |
Secret containing Keycloak admin password |
|
keycloak.admin.password |
|
|
|
keycloak.management.password |
|
|
|
keycloak.postgresqlSecret |
kxi-postgresql |
Secret containing Keycloak postgresql passwords |
|
postgresql.postgres.password |
|
|
|
postgresql.user.password |
|
|
|
keycloak.authURL |
|
Auth URL for Keycloak |
|
admin.user |
user |
|
|
admin.password |
|
|
|
realm |
insights |
Name of Keycloak realm |
|
ingress.cert.secret |
kxi-ingress-cert |
Secret containing self-managed TLS cert and key for the ingress |
|
ingress.certmanager.disabled |
False |
Flag to disable usage of TLS certmanager |
|
ingress.cert |
|
File path to TLS certificate for the ingress |
|
ingress.key |
|
File path to TLS private key for the ingress |
|
install.outputFile |
values.yaml |
Name for the generated values file |
|
assembly.backup.file |
kxi-assembly-state.yaml |
Filepath to store state of running assemblies |
|
release.name |
insights |
Release name for the install |
|
client.cert.secret |
kxi-certificate |
Secret containing TLS cert and key for client issuer |
|
guiClientSecret |
|
Keycloak client secret for GUI service account |
|
operatorClientSecret |
|
Keycloak client secret for operator service account |
|
install.filepath |
|
Values file to install with |
|
version |
|
Version to install |
|
operator.version |
|
Version of the operator to install |
Existing users can use the following links to access KX Nexus until Nexus is removed in the future:
|
setting |
default |
description |
|---|---|---|
|
chart.repo.url |
https://nexus.dl.kx.com/repository/kx-insights-charts |
Repository URL to pull charts from |
|
image.repository |
registry.dl.kx.com |
Repository to pull images from |
|
image.pullSecret |
kxi-nexus-pull-secret |
Secret containing credentials for the image repository |
Override the default values by explicitly passing the value, or by editing the ~/.insights/cli-config file directly.
When a setting is omitted from the file, the default value is used.
Note
If you deployed from the Azure Marketplace, then your namespace must be "insights".
Profiles
kxi has a global --profile parameter to support multiple sets of configuration values.
Run the kxi configure --profile <name of new profile> command to create a profile.
Use a profile with the --profile parameter.
bash
kxi --profile <name of new profile> <subcommand> [OPTIONS]
The values under the default profile are used when you do not supply a --profile parameter.
Each profile is independent of each other, which means default values are not used if you supply a --profile parameter.
Note
The order of parameters in the command is important. Ensure that you add the --profile parameter and the name
of the profile before the
Example
See below an example configuration file:
~/.insights/cli-config
shell
[default]
hostname = https://my-host.kx.com
auth.serviceaccount.id = my-publisher
auth.serviceaccount.secret = my-secret
[profile-1]
hostname = https://profile-1.kx.com
auth.serviceaccount.id = profile-1-publisher
auth.serviceaccount.secret = profile-1-secret