Install Dashboards¶
This page explains how to add KX Dashboards to a KX Sensors deployment.
KX Sensors doesn't bundle Dashboards. You install it separately, as a modular component. Dashboards requires a license that includes the dsh feature flag. For how to check your flags, see Required feature flags. To get one, or to have your existing license reissued with the flag, contact your KX representative.
This page covers the KX Sensors-specific steps. For general information about Dashboards, including its deployment methods, see the KX Dashboards deployment overview in the Dashboards documentation.
Install Dashboards with the installer¶
Before you run the installer, do the following:
-
Add the
kxs-dashboardspackage that KX provides tokxs-bundle-<client>-<version>/packages/. -
Enable the
DASHservice class in the manifest file of the deploy directory you use. In the manifest, you can useportOffsetto choose a specific offset from the base port. For example:services: - sc: DASH <<: *default_service portOffset: 11 enabled: true -
Add the package path to the
KXS_LOAD_DIRSsetting inkxs-bundle-<client>-<version>/<deploy-dir>/install.profile. Add it before the last entry, which must remain the env package. For example:$KXS_ROOT/packages/kxs-dashboards-x.y.z
Then run the installer.
Add Dashboards to an existing deployment¶
To add Dashboards to a deployment that's already running, complete the same three steps, then stage an upgrade instead of running a fresh install:
./install -U "prompt" -D <deploy-dir>
For the options and what each argument does, see Stage an upgrade. For the full procedure, see Before you begin and Dynamic upgrades using the KX Sensors CLI.
Alternatively, you can skip the installer. Copy the Dashboards package to your node servers and run the kxsctl deploy commands manually.