Skip to content


kxi is configured using a configuration file ~/.insights/cli-config

Many commands require options that don't change often, such as the host that you're interacting with.

If you run kxi configure you will automatically be prompted for the necessary configuration and the configuration file will be created.

The configuration file allows these to be defaulted so you don't need to pass them every-time.

See the command line reference for a full list of options for the configure command.

Supported Settings

The currently supported settings are

Setting Default Description
hostname Hostname for the KX Insights Platform installation to interact with
namespace Namespace for the KX Insights Platform installation to interact with Name of the default client
client.secret Default client secret used to request access tokens
license.secret kxi-license Secret containing kdb+ license kx-insights Name for chart repository
chart.repo.url Repository URL to pull charts from
image.pullSecret kxi-nexus-pull-secret Secret containing credentials for the image repository
image.repository Repository to pull images from
keycloak.secret kxi-keycloak Secret containing Keycloak admin password
keycloak.postgresqlSecret kxi-postgresql Secret containing Keycloak postgresql passwords
ingress.cert.secret kxi-ingress-cert Secret containing self-managed TLS cert and key for the ingress
install.outputFile values.yaml Name for the generated values file
install.configSecret kxi-install-config Secret containing helm install values
assembly.backup.file kxi-assembly-state.yaml Filepath to store state of running assemblies insights Release name for the install
realm insights Name of Keycloak realm

These can be overridden by explicitly passing the value if desired, or by editing the ~/.insights/cli-config file directly. When the setting is omitted fom the file, the default value is used where applicable.


kxi also supports a global --profile option if you are frequently running commands against various different installs or for different clients.

A different profile can be added by calling kxi configure --profile <name of new profile>.

The new profile can then be used as follows:

kxi --profile <name of new profile> <subcommand> [OPTIONS]


An example configuration file


hostname = = my-publisher
client.secret = my-secret

hostname = = profile-1-publisher
client.secret = profile-1-secret