Skip to main content

Getting Started

When you first log into Kubex, you’ll be presented with a getting started page that walks you through the process of connecting your Kubernetes clusters to Kubex.
Data Collection Status Page

Figure: Data Collection Status Page


Installation

To deploy the Kubex Collection Stack, follow these steps below:
  1. Determine your sizing file as described in Sizing and download it.
  2. Download values-edit.yaml.
  3. If deploying on OpenShift, use the OpenShift overlay file: values-openshift.yaml. User workload monitoring must be enabled in your OpenShift cluster to allow ephemeral storage and/or custom metrics data collection. Update the cluster-monitoring-config ConfigMap:
    Ensure the config contains:
    If the cluster-monitoring-config ConfigMap does not exist, create it with:
  4. Edit values-edit.yaml with the relevant mandatory parameters as described in Configuration.
  5. To add the helm repos, run:
If the automation engine is enabled, install or upgrade the required CRDs before installing or upgrading this stack:
The kubex-crds chart must be installed before the stack creates automation-engine resources.
  1. If your cluster is not OpenShift, run this command:
  1. If your cluster is OpenShift, run this command:
To override any OpenShift defaults, add another values file or --set options after the OpenShift overlay.
Add cluster connection

Figure: Data Collection Status Page


Data Collection Status & Adding More Clusters

After deploying Kubex data collection, data will begin flowing within an hour. You can monitor the status of each cluster connection through the data collection status page, which is also accessible from the side panel. Kubex performs data analysis hourly, so data flowing in today will show analyzed results within the hour.
Data collection status

Figure: Data Collection Status Page