kdb Insights CLI Reference¶
This page provides documentation for our command line tools.
kxi¶
Kdb Insights CLI.
Usage:
kxi [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
-v, --verbose Increase verbosity level
--serviceaccount-id TEXT Service account ID to request an access
token with
--serviceaccount-secret TEXT Service account secret to request an access
token with
--realm TEXT Name of Keycloak realm
--hostname, --ingress-host TEXT
Hostname of kdb Insights deployment
--usage [microservices|enterprise]
kdb Insights deployment type:
enterprise/microservices
--debug Enable debug logging.
-p, --profile TEXT Name of configuration profile to use.
--help Show this message and exit.
kxi assembly¶
Assembly interaction commands. These commands have been deprecated and may be removed from future releases. Use 'kxi pm' instead.
Usage:
kxi assembly [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi assembly backup¶
Back up running assemblies to a file. Deprecated. Use 'kxi pm pull' instead.
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. Deprecated. Use 'kxi pm deploy' instead.
Usage:
kxi assembly deploy [OPTIONS]
Options:
-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. Deprecated. Use 'kxi pm list' instead.
Usage:
kxi assembly list [OPTIONS]
Options:
-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. Deprecated. Use 'kxi pm list' instead.
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
--use-kubeconfig Communicate directly with kubernetes plane
--help Show this message and exit.
kxi assembly teardown¶
Tears down an assembly given its name. Deprecated. Use 'kxi pm teardown' instead.
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
--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-admin-token¶
Get an admin access token for the Keycloak Admin API.
Usage:
kxi auth get-admin-token [OPTIONS]
Options:
--username TEXT Keycloak admin username [required]
--password TEXT Keycloak admin password [required]
--help Show this message and exit.
kxi auth login¶
Authenticate as a user or service account.
Usage:
kxi auth login [OPTIONS]
Options:
--redirect-host TEXT Web host to serve token request after login
--redirect-port INTEGER Port to serve token request after login
--serviceaccount Use service account login flow
--force-code Force manual verification code flow (non-local
browser)
--help Show this message and exit.
kxi auth logout¶
Logout a user or service account.
Usage:
kxi auth logout [OPTIONS]
Options:
--redirect-host TEXT Web host to serve token request after login
--redirect-port INTEGER Port to serve token request after login
--serviceaccount Use service account login flow
--force-code Force manual verification code flow (non-local
browser)
--help Show this message and exit.
kxi auth print-token¶
Get an access token for a serviceaccount id and secret.
Usage:
kxi auth print-token [OPTIONS]
Options:
--help Show this message and exit.
kxi auth roles¶
Get roles from an access token.
Usage:
kxi auth roles [OPTIONS]
Options:
--force Perform action without prompting for confirmation
--help Show this message and exit.
kxi auth status¶
Get the status of the current user logged in.
Usage:
kxi auth status [OPTIONS]
Options:
--redirect-host TEXT Web host to serve token request after login
--redirect-port INTEGER Port to serve token request after login
--force-code Force manual verification code flow (non-local
browser)
--help Show this message and exit.
kxi backup¶
Insights data backup and restore related commands.
Usage:
kxi backup [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi backup create-backup¶
Usage:
kxi backup create-backup [OPTIONS]
Options:
-n, --namespace TEXT Namespace where PVC's should be backed up. [required]
--bucket-name TEXT Override stored object store bucket name
--backup-name TEXT Custom name of the backup [required]
--secret-name TEXT Override K8s secret name read config from (defaults to
backup-credentials)
--backup-postgres Flag to enable Postgres backup
--help Show this message and exit.
kxi backup init-backup¶
Usage:
kxi backup init-backup [OPTIONS]
Options:
-n, --namespace TEXT Namespace where PVC's should be backed up.
[required]
--provider [s3|azure|gs] Object storage provider [required]
--bucket-name TEXT Object storage bucket name [required]
--restic-pw TEXT Custom Restic repo password (data encryption
key) [required]
--secret-name TEXT K8s secret name to save backup configuration
to (defaults to backup-credentials)
--credentials CREDENTIALSFACTORY
access credentials in a JSON format matching
to provider. [required]
--help Show this message and exit.
kxi backup populate-snapshots¶
Usage:
kxi backup populate-snapshots [OPTIONS]
Options:
-n, --namespace TEXT Namespace where PVC's should be backed up. [required]
--bucket-name TEXT Override stored object store bucket name
--secret-name TEXT Override K8s secret name read config from (defaults to
backup-credentials)
--help Show this message and exit.
kxi backup restore-postgres¶
Usage:
kxi backup restore-postgres [OPTIONS]
Options:
-n, --namespace TEXT Namespace where PVC's should be backed up. [required]
--bucket-name TEXT Override stored object store bucket name
--snapshot-id TEXT Snapshot ID of a backup to restore [required]
--secret-name TEXT Override K8s secret name read config from (defaults to
backup-credentials)
--help Show this message and exit.
kxi backup restore-pvc¶
Usage:
kxi backup restore-pvc [OPTIONS]
Options:
-n, --namespace TEXT Namespace where PVC's should be backed up. [required]
--bucket-name TEXT Override stored object store bucket name
--restore-name TEXT Restore job name [required]
--snapshot-id TEXT Snapshot ID of a backup to restore [required]
--secret-name TEXT Override K8s secret name read config from (defaults to
backup-credentials)
--target-pvc TEXT PVC name to restore snapshot to [required]
--reset-rt During package migration, reset the rt stream position
of the restored snapshot to ensure proper IDB
restoration.
--help Show this message and exit.
kxi backup watch¶
Usage:
kxi backup watch [OPTIONS]
Options:
-n, --namespace TEXT Namespace where PVC's should be backed up.
[required]
--task-type [Backup|Restore] Task type to watch [required]
--task-name TEXT User defined Backup or Restore name to watch
[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¶
Usage:
kxi client enrol [OPTIONS]
Options:
--name TEXT Name of client to enrol [required] [required]
--insert-topic TEXT Stream to insert data on [optional]
--subscribe TEXT Stream to subscribe to insert data from [optional]
--help Show this message and exit.
kxi client info¶
Get certs and endpoints for a client.
Usage:
kxi client info [OPTIONS]
Options:
--uid TEXT Client UID to request info for [required]
--help Show this message and exit.
kxi client remove¶
Remove a client from the system.
Usage:
kxi client remove [OPTIONS]
Options:
--name TEXT Name of the client to remove [required]
--help Show this message and exit.
kxi configure¶
Configure the CLI.
Usage:
kxi configure [OPTIONS]
Options:
-p, --profile TEXT Name of profile to configure.
--help Show this message and exit.
kxi entitlement¶
Insights entitlements commands.
Usage:
kxi entitlement [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi entitlement actors¶
List actors.
Actors are the list of groups that can be assigned to an entity.
Usage:
kxi entitlement actors [OPTIONS]
Options:
-o, --output [json|table] Output format. One of: (json, table)
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement add-groups¶
Add groups to an entitlement.
ID is the id of the entitlement to add the groups to.
GROUPS is a comma-separated list of group IDs or group names and access level
Usage:
kxi entitlement add-groups [OPTIONS] ID {assembly|database|package|view|query}
GROUPS
Options:
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement create¶
Create an entitlement.
ID is the ID of the entity being entitled. NAME is the name of the entity being entitled. ENTITYTYPE is the type of the entity being entitled
Supported entity types are 'assembly' and 'package'
--owner and --groups are optional, if not provided, these will be defaulted to 00000000-0000-0000-0000-000000000000 and [] respectively.
Usage:
kxi entitlement create [OPTIONS] ID NAME
{assembly|database|package|view|query}
Options:
--owner UUID User ID of the owner
--groups TEXT Comma separated list of group IDs or group names and
access level <id|name>:<access>
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement delete¶
Delete an entitlement.
This deletes an entitlement pending user confirmation. Use --force to skip user confirmation.
Usage:
kxi entitlement delete [OPTIONS] ID {assembly|database|package|view|query}
Options:
--timeout INTEGER Timeout in seconds for request [default: 2]
--force Perform action without prompting for confirmation
--help Show this message and exit.
kxi entitlement filter¶
Filter list entitlements by id, type and access.
Usage:
kxi entitlement filter [OPTIONS]
Options:
--id TEXT Entitlement id
--entity-type [assembly|database|package|view|query]
Type of entity
--access TEXT Level of access <R|W|X>
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement get¶
Get an entitlement.
Usage:
kxi entitlement get [OPTIONS] ID {assembly|database|package|view|query}
Options:
--timeout INTEGER Timeout in seconds for request [default: 2]
-o, --output [json|table] Output format. One of: (json, table)
--show-columns TEXT List of columns to show if output format is
'table'. Any list of "owner,groups,users,policies
enabled,policy types"
--hide-columns TEXT List of columns to hide if output format is
'table'. Any list of "owner,groups,users,policies
enabled,policy types"
--help Show this message and exit.
kxi entitlement list¶
List entitlements.
Usage:
kxi entitlement list [OPTIONS]
Options:
--timeout INTEGER Timeout in seconds for request [default: 2]
-o, --output [json|table] Output format. One of: (json, table)
--show-columns TEXT List of columns to show if output format is
'table'. Any list of "owner,groups,users,policies
enabled,policy types"
--hide-columns TEXT List of columns to hide if output format is
'table'. Any list of "owner,groups,users,policies
enabled,policy types"
--own Return entitlements owned by the current user.
--help Show this message and exit.
kxi entitlement manage¶
Manage Entitlements in an Interactive Session.Display a list of entitlements and prompt user to select one.
Keybindings:
Enter to view and edit groups
Ctrl+e to create a new entitlement
Ctrl+d to delete the selected entitlement
Ctrl+b to go back to previous screen
Ctrl+t toggle policy view & management
V to view
Q to quit (when at top level).
Usage:
kxi entitlement manage [OPTIONS]
Options:
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement policies-disable¶
Disable policies for an entitlement.
Usage:
kxi entitlement policies-disable [OPTIONS] ID
{assembly|database|package|view|query}
Options:
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement policies-enable¶
Enable policies for an entitlement.
Usage:
kxi entitlement policies-enable [OPTIONS] ID
{assembly|database|package|view|query}
Options:
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement policy-mapping¶
Insights policy commands.
Usage:
kxi entitlement policy-mapping [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi entitlement policy-mapping add¶
Add a new asset to policyMapping. Or append policies to an existing asset.
Usage:
kxi entitlement policy-mapping add [OPTIONS] ID
{assembly|database|package|view|query}
Options:
--group TEXT ID or name of the group to modify
--asset TEXT Asset mapping key [required]
--policy-type TEXT Type of policy [required]
--policies TEXT Comma separated list of policies [required]
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement policy-mapping delete¶
Remove an asset from policyMapping.
Usage:
kxi entitlement policy-mapping delete [OPTIONS] ID
{assembly|database|package|view|query}
Options:
--group TEXT ID or name of the group to modify
--asset TEXT Asset from the policy mapping key
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement policy-mapping disable¶
Disable one or more policy types for an entitlement.
Usage:
kxi entitlement policy-mapping disable [OPTIONS] ID
{assembly|database|package|view|query}
Options:
--policy-types TEXT Comma separated list of policy types to disable
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement policy-mapping enable¶
Enable one or more policy types for an entitlement.
Usage:
kxi entitlement policy-mapping enable [OPTIONS] ID
{assembly|database|package|view|query}
Options:
--policy-types TEXT Comma separated list of policy types to enable
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement policy-mapping get¶
Get policies for an entitlement.
Usage:
kxi entitlement policy-mapping get [OPTIONS] ID
{assembly|database|package|view|query}
Options:
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement policy-mapping remove¶
Remove policies from an asset inside a policyMapping.
Usage:
kxi entitlement policy-mapping remove [OPTIONS] ID
{assembly|database|package|view|query}
Options:
--group TEXT ID or name of the group to modify
--asset TEXT Asset mapping key [required]
--policy-type TEXT Type of policy [required]
--policies TEXT Comma separated list of policies [required]
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement policy-mapping set¶
Update the enabled status for one or more policy types for a specified entitlement.
Usage:
kxi entitlement policy-mapping set [OPTIONS] ID
{assembly|database|package|view|query}
Options:
--policy-types TEXT Comma separated list of policy types and enabled flag
<assetType>:<enabled>
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement policy-mapping update¶
Overwrite policies inside of an asset.
Usage:
kxi entitlement policy-mapping update [OPTIONS] ID
{assembly|database|package|view|query}
Options:
--group TEXT ID or name of the group to modify
--asset TEXT Asset mapping key [required]
--policy-type TEXT Type of policy [required]
--policies TEXT Comma separated list of policies [required]
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement rm-groups¶
Remove groups from an entitlement.
ID is the id of the entitlement to remove the groups from.
GROUPS is a comma-separated list of group IDs or group names and access level
Usage:
kxi entitlement rm-groups [OPTIONS] ID {assembly|database|package|view|query}
GROUPS
Options:
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi entitlement update¶
Update an entitlement.
This updates the name, owner and groups of an entitlement based on the options passed.
Usage:
kxi entitlement update [OPTIONS] ID {assembly|database|package|view|query}
Options:
--name TEXT Name of the entity
--owner UUID User ID of the owner
--groups TEXT Comma separated list of group IDs or group names and
access level <id|name>:<access>
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi group¶
Insights group commands.
Usage:
kxi group [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi group create¶
Create a group.
Usage:
kxi group create [OPTIONS] NAME
Options:
--temporary / --not-temporary Controls whether user must reset password on
first login
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi group delete¶
Delete a group.
Usage:
kxi group delete [OPTIONS] NAME
Options:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request [default: 2]
--force Perform action without prompting for confirmation
--help Show this message and exit.
kxi group list¶
List groups.
Usage:
kxi group list [OPTIONS]
Options:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request [default: 2]
--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 create-encryption-key¶
Generate an encryption key and a k8s secret that uses the generated key.
Usage:
kxi install create-encryption-key [OPTIONS]
Options:
-n, --namespace TEXT Kubernetes namespace
--database-encryption-password TEXT
Password for deriving the database
encryption key
--database-encryption-secret TEXT
Secret containing the database encryption
key (creates if it does not exist)
--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
--skip-operator Running install, upgrade or delete with this flag will
prevent installing, upgrading, or uninstalling
the operator.
--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
-n, --namespace TEXT Kubernetes namespace
--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
--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 kdb 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 kdb 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
--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 kdb 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 kdb 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¶
Revert to a previous installation of kdb Insights Enterprise.
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
--timeout TEXT Helm argument. Time to wait for any
individual Kubernetes operation
(like Jobs for hooks) (default 10m0s)
--wait / --no-wait Helm argument. If set, will wait until all
Pods, PVCs, Services, and minimum
number of Pods of a Deployment, StatefulSet,
or ReplicaSet are in a ready state
before marking the release as
successful. It will wait for as long as
--timeout
--wait-for-jobs / --no-wait-for-jobs
Helm argument. If set and --helm-wait
enabled, will wait until all Jobs
have been completed before marking the
release as successful. It will wait
for as long as --timeout
--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 kdb 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
--database-encryption-password TEXT
Password for deriving the database
encryption key
--database-encryption-secret TEXT
Secret containing the database encryption
key (creates if it does not exist)
--encryption-scope-enforced TEXT
Comma-separated list of scopes on which
encryption is enforced e.g. database
--keycloak-cnpg-secret TEXT
--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 Enables/disables the import of users at
deployment time
--encryption BOOLEAN Enables/disables encryption
--management-version TEXT Version of the management service to install
--insights-on-k8s-version TEXT Version of the insights-on-k8s chart to
install
--skip-operator Running install, upgrade or delete with this
flag will prevent installing,
upgrading, or uninstalling the operator.
--skip-management Running install or upgrade with this flag
will prevent installing or upgrading
the management service.
--timeout TEXT Helm argument. Time to wait for any
individual Kubernetes operation
(like Jobs for hooks) (default 10m0s)
--wait / --no-wait Helm argument. If set, will wait until all
Pods, PVCs, Services, and minimum
number of Pods of a Deployment, StatefulSet,
or ReplicaSet are in a ready state
before marking the release as
successful. It will wait for as long as
--timeout
--wait-for-jobs / --no-wait-for-jobs
Helm argument. If set and --helm-wait
enabled, will wait until all Jobs
have been completed before marking the
release as successful. It will wait
for as long as --timeout
--retry-limit INTEGER Number of times install and upgrades are
retried
--retry-wait INTEGER Initial amount of time in seconds to wait
between install and upgrade retries
--enable-entitlements / --disable-entitlements
Enable or disable entitlements
--skip-packages Running install or upgrade with this flag
will prevent packages from being re-applied
--skip-tasks Running install or upgrade with this flag
will prevent management service tasks from
being executed
--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 kdb 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
--database-encryption-password TEXT
Password for deriving the database
encryption key
--database-encryption-secret TEXT
Secret containing the database encryption
key (creates if it does not exist)
--encryption-scope-enforced TEXT
Comma-separated list of scopes on which
encryption is enforced e.g. database
--keycloak-cnpg-secret TEXT
--ingress-certmanager-disabled Flag to disable usage of TLS certmanager
--output-file TEXT Name for the generated values file
--enable-query-environment / --disable-query-environment
Enable or disable query environment
--enable-entitlements / --disable-entitlements
Enable or disable entitlements
--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 Enables/disables the import of users at
deployment time
--encryption BOOLEAN Enables/disables encryption
--management-version TEXT Version of the management service to install
--insights-on-k8s-version TEXT Version of the insights-on-k8s chart to
install
--skip-operator Running install, upgrade or delete with this
flag will prevent installing,
upgrading, or uninstalling the operator.
--skip-management Running install or upgrade with this flag
will prevent installing or upgrading
the management service.
--timeout TEXT Helm argument. Time to wait for any
individual Kubernetes operation
(like Jobs for hooks) (default 10m0s)
--wait / --no-wait Helm argument. If set, will wait until all
Pods, PVCs, Services, and minimum
number of Pods of a Deployment, StatefulSet,
or ReplicaSet are in a ready state
before marking the release as
successful. It will wait for as long as
--timeout
--wait-for-jobs / --no-wait-for-jobs
Helm argument. If set and --helm-wait
enabled, will wait until all Jobs
have been completed before marking the
release as successful. It will wait
for as long as --timeout
--retry-limit INTEGER Number of times install and upgrades are
retried
--retry-wait INTEGER Initial amount of time in seconds to wait
between install and upgrade retries
--enable-entitlements / --disable-entitlements
Enable or disable entitlements
--skip-packages Running install or upgrade with this flag
will prevent packages from being re-applied
--skip-tasks Running install or upgrade with this flag
will prevent management service tasks from
being executed
--help Show this message and exit.
kxi monitoring¶
Insights monitoring install / uninstall commands.
Usage:
kxi monitoring [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi monitoring install¶
Usage:
kxi monitoring install [OPTIONS] INSIGHTS_CLUSTER_NAME {s3|azure|gcs}
CREDENTIALS_PATH
Options:
-n, --namespace TEXT Kubernetes namespace
--grafana-admin-user TEXT User name of Grafana admin, required if
--install-grafana is set
--grafana-admin-password TEXT Password of Grafana admin, required if
--install-grafana is set
--install-grafana Install Grafana with Prometheus
--monitoring-namespace TEXT Namespace to install monitoring stack
[default: monitoring]
--log-retention-period TEXT Loki retention period for logs in days
[default: 15]
--metrics-retention-period TEXT
Prometheus retention period for metrics in
days [default: 15]
--metrics-retention-size TEXT Prometheus retention for metrics in GB
[default: 45]
--ingress-type [nginx|nginx-community]
Ingress controller type to use for
monitoring stack [default: nginx-community]
--help Show this message and exit.
kxi monitoring uninstall¶
Usage:
kxi monitoring uninstall [OPTIONS]
Options:
-n, --namespace TEXT Kubernetes namespace
--monitoring-namespace TEXT Namespace to install monitoring stack
[required]
--help Show this message and exit.
kxi obs¶
Insights Observability Service commands.
Usage:
kxi obs [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi obs events¶
Get Kubernetes events for insights.
Usage:
kxi obs events [OPTIONS]
Options:
-n, --namespace TEXT Kubernetes namespace
--timeout INTEGER Timeout in seconds for request [default: 2]
--pod TEXT Exact pod name to retrieve events for.
--package TEXT Filter pods associated with a specific package.
--workload TEXT Limit results to components related to this workload.
--label TEXT Comma-separated key-value label selectors.
--help Show this message and exit.
kxi obs logs¶
Get logs for a process running on insights.
Usage:
kxi obs logs [OPTIONS]
Options:
-n, --namespace TEXT Kubernetes namespace
--timeout INTEGER Timeout in seconds for request [default: 2]
-f, -w, --follow, --watch Stream logs continuously using server-side
following.
--pod TEXT Filter by pod name.
--container TEXT Filter by container name.
--workload TEXT Limit results to components related to this
workload.
--label TEXT Comma-separated key-value label selectors.
--component TEXT Regex applied to the workload name.
--level [TRACE|DEBUG|INFO|WARN|WARNING|ERROR|FATAL]
Minimum log level to return [default: INFO]
--log-component TEXT Filter by the log message ``component``
field.
--search TEXT Case-insensitive substring search on the
message field.
--corr TEXT Filter by correlation ID.
--since-seconds INTEGER Return logs from this many seconds ago.
--since-time TEXT RFC 3339 timestamp from which to return
logs.
--tail-lines INTEGER Number of lines from the end of the log to
return per container.
--aggregate Aggregate all log messages by log level.
--by-pod Group results by pod name and log level
(requires ``aggregate``).
--pretty / --json Pretty-print the response JSON.
--help Show this message and exit.
kxi obs pods¶
List pods for insights observability.
Usage:
kxi obs pods [OPTIONS]
Options:
-n, --namespace TEXT Kubernetes namespace
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi package¶
Insights Package Building CLI.
Usage:
kxi package [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
--artifact-store DIRECTORY
--pkg-lib DIRECTORY
--debug Enable stacktrace print statements and increase
verbosity for easier debugging.
-v, --verbose Increase verbosity level
-q, --quiet Disable logs. Only print errors.
--stacktrace Enable stacktrace print statements.
--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 agg¶
Add aggregator to the specified package
Usage:
kxi package add agg [OPTIONS]
Options:
--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.
--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 entrypoint¶
Add an entrypoint to the specified package.
Usage:
kxi package add entrypoint [OPTIONS]
Options:
--name TEXT Name of the entrypoint to add from the package.
--path PATH Path to the entrypoint.
--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.
--spec-file TEXT Source file for pipeline to use
--base [q|py|q-ml|py-ml] Base image to deploy, one of q, py, q-ml or py-ml
--help Show this message and exit.
kxi package add rc¶
Add resource coordinator to the specified package
Usage:
kxi package add rc [OPTIONS]
Options:
--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 add shard¶
Same as add database.
Usage:
kxi package add shard [OPTIONS]
Options:
--name TEXT Name of the shard to be added to the database.
--help Show this message and exit.
kxi package add stream¶
Add a stream to the specified database.
Usage:
kxi package add stream [OPTIONS]
Options:
--name TEXT Name of the stream to be added to the database.
--database TEXT Name of the database to add the stream to.
--external BOOLEAN Flag for internally or externally facing Sequencer.
--sub-topic TEXT Name of the subtopic for the external stream.
--help Show this message and exit.
kxi package add table¶
Add a table to the specified package.
Usage:
kxi package add table [OPTIONS]
Options:
--name TEXT Name of the table to be added to the package. [default:
mytable]
--help Show this message and exit.
kxi package add view¶
Add a view to the specified package.
Usage:
kxi package add view [OPTIONS]
Options:
--name TEXT Name of the view to add to the package.
--data TEXT Add data from an existing json file to the view
--help Show this message and exit.
kxi package add workload¶
Adds a workload to the package's workload.yaml.
Creates the workload.yaml file if it doesn't exist. Entrypoint in format 'package:init_file'. If package is omitted from the entrypoint, it defaults to the current package.
To avoid mixing up arguments for the workload and the CLI command, use --
after all the options to separate them.
Example usage: kxi package add --to my-package workload --name myinstance --entrypoint mypackage:init.q -- -s 6
Usage:
kxi package add workload [OPTIONS] [WORKLOAD PROCESS ARGS...]
Options:
--name TEXT Name of the workload. [required]
-E, --entrypoint TEXT Workload entrypoint in the format of:
package:init_file.q.
If package is omitted, it defaults to the current
package. [required]
--deps TEXT Comma separated list of (package/module)
dependencies.
-p, --port INTEGER Exposed container port of q instance [default:
5000]
-e, --env TEXT Inject environment variables to the deployed
package. `--env VAR=value --env VAR2=value2`.
Multiple variables can be added by repeating the
flag.
--expose Indicate whether service should be exposed
externally via ingress.
When set, additional external-facing port is
created to allow instance to be reachable outside
of cluster.
-S, --service TEXT Kubernetes service type (ClusterIP, NodePort,
LoadBalancer). This is required if --expose is
set.
--replicas INTEGER [default: 1]
--storage TEXT Configure a Persistent Volume for each workload
instance replica. Each replica gets its own PVC,
mounted at the specified path.
This is a comma separated list of key-value pairs.
Every key is optional.
Format: type=<storageclass>,dst=<mountpath>,<a
ccess_mode>,size=<size>,persist=<true|false>
Example: --storage
type=gp3,dst=/data,rw,size=10Gi,persist=true
Supported keys:
- type - Kubernetes StorageClass name
- dst - Mount path inside the
container
- size - Volume size [default: 20Gi]
- persist - Whether to retain volume
after deletion (true/false) [default: false]
- accessModes - Access mode: ro, rw, rwo,
rwx, etc. (can omit key) [default: rwx]
-- ReadOnlyMany (ro/rox): multiple replicas
can read, no one can write
-- ReadWriteMany (rw/rwx): multiple replicas
can read and write
-- ReadWriteOnce (rwo): only one replica can
read/write, others cannot access
-- ReadWriteOncePod (rwop): only one replica
can read/write, others cannot access, and
volume is deleted when pod is deleted
Separate each key-value pair with a comma. Do not
use spaces.
--group-storage TEXT Configure a Persistent Volume shared by all
workload instances in the group. The volume is
mounted to all replicas at the specified path.
This is a comma separated list of key-value pairs.
Every key is optional.
Format: type=<storageclass>,dst=<mountpath>,<a
ccess_mode>,size=<size>,persist=<true|false>
Example: --group-storage type=sharedfiles,dst=
/shared,rw,size=20Gi,persist=false
Supported keys:
- type - Kubernetes StorageClass name
- dst - Mount path inside the
container
- size - Volume size (e.g. 20Gi)
- persist - Whether to retain volume
after deletion (true/false)
- accessModes - Access mode: ro, rw, rwo,
rwx, etc. (can omit key)
-- ReadOnlyMany (ro/rox): multiple replicas
can read, no one can write
-- ReadWriteMany (rw/rwx): multiple replicas
can read and write
-- ReadWriteOnce (rwo): only one replica can
read/write, others cannot access
-- ReadWriteOncePod (rwop): only one replica
can read/write, others cannot access, and
volume is deleted when pod is deleted
Separate each key-value pair with a comma. Do not
use spaces.
-M, --group-metrics TEXT To enable the serviceMonitor, set the interval and
polled endpoint.
Format 'PATH:INTERVAL'. eg: `/metrics:10s`.
--help Show this message and exit.
kxi package add workload-metrics¶
Add or update group-level metrics configuration in workload.yaml.
METRICS format: PATH:INTERVAL, e.g. /metrics:10s
Usage:
kxi package add workload-metrics [OPTIONS] METRICS
Options:
--help Show this message and exit.
kxi package add workload-storage¶
Add or update group-level storage configuration in workload.yaml.
Configure a Persistent Volume shared by all workload instances in the group. The volume is mounted to all replicas at the specified path.
This is a comma separated list of key-value pairs. Every key is optional.
Format:
type=<storageclass>,dst=<mountpath>,<access_mode>,size=<size>,persist=<true|false>
Example:
--group-storage type=sharedfiles,dst=/shared,rw,size=20Gi,persist=false
Supported keys:
- type - Kubernetes StorageClass name
- dst - Mount path inside the container
- size - Volume size (e.g. 20Gi)
- persist - Whether to retain volume after deletion (true/false)
- accessModes - Access mode: ro, rw, rwo, rwx, etc. (can omit key)
-- ReadOnlyMany (ro/rox): multiple replicas can read, no one can write
-- ReadWriteMany (rw/rwx): multiple replicas can read and write
-- ReadWriteOnce (rwo): only one replica can read/write, others cannot access
-- ReadWriteOncePod (rwop): only one replica can read/write, others cannot access,
and volume is deleted when pod is deleted
Separate each key-value pair with a comma. Do not use spaces.
Usage:
kxi package add workload-storage [OPTIONS] STORAGE
Options:
--help Show this message and exit.
kxi package checkpoint¶
Update the package version given a source code directory.
Usage:
kxi package checkpoint [OPTIONS] SOURCE
Options:
--version TEXT Override the version of the package.
--bump [major|minor|patch|dev] Increment the major/minor/patch/dev version.
--version-info TEXT Leave a description note for the checkpoint
version.
--package-name TEXT Override the auto-generated package name.
--kxi TEXT Create a kxi artifact after checkpointing in
a target directory.
--help Show this message and exit.
kxi package config¶
Local configuration options.
Usage:
kxi package config [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi package config get¶
Get package configuration.
Usage:
kxi package config get [OPTIONS] [OPTION]...
Options:
-p, --with-profile Include KXI Profile Info
-o, --output [table|json|yaml] Output format
--help Show this message and exit.
kxi package config set¶
Set package configuration values (envvars) only
Usage:
kxi package config set [OPTIONS] OPTION VALUE
Options:
--help Show this message and exit.
kxi package convert¶
Convert Assembly to Package and vice versa.
Depending on what object the filepath points to:
If file contains assembly: Convert an asm -> package
If dir contains Package:
If Convert package to -> assembly
Usage:
kxi package convert [OPTIONS] FILEPATH
Options:
--spec-files This flag converts embedded pipeline specs to files
--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 field¶
Find, list or mutate fields within a package.
Usage:
kxi package field [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi package field find¶
Find an object inside a package by looking up it's type (e.g Table). Case sensitive.
Usage:
kxi package field find [OPTIONS] [PACKAGE_PATH] [CLASSNAME]
Options:
-f, --filter TEXT Key-value pair to filter the returned objects on.
--help Show this message and exit.
kxi package field get¶
Get a json representation of a field at a location using dot notation e.g. ".pipelines[0].name".
Usage:
kxi package field get [OPTIONS] [REQUIREMENT_SPECIFIER] [PATH]
Options:
--help Show this message and exit.
kxi package field info¶
Print out the information about the object specified. Case sensitive.
Usage:
kxi package field info [OPTIONS] CLASSNAME
Options:
--show-defaults Show default values for fields if present.
--where Show the location of the field in the model.
--help Show this message and exit.
kxi package field set¶
Set a field using dot notation path e.g.".pipelines[0].name". Can only set strings curently
Usage:
kxi package field set [OPTIONS] [REQUIREMENT_SPECIFIER] PATH VALUE
Options:
--help Show this message and exit.
kxi package field where¶
Returns where in the package model the specified object type or name is located.
Usage:
kxi package field where [OPTIONS]
Options:
--type TEXT Find fields of a specific type (e.g. Table, Pipeline, etc.) in
the package model.
--name TEXT Find fields with a specific field name in the package model.
--help Show this message and exit.
kxi package info¶
show some info about the package
Usage:
kxi package info [OPTIONS] [REQUIREMENT_SPECIFIER]
Options:
-i, --include [udfs|policies] Include additional information in the
output.
-o, --output-format [json|table]
Output format for the list command
--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 Don't ask for overwrite confirmation.
--reset Overwrite the manifest only. (Default
behavior) (DEPRECATED)
--clean Overwrite the existing directory entirely.
--version TEXT Version of the package to initialise.
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package list¶
List all installed packages or artifacts.
Usage:
kxi package list [OPTIONS]
Options:
--obj-type TEXT List this obj type (e.g. Pipelines)
overrides artifact/deployment flag. Case
Sensitive.
--simple Simplify the output to one line format.
-f, --filter TEXT Key-value pair to filter the returned
packages on. Multiple conditions AND-ed
together.
--fields TEXT Specify the root level attrs as a comma
separated list, e.g. `name,version` or
specify `all` for all fields
--package-json List the full manifests for each package.
(Deprecated)
--artifacts List available artifacts on the system.
--deployments List deployments tracked from this client
-d, --dir PATH List objects in this directory
--in-pkg TEXT Look for the object inside a given pkg
[name/version].
-o, --output-format [json|simple|table]
Output format for the list command
--help Show this message and exit.
kxi package lock¶
Lock the q files within a source directory. Files whose first line is /dnc or //dnc will be ignored.
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. Files
whose first line is /dnc or //dnc will be ignored.
--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.
--target TEXT Target directory where the artifact will be created.
[default] `.`.
--help Show this message and exit.
kxi package pm¶
Insights Package Manager Service commands.
Usage:
kxi package pm [OPTIONS] COMMAND [ARGS]...
Options:
--version Display the version of the kdb+ Insights
Enterprise Package Manager service and
client.
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm add¶
Add a component to the kdb+ Insights Enterprise Package on the service.
Usage:
kxi package pm add [OPTIONS] PACKAGE_NAME {view|pipeline|database}
COMPONENT_NAME
Options:
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm backup¶
Download a backup of all entitled packages from kdb+ Insights Enterprise Package Manager service
Admin users can download all packages, while non-admin users can only download packages they have READ access to.
Usage:
kxi package pm backup [OPTIONS] [TARGET]
Options:
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm bounce¶
Restart a deployed package running on an insights instance.
PACKAGE: package-name
Usage:
kxi package pm bounce [OPTIONS] PACKAGE
Options:
--db NAME[:COMPONENTS] Bounce db components. Format: <db-name> or
<db-name:db-components>. E.g. '--db
mydb:dap,rc'. Accepted db components: rt,
rc, dap, agg, qe_rc, qe_dap, qe_agg, sm,
router, qe.
--pipeline NAME[:COMPONENTS] Bounce pipeline components. Format:
<pipeline-name> or <pipeline-name:pipeline-
components>. E.g. '--pipeline
mypipeline:spwork'. Accepted pipeline
components: spwork, spctl.
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm config¶
Server configuration options.
Usage:
kxi package pm config [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi package pm config get¶
Get the current configuration of the kdb+ Insights Enterprise Package Manager service.
Usage:
kxi package pm config get [OPTIONS]
Options:
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm config set¶
Set the current configuration of the kdb+ Insights Enterprise Package Manager service.
Usage:
kxi package pm config set [OPTIONS] OPTION VALUE
Options:
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm convert¶
Convert V1/V2 assemblies into Packages with the server. Optionally keep the package installed on the server.
Usage:
kxi package pm convert [OPTIONS] ASSEMBLY_FILE
Options:
--install Additionally installs the resulting package
on the server.
--spec-files This flag converts embedded pipeline specs
to files
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm deploy¶
Deploy a package to an insights instance.
PACKAGE: package-name VERSION: package-version
Usage:
kxi package pm deploy [OPTIONS] PACKAGE [VERSION]
Options:
--env TEXT Inject environment variables to the deployed
package. `[component_name:]VAR=value`
--db TEXT Deploy a database in the package
--pipeline TEXT Deploy a pipeline in the package
--fields TEXT [default: name, package, version, function,
status, data, access, owner, id, info, size,
components]
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm edit¶
Edit the runnable component of the kdb+ Insights Enterprise Package on the service.
Usage:
kxi package pm edit [OPTIONS] PACKAGE_NAME {pipeline|database} COMPONENT_NAME
Options:
--field TEXT Only edit a specific field of the entity.
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm field¶
Insights Package Manager Service Field subcommands.
Usage:
kxi package pm field [OPTIONS] COMMAND [ARGS]...
Options:
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm field info¶
Get information about a field in the package.
Usage:
kxi package pm field info [OPTIONS] FIELD_NAME
Options:
--where Show the location of the field in the model.
--help Show this message and exit.
kxi package pm info¶
Get info about a package stored on the kdb+ Insights Enterprise Package Manager service.
Usage:
kxi package pm info [OPTIONS] PACKAGE_NAME [[pipeline|table]]
Options:
-v, --version TEXT Select package version. Defaults to running
version if deployed, otherwise latest.
-i, --include [udfs|policies|files]
Include additional information in the
output. Only applies when no component type
is given.
-f, --filter TEXT Key-pattern pairs to filter the returned
components using case-sensitive wildcard
matching (e.g. name=*test). Multiple
patterns ANDed together. Only applies when
component type (e.g. table) is given.
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm journal¶
Get the current journal history of the kdb+ Insights Enterprise Package Manager service.
Usage:
kxi package pm journal [OPTIONS]
Options:
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--fields TEXT [default: timestamp, action, username,
package, component_type, component, message,
params]
-a, --action TEXT CONFIGURE,CREATE,UPDATE,PATCH,DELETE,RENAME,
DEPLOY,TEARDOWN,CLEANUP,BOUNCE,LOAD
-p, --package TEXT
-u, --username TEXT
-c, --component TEXT
-l, --limit INTEGER [default: 100]
--offset INTEGER
--from [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]
--to [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]
--sort TEXT Comma-separated list of fields to sort by.
Prefix a field with '-' for descending
order. Example: 'username,-timestamp'
[default: -timestamp]
--help Show this message and exit.
kxi package pm list¶
List objects stored on kdb+ Insights Enterprise Package Manager service. Optional arguments allow you to list by component.
Usage:
kxi package pm list [OPTIONS] [[package|deployment|pipeline|view|database|udf|
workload|sequencer]]
Options:
-f, --filter TEXT Key-pattern pair to filter the returned
packages on. Applies case-sensitive
filtering using wildcard patterns. Multiple
patterns ANDed together. Key names may
include dot notation for nested values
(e.g., owner.name=John*).
--fields TEXT [default: name, package, version, function,
status, data, access, owner, id, info, size,
components]
--sort TEXT Comma-separated list of fields to sort by.
Prefix a field with '-' for descending
order. Example: 'name,package,-version'
[default: name]
-o, --output-format [json|table|csv|simple]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm load¶
Load a package into running deployment or global processes
Usage:
kxi package pm load [OPTIONS] PACKAGE
Options:
-d, --deployment NAME_OR_UUID
-t, --targets TEXT Comma-separated targets:
daps,qe_daps,pkg_agg,pkg_qe_agg
-g, --global-processes TEXT Comma-separated global processes: agg,qe_agg
--version TEXT Version of the package to load.
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm pull¶
Download a package from kdb+ Insights Enterprise Package Manager service.
Usage:
kxi package pm pull [OPTIONS] NAME [VERSION]
Options:
-O, --output TEXT Specify the output directory/archive name
for the downloaded package. Defaults to
package-name or packagename-version.kxi
-A, --artifact Download the package into a compressed
archive.
--clean Remove local files not present in the pulled
package (respects .kxignore).
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm push¶
Publish a package to kdb+ Insights Enterprise Package Manager service.
Usage:
kxi package pm push [OPTIONS] [PATH]
Options:
--deploy Deploy the package after pushing.
--force Force push: overwrite existing packages
--lock-q-files Lock the contents of the q files in the
package. Files whose first line is /dnc or
//dnc will be ignored.
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm restore¶
Restore a previously downloaded backup to kdb+ Insights Enterprise Package Manager service.
Usage:
kxi package pm restore [OPTIONS] PATH
Options:
--force Force restore: overwrite existing packages
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm rm¶
Remove a package from kdb+ Insights Enterprise Package Manager service.
ID: package-name or package-uuid (supports glob patterns)
Usage:
kxi package pm rm [OPTIONS] ID [VERSION]
Options:
--teardown Teardown the package before removing.
--rm-data Remove the data associated with the
deployment
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm teardown¶
Teardown a deployed package running on an insights instance.
Usage:
kxi package pm teardown [OPTIONS] PACKAGE
Options:
--rm-data Remove the data associated with the
deployment
--db TEXT Teardown a database in the package
--pipeline TEXT Teardown a pipeline in the package
--fields TEXT [default: name, package, version, function,
status, data, access, owner, id, info, size,
components]
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm validate¶
Validate a package in kdb+ Insights Enterprise Package Manager service.
Usage:
kxi package pm validate [OPTIONS] [PATH]
Options:
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--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:
--fix-uuids Fix names and uuids of duplicate objects in the package.
--fix-dupes Fix names and uuids of duplicate objects in the package.
--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 agg¶
Remove aggregator from the specified package
Usage:
kxi package rm agg [OPTIONS]
Options:
--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 dependency 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 from the specified package
Usage:
kxi package rm deployment-config [OPTIONS]
Options:
--help Show this message and exit.
kxi package rm entrypoint¶
Remove entrypoint from the specified package.
Usage:
kxi package rm entrypoint [OPTIONS]
Options:
--name TEXT Name of the entrypoint to remove from the package.
--help Show this message and exit.
kxi package rm patch¶
Remove patch from 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 rc¶
Remove resource_coordinator from the specified package
Usage:
kxi package rm rc [OPTIONS]
Options:
--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 rm shard¶
Use rm database instead.
Usage:
kxi package rm shard [OPTIONS]
Options:
--name TEXT Name of the shard to be removed.
--help Show this message and exit.
kxi package rm stream¶
Remove stream from the specified package
Usage:
kxi package rm stream [OPTIONS]
Options:
--name TEXT Name of the stream to be removed from the database.
--database TEXT Name of the database where the stream is located.
--help Show this message and exit.
kxi package rm table¶
Remove a table from the specified package
Usage:
kxi package rm table [OPTIONS]
Options:
--name TEXT Name of the table to remove from the package.
--help Show this message and exit.
kxi package rm view¶
Remove a view from the specified package.
Usage:
kxi package rm view [OPTIONS]
Options:
--name TEXT Name of the view to remove from the package.
--help Show this message and exit.
kxi package rm workload¶
Removes a workload from the package's workload.yaml.
Usage:
kxi package rm workload [OPTIONS]
Options:
-n, --name TEXT Name of the workload to remove. [required]
--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] `.`.
--force Force unpack: Suppress user confirmation during removal
of existing package
--clear-target-dir Clear the target directory entirely before unpacking the
artifact. Destructive.
--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 pm¶
Insights Package Manager Service commands.
Usage:
kxi pm [OPTIONS] COMMAND [ARGS]...
Options:
--version Display the version of the kdb+ Insights
Enterprise Package Manager service and
client.
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm add¶
Add a component to the kdb+ Insights Enterprise Package on the service.
Usage:
kxi pm add [OPTIONS] PACKAGE_NAME {view|pipeline|database} COMPONENT_NAME
Options:
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm backup¶
Download a backup of all entitled packages from kdb+ Insights Enterprise Package Manager service
Admin users can download all packages, while non-admin users can only download packages they have READ access to.
Usage:
kxi pm backup [OPTIONS] [TARGET]
Options:
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm bounce¶
Restart a deployed package running on an insights instance.
PACKAGE: package-name
Usage:
kxi pm bounce [OPTIONS] PACKAGE
Options:
--db NAME[:COMPONENTS] Bounce db components. Format: <db-name> or
<db-name:db-components>. E.g. '--db
mydb:dap,rc'. Accepted db components: rt,
rc, dap, agg, qe_rc, qe_dap, qe_agg, sm,
router, qe.
--pipeline NAME[:COMPONENTS] Bounce pipeline components. Format:
<pipeline-name> or <pipeline-name:pipeline-
components>. E.g. '--pipeline
mypipeline:spwork'. Accepted pipeline
components: spwork, spctl.
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm config¶
Server configuration options.
Usage:
kxi pm config [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi pm config get¶
Get the current configuration of the kdb+ Insights Enterprise Package Manager service.
Usage:
kxi pm config get [OPTIONS]
Options:
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm config set¶
Set the current configuration of the kdb+ Insights Enterprise Package Manager service.
Usage:
kxi pm config set [OPTIONS] OPTION VALUE
Options:
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm convert¶
Convert V1/V2 assemblies into Packages with the server. Optionally keep the package installed on the server.
Usage:
kxi pm convert [OPTIONS] ASSEMBLY_FILE
Options:
--install Additionally installs the resulting package
on the server.
--spec-files This flag converts embedded pipeline specs
to files
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm deploy¶
Deploy a package to an insights instance.
PACKAGE: package-name VERSION: package-version
Usage:
kxi pm deploy [OPTIONS] PACKAGE [VERSION]
Options:
--env TEXT Inject environment variables to the deployed
package. `[component_name:]VAR=value`
--db TEXT Deploy a database in the package
--pipeline TEXT Deploy a pipeline in the package
--fields TEXT [default: name, package, version, function,
status, data, access, owner, id, info, size,
components]
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm edit¶
Edit the runnable component of the kdb+ Insights Enterprise Package on the service.
Usage:
kxi pm edit [OPTIONS] PACKAGE_NAME {pipeline|database} COMPONENT_NAME
Options:
--field TEXT Only edit a specific field of the entity.
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm field¶
Insights Package Manager Service Field subcommands.
Usage:
kxi pm field [OPTIONS] COMMAND [ARGS]...
Options:
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm field info¶
Get information about a field in the package.
Usage:
kxi pm field info [OPTIONS] FIELD_NAME
Options:
--where Show the location of the field in the model.
--help Show this message and exit.
kxi pm info¶
Get info about a package stored on the kdb+ Insights Enterprise Package Manager service.
Usage:
kxi pm info [OPTIONS] PACKAGE_NAME [[pipeline|table]]
Options:
-v, --version TEXT Select package version. Defaults to running
version if deployed, otherwise latest.
-i, --include [udfs|policies|files]
Include additional information in the
output. Only applies when no component type
is given.
-f, --filter TEXT Key-pattern pairs to filter the returned
components using case-sensitive wildcard
matching (e.g. name=*test). Multiple
patterns ANDed together. Only applies when
component type (e.g. table) is given.
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm journal¶
Get the current journal history of the kdb+ Insights Enterprise Package Manager service.
Usage:
kxi pm journal [OPTIONS]
Options:
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--fields TEXT [default: timestamp, action, username,
package, component_type, component, message,
params]
-a, --action TEXT CONFIGURE,CREATE,UPDATE,PATCH,DELETE,RENAME,
DEPLOY,TEARDOWN,CLEANUP,BOUNCE,LOAD
-p, --package TEXT
-u, --username TEXT
-c, --component TEXT
-l, --limit INTEGER [default: 100]
--offset INTEGER
--from [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]
--to [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]
--sort TEXT Comma-separated list of fields to sort by.
Prefix a field with '-' for descending
order. Example: 'username,-timestamp'
[default: -timestamp]
--help Show this message and exit.
kxi pm list¶
List objects stored on kdb+ Insights Enterprise Package Manager service. Optional arguments allow you to list by component.
Usage:
kxi pm list [OPTIONS] [[package|deployment|pipeline|view|database|udf|workload
|sequencer]]
Options:
-f, --filter TEXT Key-pattern pair to filter the returned
packages on. Applies case-sensitive
filtering using wildcard patterns. Multiple
patterns ANDed together. Key names may
include dot notation for nested values
(e.g., owner.name=John*).
--fields TEXT [default: name, package, version, function,
status, data, access, owner, id, info, size,
components]
--sort TEXT Comma-separated list of fields to sort by.
Prefix a field with '-' for descending
order. Example: 'name,package,-version'
[default: name]
-o, --output-format [json|table|csv|simple]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm load¶
Load a package into running deployment or global processes
Usage:
kxi pm load [OPTIONS] PACKAGE
Options:
-d, --deployment NAME_OR_UUID
-t, --targets TEXT Comma-separated targets:
daps,qe_daps,pkg_agg,pkg_qe_agg
-g, --global-processes TEXT Comma-separated global processes: agg,qe_agg
--version TEXT Version of the package to load.
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm pull¶
Download a package from kdb+ Insights Enterprise Package Manager service.
Usage:
kxi pm pull [OPTIONS] NAME [VERSION]
Options:
-O, --output TEXT Specify the output directory/archive name
for the downloaded package. Defaults to
package-name or packagename-version.kxi
-A, --artifact Download the package into a compressed
archive.
--clean Remove local files not present in the pulled
package (respects .kxignore).
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm push¶
Publish a package to kdb+ Insights Enterprise Package Manager service.
Usage:
kxi pm push [OPTIONS] [PATH]
Options:
--deploy Deploy the package after pushing.
--force Force push: overwrite existing packages
--lock-q-files Lock the contents of the q files in the
package. Files whose first line is /dnc or
//dnc will be ignored.
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm restore¶
Restore a previously downloaded backup to kdb+ Insights Enterprise Package Manager service.
Usage:
kxi pm restore [OPTIONS] PATH
Options:
--force Force restore: overwrite existing packages
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm rm¶
Remove a package from kdb+ Insights Enterprise Package Manager service.
ID: package-name or package-uuid (supports glob patterns)
Usage:
kxi pm rm [OPTIONS] ID [VERSION]
Options:
--teardown Teardown the package before removing.
--rm-data Remove the data associated with the
deployment
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm teardown¶
Teardown a deployed package running on an insights instance.
Usage:
kxi pm teardown [OPTIONS] PACKAGE
Options:
--rm-data Remove the data associated with the
deployment
--db TEXT Teardown a database in the package
--pipeline TEXT Teardown a pipeline in the package
--fields TEXT [default: name, package, version, function,
status, data, access, owner, id, info, size,
components]
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi pm validate¶
Validate a package in kdb+ Insights Enterprise Package Manager service.
Usage:
kxi pm validate [OPTIONS] [PATH]
Options:
-o, --output-format [json|table]
Output format for the command. default:
'table'.
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi publish¶
Publish to tickerplant or RT.
Usage:
kxi publish [OPTIONS]
Options:
--mode [tp|rt] tp: publish data via a tickerplant rt:
publish data using Reliable Transport (RT)
--url TEXT RT configuration URL
--endpoint TEXT RT endpoint
--name TEXT Used to distinguish multiple RT publishers
on the same host
--stream TEXT RT stream name
--path TEXT The parent path of RT log directories
--port INTEGER the port at the host (TP/QIPC)
--data TEXT The following use cases are supported: - a
file path on the local filesystem (eg.
'/home/user/data.csv') - an HTTP/S3/GS URL
- http://localhost:8080/data.csv -
s3://bucket_name/data.csv -
gs://bucket_name/data.csv - a directory
('/home/user/data') - in this case, all
files in the directory get published (non-
recursive) [required]
--table TEXT the name of a table in the database to
insert data into [required]
--file-format [csv|json|parquet|json_records]
If file_format is not provided, it will be
set based on the file extension.
--type-map TEXT JSON object of column names -> target data
types to override default Pandas type
casting. Target data type can be timespan,
timestamp, numeric. Example:
type_map={"time": "TIMEDELTA", "realTime":
"DATETIME"}
--help Show this message and exit.
kxi query¶
Query kdb Insights — SQL and User-Defined Analytics (UDAs).
Usage:
kxi query [OPTIONS] COMMAND [ARGS]...
Options:
--sql TEXT The SQL query to be executed
--output-format [tabular|csv|json|json_records|pandas]
tabular: print/write results in tabular
format (default) csv: print/write results as
csv json: print/write results as columnar
json json_records: print/write results as a
json object per row pandas: write results as
a pandas pickle (requires --output-file)
--output-file TEXT Optionally write results to an output_file
instead of console
--help Show this message and exit.
kxi query uda¶
Discover and run User-Defined Analytics (UDAs).
Called with no arguments, lists all available UDAs:
kxi query uda
To run a specific UDA:
kxi query uda [UDA] --help
kxi query uda [UDA] [PARAM=VALUE ...]
Usage:
kxi query uda [OPTIONS] COMMAND [ARGS]...
Options:
--scope TEXT Target a specific assembly, tier, or DAP.
e.g. '{"assembly": "my-pkg"}' or
'{"assembly": "my-pkg", "tier": "hdb"}'
--labels TEXT Filter DAPs by label. JSON object, e.g.
'{"region": "amer"}'
--opts TEXT Override request options. JSON object, e.g.
'{"aggFn": "myAggFn"}'
--use-qe Route to the Query Environment instead of
production. Requires the target assembly to
have a qe instance deployed.
--output-format [tabular|csv|json|json_records|pandas]
tabular: print/write results in tabular
format (default) csv: print/write results as
csv json: print/write results as columnar
json json_records: print/write results as a
json object per row pandas: write results as
a pandas pickle (requires --output-file)
--output-file TEXT Optionally write results to an output file
instead of console
--help Show this message and exit.
kxi task¶
Commands for deploying task via the management service.
Usage:
kxi task [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
kxi task run¶
Deploy a management service task with a values file.
Usage:
kxi task run [OPTIONS] {install-cnpg|uninstall-cnpg|nginx|nginx-f5} [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 kdb 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
--database-encryption-password TEXT
Password for deriving the database
encryption key
--database-encryption-secret TEXT
Secret containing the database encryption
key (creates if it does not exist)
--encryption-scope-enforced TEXT
Comma-separated list of scopes on which
encryption is enforced e.g. database
--keycloak-cnpg-secret TEXT
--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]
--encryption BOOLEAN Enables/disables encryption
--force Perform action without prompting for
confirmation
--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-groups¶
Assign groups to a user.
Usage:
kxi user assign-groups [OPTIONS] USERNAME
Options:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--groups TEXT Comma separated list of groups [required]
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi user assign-roles¶
Assign roles to a user.
Usage:
kxi user assign-roles [OPTIONS] USERNAME
Options:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--roles TEXT Comma separated list of roles [required]
--timeout INTEGER Timeout in seconds for request [default: 2]
--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
--groups TEXT Comma separated list of groups
--temporary / --not-temporary Controls whether user must reset password on
first login
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi user create-client¶
Create a client.
Usage:
kxi user create-client [OPTIONS] CLIENT_ID
Options:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi user delete¶
Delete a user.
Usage:
kxi user delete [OPTIONS] USERNAME
Options:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request [default: 2]
--force Perform action without prompting for confirmation
--help Show this message and exit.
kxi user delete-client¶
Delete a client.
Usage:
kxi user delete-client [OPTIONS] CLIENT_ID
Options:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request [default: 2]
--force Perform action without prompting for confirmation
--help Show this message and exit.
kxi user get-assigned-groups¶
View the assigned groups for a user.
Usage:
kxi user get-assigned-groups [OPTIONS] USERNAME
Options:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request [default: 2]
--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:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi user get-available-roles¶
View the available roles.
Usage:
kxi user get-available-roles [OPTIONS]
Options:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi user get-client-secret¶
Get client secret from client name.
Usage:
kxi user get-client-secret [OPTIONS] CLIENT_ID
Options:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi user list¶
List users.
Usage:
kxi user list [OPTIONS]
Options:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi user list-clients¶
List clients.
Usage:
kxi user list-clients [OPTIONS]
Options:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi user remove-groups¶
Remove groups from a user.
Usage:
kxi user remove-groups [OPTIONS] USERNAME
Options:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--groups TEXT Comma separated list of groups [required]
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi user remove-roles¶
Remove roles from a user.
Usage:
kxi user remove-roles [OPTIONS] USERNAME
Options:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--roles TEXT Comma separated list of roles [required]
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi user reset-password¶
Reset a user's password.
Usage:
kxi user reset-password [OPTIONS] USERNAME
Options:
--admin-username TEXT Administrator username
--admin-password TEXT Administrator password
--password TEXT New password for the user
--temporary / --not-temporary Controls whether user must reset password on
first login
--timeout INTEGER Timeout in seconds for request [default: 2]
--help Show this message and exit.
kxi validate¶
Generate a comprehensive cluster report that includes node and CPU utilization metrics.
Usage:
kxi validate [OPTIONS]
Options:
--help Show this message and exit.
kxi workload¶
Workload management commands.
Usage:
kxi workload [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
--debug Enable stacktrace print statements and increase verbosity for
easier debugging.
-v, --verbose Increase verbosity level
-q, --quiet Disable logs. Only print errors.
--stacktrace Enable stacktrace print statements.
--help Show this message and exit.
kxi workload get¶
[REMOTE] Do a GET request against a running workload endpoint.
Example: kxi workload get packagename/workload/myendpoint
Usage:
kxi workload get [OPTIONS] URL
Options:
--output FILE Write to file instead of stdout
-H, --header TEXT Additional HTTP header, can be used multiple
times, format: 'Header-Name: value'
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi workload post¶
[REMOTE] Do a POST request against a running workload endpoint.
Example: kxi workload post packagename/workload/myendpoint
Usage:
kxi workload post [OPTIONS] URL
Options:
--output FILE Write to file instead of stdout
-d, --data TEXT HTTP POST data
-H, --header TEXT Additional HTTP header, can be used multiple
times, format: 'Header-Name: value'
--hostname, --url TEXT Insights URL [env:
INSIGHTS_URL]
--realm TEXT Realm [env:
INSIGHTS_REALM]
--client-id TEXT Client id [env:
INSIGHTS_CLIENT_ID]
--client-secret TEXT Client secret [env:
INSIGHTS_CLIENT_SECRET]
--auth-enabled / --auth-disabled
Retrieve Bearer Token [env:
KXI_AUTH_ENABLED]
--server-timeout INTEGER Timeout for Insights server calls [env:
INSIGHTS_SERVER_TIMEOUT]
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi workon¶
Switch to a different configuration profile.
Usage:
kxi workon [OPTIONS] PROFILE
Options:
--help Show this message and exit.