Skip to content

CLI Reference

This page provides documentation for our command line tools.

kxi

KX Insights CLI

Usage:

kxi [OPTIONS] COMMAND [ARGS]...

Options:

  --version       Show the version and exit.
  --debug         Enable debug logging.
  --profile TEXT  Name of configuration profile to use.
  --help          Show this message and exit.

kxi assembly

Assembly interaction commands

Usage:

kxi assembly [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

kxi assembly backup

Back up running assemblies to a file

Usage:

kxi assembly backup [OPTIONS]

Options:

  --namespace TEXT  Namespace to retrieve assemblies from
  --filepath TEXT   Filepath to store state of running assemblies
  --help            Show this message and exit.

kxi assembly create

Create an assembly given an assembly file

Usage:

kxi assembly create [OPTIONS]

Options:

  --namespace TEXT  Namespace to create assembly in
  --filepath TEXT   Path to assembly file  [required]
  --wait            Wait for all pods to be running
  --help            Show this message and exit.

kxi assembly delete

Deletes an assembly given its name

Usage:

kxi assembly delete [OPTIONS]

Options:

  --namespace TEXT  Namespace that the assembly is in
  --name TEXT       Name of the assembly to delete  [required]
  --wait            Wait for all pods to be deleted
  --force           Delete assembly without getting confirmation
  --help            Show this message and exit.

kxi assembly list

List assemblies

Usage:

kxi assembly list [OPTIONS]

Options:

  --namespace TEXT  Namespace that the assemblies are in
  --help            Show this message and exit.

kxi assembly status

Print status of the assembly

Usage:

kxi assembly status [OPTIONS]

Options:

  --namespace TEXT  Namespace that the assembly is in
  --name TEXT       Name of the assembly get the status of  [required]
  --wait-for-ready  Wait for assembly to reach "Ready" state
  --help            Show this message and exit.

kxi auth

Authentication and authorization commands

Usage:

kxi auth [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

kxi auth get-access-token

Get an access token for a client id and secret

Usage:

kxi auth get-access-token [OPTIONS]

Options:

  --hostname TEXT       Hostname of Insights deployment
  --client-id TEXT      Client ID to request access token for
  --client-secret TEXT  Client secret to request access token
  --realm TEXT          Name of Keycloak realm
  --help                Show this message and exit.

kxi auth get-admin-token

Get an admin access token for the Keycloak Admin API

Usage:

kxi auth get-admin-token [OPTIONS]

Options:

  --hostname TEXT  Hostname of Insights deployment
  --username TEXT  Keycloak admin username  [required]
  --password TEXT  Keycloak admin password  [required]
  --help           Show this message and exit.

kxi client

Commands for interacting with clients

Usage:

kxi client [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

kxi client enrol

Enrol a client in the system

Usage:

kxi client enrol [OPTIONS]

Options:

  --hostname TEXT       Hostname of Insights deployment
  --name TEXT           Name of client to enrol  [required]
  --insert-topic TEXT   Topic to insert data on  [required]
  --client-id TEXT      Client ID to request an access token with
  --client-secret TEXT  Client secret to request access token
  --realm TEXT          Name of Keycloak realm
  --help                Show this message and exit.

kxi client info

Get certs and endpoints for a client

Usage:

kxi client info [OPTIONS]

Options:

  --hostname TEXT  Hostname of Insights deployment
  --uid TEXT       Client UID to request info for  [required]
  --help           Show this message and exit.

kxi client list

List Keycloak clients in the system

Usage:

kxi client list [OPTIONS]

Options:

  --hostname TEXT  Hostname of Insights deployment
  --realm TEXT     Name of Keycloak realm
  --username TEXT  Keycloak admin username  [required]
  --password TEXT  Keycloak admin password  [required]
  --help           Show this message and exit.

kxi client remove

Remove a client from the system

Usage:

kxi client remove [OPTIONS]

Options:

  --hostname TEXT       Hostname of Insights deployment
  --name TEXT           Name of the client to remove  [required]
  --client-id TEXT      Client ID to request an access token with
  --client-secret TEXT  Client secret to request access token with
  --realm TEXT          Name of Keycloak realm
  --help                Show this message and exit.

kxi configure

Configure the CLI

Usage:

kxi configure [OPTIONS]

Options:

  --profile TEXT  Name of profile to configure.
  --help          Show this message and exit.

kxi install

Insights installation commands

Usage:

kxi install [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

kxi install delete

Uninstall KX Insights

Usage:

kxi install delete [OPTIONS]

Options:

  --release TEXT  Release name for the install
  --help          Show this message and exit.

kxi install get-values

Display the kxi-install-config secret used for storing installation values

Usage:

kxi install get-values [OPTIONS]

Options:

  --namespace TEXT              Kubernetes namespace
  --install-config-secret TEXT  Secret containing helm install values
  --help                        Show this message and exit.

kxi install list-versions

List available versions of KX Insights

Usage:

kxi install list-versions [OPTIONS]

Options:

  --repo TEXT  Name for chart repository
  --help       Show this message and exit.

kxi install run

Install KX Insights with a values file

Usage:

kxi install run [OPTIONS]

Options:

  --namespace TEXT              Kubernetes namespace
  --filepath TEXT               Values file to install with
  --release TEXT                Release name for the install
  --repo TEXT                   Name for chart repository
  --version TEXT                Version to install  [required]
  --operator-version TEXT       Version of the operator to install
  --image-pull-secret TEXT      Secret containing credentials for the image
                                repository
  --license-secret TEXT         Secret containing kdb+ license
  --install-config-secret TEXT  Secret containing helm install values
  --help                        Show this message and exit.

kxi install setup

Perform necessary setup steps to install Insights

Usage:

kxi install setup [OPTIONS]

Options:

  --namespace TEXT                Kubernetes namespace
  --chart-repo-name TEXT          Name for chart repository
  --license-secret TEXT           Secret containing kdb+ license
  --license-as-env-var BOOLEAN    Mount kdb+ license secret as an environment
                                  variable
  --client-cert-secret TEXT       Secret containing TLS cert and key for
                                  client issuer
  --image-repo TEXT               Repository to pull images from
  --image-pull-secret TEXT        Secret containing credentials for the image
                                  repository
  --gui-client-secret TEXT        Keycloak client secret for gui service
                                  account
  --operator-client-secret TEXT   Keycloak client secret for operator service
                                  account
  --keycloak-secret TEXT          Secret containing Keycloak admin password
  --keycloak-postgresql-secret TEXT
                                  Secret containing Keycloak postgresql
                                  passwords
  --keycloak-auth-url TEXT        Auth URL for Keycloak
  --ingress-host TEXT             Hostname for the installation
  --ingress-cert-secret TEXT      Secret containing self-managed TLS cert and
                                  key for the ingress
  --output-file TEXT              Name for the generated values file
  --install-config-secret TEXT    Secret containing helm install values
  --help                          Show this message and exit.