kxi install
Insights installation commands.
Usage:
text
Copy
kxi install [OPTIONS] COMMAND [ARGS]...
Options:
text
Copy
--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:
text
Copy
kxi install create-encryption-key [OPTIONS]
Options:
text
Copy
-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:
text
Copy
kxi install delete [OPTIONS]
Options:
text
Copy
--release TEXT Release name for the install
-n, --namespace TEXT Kubernetes namespace
--force Perform action without prompting for
confirmation
--uninstall-operator Remove KXI Operator installation
--assembly-backup-filepath TEXT
Filepath to store state of running
assemblies
--help Show this message and exit.
kxi install get-values
Display the values of the currently deployed kdb Insights Enterprise.
Usage:
text
Copy
kxi install get-values [OPTIONS]
Options:
text
Copy
-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:
text
Copy
kxi install history [OPTIONS]
Options:
text
Copy
--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:
text
Copy
kxi install idp [OPTIONS] COMMAND [ARGS]...
Options:
text
Copy
--help Show this message and exit.
kxi install idp add
Add an Azure Identity Provider to a Keycloak realm.
Usage:
text
Copy
kxi install idp add [OPTIONS]
Options:
text
Copy
--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:
text
Copy
kxi install idp list [OPTIONS]
Options:
text
Copy
--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:
text
Copy
kxi install idp mapper [OPTIONS] COMMAND [ARGS]...
Options:
text
Copy
--help Show this message and exit.
kxi install idp mapper add
Add a mapper to an Identity Provider.
Usage:
text
Copy
kxi install idp mapper add [OPTIONS]
Options:
text
Copy
--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:
text
Copy
kxi install idp mapper list [OPTIONS]
Options:
text
Copy
--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:
text
Copy
kxi install list-versions [OPTIONS]
Options:
text
Copy
--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:
text
Copy
kxi install rollback [OPTIONS] [INSIGHTS_REVISION] [CHART]
Options:
text
Copy
--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
--helm-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 --helm-timeout
--help Show this message and exit.
kxi install run
Install kdb Insights Enterprise with a values file.
Usage:
text
Copy
kxi install run [OPTIONS] [CHART]
Options:
text
Copy
-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
--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 or upgrade with this flag
will prevent installing or upgrading
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
--helm-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 --helm-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
--help Show this message and exit.
kxi install setup
Perform necessary setup steps to install Insights.
Usage:
text
Copy
kxi install setup [OPTIONS]
Options:
text
Copy
-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
--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
--help Show this message and exit.
kxi install upgrade
Upgrade kdb Insights Enterprise.
Usage:
text
Copy
kxi install upgrade [OPTIONS] [CHART]
Options:
text
Copy
-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 or upgrade with this flag
will prevent installing or upgrading
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
--helm-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 --helm-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
--help Show this message and exit.