CLI Reference
This page provides documentation for our command line tools.
kxi
kdb Insights Enterprise 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:
-n, --namespace TEXT Kubernetes namespace
-f, --filepath TEXT Filepath to store state of running assemblies
--force Perform action without prompting for confirmation
--help Show this message and exit.
kxi assembly deploy
Create an assembly given an assembly file
Usage:
kxi assembly deploy [OPTIONS]
Options:
--hostname, --ingress-host TEXT
Hostname of Insights deployment
--client-id TEXT Client ID to request an access token with
--client-secret TEXT Client secret to request an access token
with
--realm TEXT Name of Keycloak realm
-n, --namespace TEXT Kubernetes namespace
-f, --filepath TEXT Path to the assembly file
--wait, --wait-for-ready Wait for all pods
--use-kubeconfig Communicate directly with kubernetes plane
--help Show this message and exit.
kxi assembly list
List assemblies
Usage:
kxi assembly list [OPTIONS]
Options:
--hostname, --ingress-host TEXT
Hostname of Insights deployment
--client-id TEXT Client ID to request an access token with
--client-secret TEXT Client secret to request an access token
with
--realm TEXT Name of Keycloak realm
-n, --namespace TEXT Kubernetes namespace
--use-kubeconfig Communicate directly with kubernetes plane
--help Show this message and exit.
kxi assembly status
Print status of the assembly
Usage:
kxi assembly status [OPTIONS]
Options:
-n, --namespace TEXT Kubernetes namespace
--name TEXT Name of the assembly [required]
--wait, --wait-for-ready Wait for all pods
--hostname, --ingress-host TEXT
Hostname of Insights deployment
--client-id TEXT Client ID to request an access token with
--client-secret TEXT Client secret to request an access token
with
--realm TEXT Name of Keycloak realm
--use-kubeconfig Communicate directly with kubernetes plane
--help Show this message and exit.
kxi assembly teardown
Tears down an assembly given its name
Usage:
kxi assembly teardown [OPTIONS]
Options:
-n, --namespace TEXT Kubernetes namespace
--name TEXT Name of the assembly [required]
--wait, --wait-for-ready Wait for all pods
--force Perform action without prompting for
confirmation
--hostname, --ingress-host TEXT
Hostname of Insights deployment
--client-id TEXT Client ID to request an access token with
--client-secret TEXT Client secret to request an access token
with
--realm TEXT Name of Keycloak realm
--use-kubeconfig Communicate directly with kubernetes plane
--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, --ingress-host 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, --ingress-host TEXT
Hostname of Insights deployment
--username TEXT Keycloak admin username [required]
--password TEXT Keycloak admin password [required]
--help Show this message and exit.
kxi backup
Insights data backup related commands
Usage:
kxi backup [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi backup init
Usage:
kxi backup init [OPTIONS]
Options:
--az-stg-acc-name TEXT
--az-stg-acc-key TEXT
-n, --namespace TEXT Kubernetes namespace
--restic-pw TEXT
--obj-store-provider TEXT
--help Show this message and exit.
kxi backup set-backup
Usage:
kxi backup set-backup [OPTIONS]
Options:
--backup-name TEXT
-n, --namespace TEXT Kubernetes namespace
--azure-blob-name TEXT
--help Show this message and exit.
kxi backup snapshots
Usage:
kxi backup snapshots [OPTIONS]
Options:
--azure-blob-name TEXT
-n, --namespace TEXT Kubernetes namespace
--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, --ingress-host 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, --ingress-host 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, --ingress-host 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, --ingress-host 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 idp
Azure Identity Provider commands
Usage:
kxi idp [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi idp add
Add an Azure Identity Provider to a Keycloak realm
Usage:
kxi idp add [OPTIONS]
Options:
--azure-tenant-id TEXT Azure Tenant ID where the operations should
point to [required]
--azure-app-registration-name TEXT
Name of the azure app registration to be
used [required]
--azure-enable-interactive-login / --azure-disable-interactive-login
Switches interactive login for azure.
Default is enabled.
--hostname TEXT Hostname of Insights deployment [required]
--keycloak-admin-realm TEXT KeyCloak admin realm
--keycloak-admin-username TEXT KeyCloak admin username
--keycloak-admin-password TEXT KeyCloak admin password
--keycloak-admin-clientid TEXT KeyCloak admin client
--keycloak-idp-realm TEXT Realm where the IdP operations should point
to
--keycloak-idp-alias TEXT Identity Provider's alias
--keycloak-idp-display-name TEXT
Identity Provider's display name
--help Show this message and exit.
kxi idp list
List the Azure Identity Providers of a Keycloak realm
Usage:
kxi idp list [OPTIONS]
Options:
--hostname TEXT Hostname of Insights deployment [required]
--keycloak-admin-realm TEXT KeyCloak admin realm
--keycloak-admin-username TEXT KeyCloak admin username
--keycloak-admin-password TEXT KeyCloak admin password
--keycloak-admin-clientid TEXT KeyCloak admin client
--keycloak-idp-realm TEXT Realm where the IdP operations should point
to
--help Show this message and exit.
kxi idp mapper
Identity Provider mapper commands
Usage:
kxi idp mapper [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi idp mapper add
Add a mapper to an Identity Provider
Usage:
kxi idp mapper add [OPTIONS]
Options:
--azure-tenant-id TEXT Azure Tenant ID where the operations should
point to [required]
--azure-ad-group-name TEXT Azure AD group name [required]
--azure-enable-interactive-login / --azure-disable-interactive-login
Switches interactive login for azure.
Default is enabled.
--hostname TEXT Hostname of Insights deployment [required]
--keycloak-admin-realm TEXT KeyCloak admin realm
--keycloak-admin-username TEXT KeyCloak admin username
--keycloak-admin-password TEXT KeyCloak admin password
--keycloak-admin-clientid TEXT KeyCloak admin client
--keycloak-idp-realm TEXT Realm where the IdP operations should point
to
--keycloak-idp-alias TEXT Identity Provider's alias
--keycloak-idp-mapper-name TEXT
Mapper name of the IdP [required]
--keycloak-idp-mapper-roles TEXT
Roles to add/remove to the mapper
[required]
--help Show this message and exit.
kxi idp mapper list
List the mappers of an Identity Provider
Usage:
kxi idp mapper list [OPTIONS]
Options:
--hostname TEXT Hostname of Insights deployment [required]
--keycloak-admin-realm TEXT KeyCloak admin realm
--keycloak-admin-username TEXT KeyCloak admin username
--keycloak-admin-password TEXT KeyCloak admin password
--keycloak-admin-clientid TEXT KeyCloak admin client
--keycloak-idp-realm TEXT Realm where the IdP operations should point
to
--keycloak-idp-alias TEXT Identity Provider's alias
--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 kdb Insights Enterprise
Usage:
kxi install delete [OPTIONS]
Options:
--release TEXT Release name for the install
-n, --namespace TEXT Kubernetes namespace
--force Perform action without prompting for
confirmation
--uninstall-operator Remove KXI Operator installation
--assembly-backup-filepath TEXT
Filepath to store state of running
assemblies
--help Show this message and exit.
kxi install get-values
Display the values of the currently deployed kdb Insights Enterprise
Usage:
kxi install get-values [OPTIONS]
Options:
-n, --namespace TEXT Kubernetes namespace
--release TEXT Release name for the install
--help Show this message and exit.
kxi install history
List the revision history of a kdb Insights Enterprise install
Usage:
kxi install history [OPTIONS]
Options:
--release TEXT Release name for the install
--show-operator Display the install history of the kxi-operator
--help Show this message and exit.
kxi install idp
Azure Identity Provider commands
Usage:
kxi install idp [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi install idp add
Add an Azure Identity Provider to a Keycloak realm
Usage:
kxi install idp add [OPTIONS]
Options:
--azure-tenant-id TEXT Azure Tenant ID where the operations should
point to [required]
--azure-app-registration-name TEXT
Name of the azure app registration to be
used [required]
--azure-enable-interactive-login / --azure-disable-interactive-login
Switches interactive login for azure.
Default is enabled.
--hostname TEXT Hostname of Insights deployment [required]
--keycloak-admin-realm TEXT KeyCloak admin realm
--keycloak-admin-username TEXT KeyCloak admin username
--keycloak-admin-password TEXT KeyCloak admin password
--keycloak-admin-clientid TEXT KeyCloak admin client
--keycloak-idp-realm TEXT Realm where the IdP operations should point
to
--keycloak-idp-alias TEXT Identity Provider's alias
--keycloak-idp-display-name TEXT
Identity Provider's display name
--help Show this message and exit.
kxi install idp list
List the Azure Identity Providers of a Keycloak realm
Usage:
kxi install idp list [OPTIONS]
Options:
--hostname TEXT Hostname of Insights deployment [required]
--keycloak-admin-realm TEXT KeyCloak admin realm
--keycloak-admin-username TEXT KeyCloak admin username
--keycloak-admin-password TEXT KeyCloak admin password
--keycloak-admin-clientid TEXT KeyCloak admin client
--keycloak-idp-realm TEXT Realm where the IdP operations should point
to
--help Show this message and exit.
kxi install idp mapper
Identity Provider mapper commands
Usage:
kxi install idp mapper [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi install idp mapper add
Add a mapper to an Identity Provider
Usage:
kxi install idp mapper add [OPTIONS]
Options:
--azure-tenant-id TEXT Azure Tenant ID where the operations should
point to [required]
--azure-ad-group-name TEXT Azure AD group name [required]
--azure-enable-interactive-login / --azure-disable-interactive-login
Switches interactive login for azure.
Default is enabled.
--hostname TEXT Hostname of Insights deployment [required]
--keycloak-admin-realm TEXT KeyCloak admin realm
--keycloak-admin-username TEXT KeyCloak admin username
--keycloak-admin-password TEXT KeyCloak admin password
--keycloak-admin-clientid TEXT KeyCloak admin client
--keycloak-idp-realm TEXT Realm where the IdP operations should point
to
--keycloak-idp-alias TEXT Identity Provider's alias
--keycloak-idp-mapper-name TEXT
Mapper name of the IdP [required]
--keycloak-idp-mapper-roles TEXT
Roles to add/remove to the mapper
[required]
--help Show this message and exit.
kxi install idp mapper list
List the mappers of an Identity Provider
Usage:
kxi install idp mapper list [OPTIONS]
Options:
--hostname TEXT Hostname of Insights deployment [required]
--keycloak-admin-realm TEXT KeyCloak admin realm
--keycloak-admin-username TEXT KeyCloak admin username
--keycloak-admin-password TEXT KeyCloak admin password
--keycloak-admin-clientid TEXT KeyCloak admin client
--keycloak-idp-realm TEXT Realm where the IdP operations should point
to
--keycloak-idp-alias TEXT Identity Provider's alias
--help Show this message and exit.
kxi install list-versions
List available versions of kdb Insights Enterprise
Usage:
kxi install list-versions [OPTIONS]
Options:
--chart-repo-name TEXT Name for chart repository
--help Show this message and exit.
kxi install rollback
Usage:
kxi install rollback [OPTIONS] [INSIGHTS_REVISION] [CHART]
Options:
--release TEXT Release name for the install
--operator-revision TEXT Revision of operator to rollback to
--image-pull-secret TEXT Secret containing credentials for the image
repository
-n, --namespace TEXT Kubernetes namespace
--force Perform action without prompting for
confirmation
--assembly-backup-filepath TEXT
Filepath to store state of running
assemblies
--chart-repo-name TEXT Name for chart repository
--operator-chart TEXT Filename of kxi-operator chart
--help Show this message and exit.
kxi install run
Install kdb Insights Enterprise with a values file
Usage:
kxi install run [OPTIONS] [CHART]
Options:
-n, --namespace TEXT Kubernetes namespace
--license-secret TEXT Secret containing kdb+ license
--license-as-env-var BOOLEAN Mount kdb+ license secret as an environment
variable
--license-filepath TEXT File path and file name of kdb+ license file
--client-cert-secret TEXT Secret containing TLS cert and key for
client issuer
--image-repo TEXT Repository to pull images from
--image-repo-user TEXT User name for image repository
--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
--hostname, --ingress-host TEXT
Hostname of Insights deployment
--ingress-cert-secret TEXT Secret containing self-managed TLS cert and
key for the ingress
--ingress-cert TEXT File path to TLS certificate for the ingress
--ingress-key TEXT File path to TLS private key for the ingress
--output-file TEXT Name for the generated values file
-f, --filepath PATH Values file to install with
--release TEXT Release name for the install
--version TEXT Version to install [required]
--operator-version TEXT Version of the operator to install
--force Perform action without prompting for
confirmation
--import-users BOOLEAN
--help Show this message and exit.
kxi install setup
Perform necessary setup steps to install Insights
Usage:
kxi install setup [OPTIONS]
Options:
-n, --namespace TEXT Kubernetes namespace
--license-secret TEXT Secret containing kdb+ license
--license-as-env-var BOOLEAN Mount kdb+ license secret as an environment
variable
--license-filepath TEXT File path and file name of kdb+ license file
--client-cert-secret TEXT Secret containing TLS cert and key for
client issuer
--image-repo TEXT Repository to pull images from
--image-repo-user TEXT User name for image repository
--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
--hostname, --ingress-host TEXT
Hostname of Insights deployment
--ingress-cert-secret TEXT Secret containing self-managed TLS cert and
key for the ingress
--ingress-cert TEXT File path to TLS certificate for the ingress
--ingress-key TEXT File path to TLS private key for the ingress
--ingress-certmanager-disabled Flag to disable usage of TLS certmanager
--output-file TEXT Name for the generated values file
--help Show this message and exit.
kxi install upgrade
Upgrade kdb Insights Enterprise
Usage:
kxi install upgrade [OPTIONS] [CHART]
Options:
-n, --namespace TEXT Kubernetes namespace
--release TEXT Release name for the install
--assembly-backup-filepath TEXT
Filepath to store state of running
assemblies
--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
-f, --filepath PATH Values file to install with
--force Perform action without prompting for
confirmation
--import-users BOOLEAN
--help Show this message and exit.
kxi mapper
Identity Provider mapper commands
Usage:
kxi mapper [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi mapper add
Add a mapper to an Identity Provider
Usage:
kxi mapper add [OPTIONS]
Options:
--azure-tenant-id TEXT Azure Tenant ID where the operations should
point to [required]
--azure-ad-group-name TEXT Azure AD group name [required]
--azure-enable-interactive-login / --azure-disable-interactive-login
Switches interactive login for azure.
Default is enabled.
--hostname TEXT Hostname of Insights deployment [required]
--keycloak-admin-realm TEXT KeyCloak admin realm
--keycloak-admin-username TEXT KeyCloak admin username
--keycloak-admin-password TEXT KeyCloak admin password
--keycloak-admin-clientid TEXT KeyCloak admin client
--keycloak-idp-realm TEXT Realm where the IdP operations should point
to
--keycloak-idp-alias TEXT Identity Provider's alias
--keycloak-idp-mapper-name TEXT
Mapper name of the IdP [required]
--keycloak-idp-mapper-roles TEXT
Roles to add/remove to the mapper
[required]
--help Show this message and exit.
kxi mapper list
List the mappers of an Identity Provider
Usage:
kxi mapper list [OPTIONS]
Options:
--hostname TEXT Hostname of Insights deployment [required]
--keycloak-admin-realm TEXT KeyCloak admin realm
--keycloak-admin-username TEXT KeyCloak admin username
--keycloak-admin-password TEXT KeyCloak admin password
--keycloak-admin-clientid TEXT KeyCloak admin client
--keycloak-idp-realm TEXT Realm where the IdP operations should point
to
--keycloak-idp-alias TEXT Identity Provider's alias
--help Show this message and exit.
kxi package
KX Package Import/Export CLI.
Usage:
kxi package [OPTIONS] COMMAND [ARGS]...
Options:
--artifact-store DIRECTORY Directory in which to store packed
artifacts;[default] $KX_ARTIFACT_PATH.[env
var: KX_ARTIFACT_PATH]
--pkg-lib DIRECTORY Directory in which packages will be
installed;[default] $KX_PACKAGE_PATH.[env var:
KX_PACKAGE_PATH]
--deployment-store DIRECTORY Directory in which deployment data is
stored;[default] $KX_DEPLOYMENT_PATH.[env var:
KX_DEPLOYMENT_PATH]
--version Version information.
--debug Enable stacktrace print statements for easier
debugging.
-v, --verbose Increase verbosity level
-q, --quiet Disable logs. Only print errors.
--help Show this message and exit.
kxi package add
Add an entity to the specified package.
Usage:
kxi package add [OPTIONS] COMMAND [ARGS]...
Options:
--to <Package> Package, to which, the entity will be added.
--help Show this message and exit.
kxi package add database
Add a database to the specified package.
Usage:
kxi package add database [OPTIONS]
Options:
--name TEXT Name of the database to be added to the package.
--help Show this message and exit.
kxi package add dep
Add a package dependency to the specified package.
Usage:
kxi package add dep [OPTIONS]
Options:
--name TEXT Name of the dependent package.
--version TEXT Version of the dependent package.
--repo TEXT Repository of the dependent package if it is a remote
package.
--location TEXT Location of the dependent package - "local" or "remote".
--path TEXT Path to the dependent package if it is a local package.
--help Show this message and exit.
kxi package add deployment-config
Add deployment_config to the specified package
Usage:
kxi package add deployment-config [OPTIONS]
Options:
--name TEXT Name of the deployment_config to add to the package
--help Show this message and exit.
kxi package add entitlements
Add entitlements to the specified package.
Usage:
kxi package add entitlements [OPTIONS]
Options:
--read TEXT Read entitlements to be added to the package.
--write TEXT Write entitlements to be added to the package.
--help Show this message and exit.
kxi package add patch
Add patch to the specified package
Usage:
kxi package add patch [OPTIONS]
Options:
--dep TEXT Name of the dependency where the patch is located
--name TEXT Name of the patch to add to the package
--help Show this message and exit.
kxi package add pipeline
Add a pipeline to the specified package.
Usage:
kxi package add pipeline [OPTIONS]
Options:
--name TEXT Name of the pipeline to be added to the package.
--replicas INTEGER Number of replica pipelines to create.
--help Show this message and exit.
kxi package add router
Add a router to the specified package.
Usage:
kxi package add router [OPTIONS]
Options:
--name TEXT Name of the router to add from the package.
--help Show this message and exit.
kxi package convert
Depending on what object the filepath points to:
If file contains assembly: Convert an asm -> package
If dir contains Package : Convert package to -> yaml/json ( e.g. --fmt json)
Usage:
kxi package convert [OPTIONS] FILEPATH
Options:
--fmt [yaml|json] json or yaml format if converting a package to new fmt
--help Show this message and exit.
kxi package copy
Copy an entity from the specified package.
Usage:
kxi package copy [OPTIONS] COMMAND [ARGS]...
Options:
-f, --from <Src-Package> Package from which the entity will be copied.
-t, --to <Target-Package> Package to which the entity will be
copied;[default] `from`.
--help Show this message and exit.
kxi package copy pipeline
Copy a pipeline from the specified package.
Note: This operation will clobber existing pipelines.
Usage:
kxi package copy pipeline [OPTIONS]
Options:
--src-name TEXT Name of the pipeline to copy.
--dest-name TEXT Name of the newly copied pipeline.
--replicas INTEGER Number of replica pipelines to create.
--help Show this message and exit.
kxi package deploy
Deploy a package to an insights instance
Usage:
kxi package deploy [OPTIONS] SOURCE
Options:
--with-version / --without-version
Include the package's version in the
deployment name. If --with-version is set
the deployment will have a name like
pkgname-100. If --without-version is set the
deployment will have a name like pkgname.
Note this is enabled by default to avoid
ambiguity [default: without-version]
--remote / --local Deploy a package from a remote kdb Insights
Enterprise package repo (--remote)[default]
or using a local package (--local) [WARN:
'local' may be deprecated in future
releases]
--via [operator|controller] Specify the deployment method. Available
options: operator, controller
--force Teardown running deployments if they share
any properties with the package
--url TEXT Insights URL[env var: INSIGHTS_URL; default:
https://replace.me]
--realm TEXT Realm[env var: INSIGHTS_REALM; default:
insights]
--client-id TEXT Client id[env var: INSIGHTS_CLIENT_ID;
default: test-publisher]
--client-secret TEXT Client secret[env var:
INSIGHTS_CLIENT_SECRET; default: special-
secret]
--auth-enabled / --auth-disabled
Will attempt to retrieve bearer token for
request [env var: KXI_AUTH_ENABLED]
--help Show this message and exit.
kxi package info
show some info about the package
Usage:
kxi package info [OPTIONS] [REQUIREMENT_SPECIFIER]
Options:
--help Show this message and exit.
kxi package init
Creates a bare package at the specified target path.
Note: this will not be saved to your KX_PACKAGE_PATH unless install is explicitly run.
Usage:
kxi package init [OPTIONS] [PATH_TO_PACKAGE]
Options:
--force Force initialisation: overwrite existing directory if one
already exists.
--version TEXT Version of the package to initialise.
--help Show this message and exit.
kxi package install
Install a package given a requirement or path.
Usage:
kxi package install [OPTIONS] [REQUIREMENT_SPECIFIER]
Options:
--override-deps TEXT Specify which deps to override during install. format
'name/ver:path/to/new/package'
--simple Simplify the output to name/version format.
--add-symlink-to PATH Create a symlink of package_name/version at the
specified directory.
--force Force install: overwrite existing packages and
dependencies.
--help Show this message and exit.
kxi package list
List all installed packages or artifacts.
Usage:
kxi package list [OPTIONS]
Options:
--simple Simplify the output to 'name/version' format.
-f, --filter TEXT Key-value pair to filter the returned packages on.
--fields TEXT Specify the root level attrs as a comma seperated list,
e.g. `name,version` or specify `all` for all fields
--package-json List the full manifests for each package.
--artifacts List available artifacts on the system.
--deployments List deployments tracked from this client
--help Show this message and exit.
kxi package lock
Lock the q files within a source directory.
Usage:
kxi package lock [OPTIONS] SOURCE
Options:
--keep-unlocked Keep the original unlocked q files once the locked versions
are created.
--help Show this message and exit.
kxi package overlay
Overlay a package using a spec file containing a subset of fields.
Usage:
kxi package overlay [OPTIONS] <Package> [OVERLAY_SPEC]...
Options:
--help Show this message and exit.
kxi package packit
Create a package artifact given a source code directory.
Usage:
kxi package packit [OPTIONS] SOURCE
Options:
--override-deps TEXT Specify which deps to override during packit. format
'name/ver:path/to/new/package'
--keep-unlocked Keep the original unlocked q files once the locked
versions are created.
--lock-q-files Lock the contents of the q files in the package not.
--all-deps Package all dependencies together.
--tag Tag for release, omit the random dev hash suffix.
--version TEXT Override the version of the package.
--package-name TEXT Override the auto-generated package name.
--help Show this message and exit.
kxi package pull
Download an artifact from the running insights package manager service to your local directory. Where NAMEVER is the 'name/version' of the artifact we want to pull from the service.
Usage:
kxi package pull [OPTIONS] NAMEVER
Options:
--url TEXT Insights URL[env var: INSIGHTS_URL; default:
https://replace.me]
--realm TEXT Realm[env var: INSIGHTS_REALM; default:
insights]
--client-id TEXT Client id[env var: INSIGHTS_CLIENT_ID;
default: test-publisher]
--client-secret TEXT Client secret[env var:
INSIGHTS_CLIENT_SECRET; default: special-
secret]
--auth-enabled / --auth-disabled
Will attempt to retrieve bearer token for
request [env var: KXI_AUTH_ENABLED]
--help Show this message and exit.
kxi package push
Publish an artifact to the running insights package manager service. Where NAMEVER is the 'name/version' of the artifact we want to push from the service.
Usage:
kxi package push [OPTIONS] NAMEVER
Options:
--force Force push: overwrite existing packages and
their dependencies.
--url TEXT Insights URL[env var: INSIGHTS_URL; default:
https://replace.me]
--realm TEXT Realm[env var: INSIGHTS_REALM; default:
insights]
--client-id TEXT Client id[env var: INSIGHTS_CLIENT_ID;
default: test-publisher]
--client-secret TEXT Client secret[env var:
INSIGHTS_CLIENT_SECRET; default: special-
secret]
--auth-enabled / --auth-disabled
Will attempt to retrieve bearer token for
request [env var: KXI_AUTH_ENABLED]
--help Show this message and exit.
kxi package refresh
Refresh a package, picking up any available changes from disk
Usage:
kxi package refresh [OPTIONS] <Package>
Options:
--help Show this message and exit.
kxi package remote-list
List all installed packages or artifacts on the running insights package manager service.
Usage:
kxi package remote-list [OPTIONS]
Options:
--fields TEXT List only the specified fields.
-f, --filter TEXT Key value pair to filter on. In particular
name and version.
--deployments If passed, list available deployments on the
system.
--artifacts If passed, list available artifacts on the
system.
--simple Simplify the output to 'name/version'
format.
--url TEXT Insights URL[env var: INSIGHTS_URL; default:
https://replace.me]
--realm TEXT Realm[env var: INSIGHTS_REALM; default:
insights]
--client-id TEXT Client id[env var: INSIGHTS_CLIENT_ID;
default: test-publisher]
--client-secret TEXT Client secret[env var:
INSIGHTS_CLIENT_SECRET; default: special-
secret]
--auth-enabled / --auth-disabled
Will attempt to retrieve bearer token for
request [env var: KXI_AUTH_ENABLED]
--help Show this message and exit.
kxi package remote-remove
Remove packages or artifacts from the running insights package manager service.
Usage:
kxi package remote-remove [OPTIONS] [OBJECTS]...
Options:
--artifacts Remove available artifacts rather than
installed packages.
--obj-type [Package|Artifact|Deployment]
Remove available object from system
--force Force remove: suppress the user confirmation
message during removal.
--url TEXT Insights URL[env var: INSIGHTS_URL; default:
https://replace.me]
--realm TEXT Realm[env var: INSIGHTS_REALM; default:
insights]
--client-id TEXT Client id[env var: INSIGHTS_CLIENT_ID;
default: test-publisher]
--client-secret TEXT Client secret[env var:
INSIGHTS_CLIENT_SECRET; default: special-
secret]
--auth-enabled / --auth-disabled
Will attempt to retrieve bearer token for
request [env var: KXI_AUTH_ENABLED]
--help Show this message and exit.
kxi package rm
Remove an entity from the specified package.
Usage:
kxi package rm [OPTIONS] COMMAND [ARGS]...
Options:
-f, --from <Package> Package from which the entity will be removed.
--help Show this message and exit.
kxi package rm database
Remove a database from the specified package
Usage:
kxi package rm database [OPTIONS]
Options:
--name TEXT Name of the component to remove from the package.
--help Show this message and exit.
kxi package rm dep
Remove a pipeline from the specified package.
Usage:
kxi package rm dep [OPTIONS]
Options:
--name TEXT Name of the dependency to remove from the package.
--version TEXT version of the dependency to remove from the package.
--help Show this message and exit.
kxi package rm deployment-config
Remove deployment_config form the specified package
Usage:
kxi package rm deployment-config [OPTIONS]
Options:
--help Show this message and exit.
kxi package rm entitlements
Remove entitlements from the specified package.
Usage:
kxi package rm entitlements [OPTIONS]
Options:
--read TEXT Read entitlements to remove from the package.
--write TEXT Write entitlements to remove from the package.
--help Show this message and exit.
kxi package rm patch
Remove deployment_config form the specified package
Usage:
kxi package rm patch [OPTIONS]
Options:
--name TEXT Name of the patch to remove from the package.
--help Show this message and exit.
kxi package rm pipeline
Remove a pipeline from the specified package.
Usage:
kxi package rm pipeline [OPTIONS]
Options:
--name TEXT Name of the pipeline to remove from the package.
--help Show this message and exit.
kxi package rm router
Remove a router from the specified package.
Usage:
kxi package rm router [OPTIONS]
Options:
--help Show this message and exit.
kxi package teardown
Teardown a deployed packaged running on an insights instance
Usage:
kxi package teardown [OPTIONS] DEPLOYMENT_REF
Options:
--remote / --local Teardown a deployment running on a kdb
Insights Enterprise instance. This can be
done by referencing a deployment by name and
using the '--remote' [default]. Or by
referencing a package in the local
filesystem (--local) by name/ver [WARN:
'local' may be deprecated in future
releases]
--via [operator|controller] Specify the deployment method. Available
options: operator, controller
--force Teardown running deployments if they share
any properties with the package
--url TEXT Insights URL[env var: INSIGHTS_URL; default:
https://replace.me]
--realm TEXT Realm[env var: INSIGHTS_REALM; default:
insights]
--client-id TEXT Client id[env var: INSIGHTS_CLIENT_ID;
default: test-publisher]
--client-secret TEXT Client secret[env var:
INSIGHTS_CLIENT_SECRET; default: special-
secret]
--auth-enabled / --auth-disabled
Will attempt to retrieve bearer token for
request [env var: KXI_AUTH_ENABLED]
--help Show this message and exit.
kxi package uninstall
Uninstall specified locally installed packages and artifacts.
Usage:
kxi package uninstall [OPTIONS] [OBJECTS]...
Options:
--artifacts Remove available artifacts rather than
installed packages.
--obj-type [Package|Artifact|Deployment]
Remove available object from system
--force Force uninstall: suppress user confirmation
during removal.
--help Show this message and exit.
kxi package unpack
Unpack an artifact to a specified location.
Usage:
kxi package unpack [OPTIONS] ARTIFACT_PATH
Options:
--unpack-dir PATH Path to the directory where the artifact will be unpacked
to;[default] `.`.
--help Show this message and exit.
kxi package validate
Validate the contents of a source directory to ensure it is a valid package.
Usage:
kxi package validate [OPTIONS] <Package>
Options:
--help Show this message and exit.
kxi user
Insights user commands
Usage:
kxi user [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi user assign-roles
Assign roles to a user
Usage:
kxi user assign-roles [OPTIONS] USERNAME
Options:
--roles TEXT Comma separated list of roles [required]
--hostname, --ingress-host TEXT
Hostname of Insights deployment
--realm TEXT Name of Keycloak realm
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request
--help Show this message and exit.
kxi user create
Create a user
Usage:
kxi user create [OPTIONS] USERNAME
Options:
--password TEXT Password for user [required]
--email TEXT Email address for user
--temporary / --not-temporary Controls whether user must reset password on
first login
--hostname, --ingress-host TEXT
Hostname of Insights deployment
--realm TEXT Name of Keycloak realm
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request
--help Show this message and exit.
kxi user delete
Delete a user
Usage:
kxi user delete [OPTIONS] USERNAME
Options:
--hostname, --ingress-host TEXT
Hostname of Insights deployment
--realm TEXT Name of Keycloak realm
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request
--force Perform action without prompting for
confirmation
--help Show this message and exit.
kxi user get-assigned-roles
View the assigned roles for a user
Usage:
kxi user get-assigned-roles [OPTIONS] USERNAME
Options:
--hostname, --ingress-host TEXT
Hostname of Insights deployment
--realm TEXT Name of Keycloak realm
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request
--help Show this message and exit.
kxi user get-available-roles
View the available roles
Usage:
kxi user get-available-roles [OPTIONS]
Options:
--hostname, --ingress-host TEXT
Hostname of Insights deployment
--realm TEXT Name of Keycloak realm
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request
--help Show this message and exit.
kxi user list
List users
Usage:
kxi user list [OPTIONS]
Options:
--hostname, --ingress-host TEXT
Hostname of Insights deployment
--realm TEXT Name of Keycloak realm
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request
--help Show this message and exit.
kxi user remove-roles
Remove roles from a user
Usage:
kxi user remove-roles [OPTIONS] USERNAME
Options:
--roles TEXT Comma separated list of roles [required]
--hostname, --ingress-host TEXT
Hostname of Insights deployment
--realm TEXT Name of Keycloak realm
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request
--help Show this message and exit.
kxi user reset-password
Reset a user's password
Usage:
kxi user reset-password [OPTIONS] USERNAME
Options:
--password TEXT New password for the user
--temporary / --not-temporary Controls whether user must reset password on
first login
--hostname, --ingress-host TEXT
Hostname of Insights deployment
--realm TEXT Name of Keycloak realm
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request
--help Show this message and exit.