Links

Quick start guide

StackState for Kubernetes troubleshooting

Overview

When your StackState SaaS instance has been set up and configured, you will receive an email from StackState with the required login details. This quick start guide will help you get started and get your own data into your StackState SaaS instance.
To integrate your cluster(s) with StackState you can either follow the instuctions for Kubernetes and/or OpenShift.

Kubernetes quick start guide

Set up a Kubernetes integration to collect topology, events, logs, change and metrics data from a Kubernetes cluster and make this available in StackState.

Supported Kubernetes versions

StackState Agent is supported to monitor the following versions of Kubernetes or OpenShift:
  • Kubernetes:
    • Kubernetes 1.16 - 1.26
  • OpenShift:
    • OpenShift 4.3 - 4.12
  • Container runtimes:
    • Docker
    • containerd
    • CRI-O

Prerequisites for Kubernetes

To set up a StackState Kubernetes integration you need to have:
  • An up-and-running Kubernetes Cluster.
  • A recent version of Helm 3.
  • A user with THE permission to create privileged pods, ClusterRoles and ClusterRoleBindings:
    • ClusterRole and ClusterRoleBinding are needed to grant StackState Agents permissions to access the Kubernetes API.
    • StackState Agents need to run in a privileged pod to be able to gather information on network connections and host information.

Set up a Kubernetes integration

Before you begin, check the prerequisites for Kubernetes.
To get data from a Kubernetes cluster into StackState, follow the steps described below:
  1. 1.
    Add the StackState helm repository to the local helm client:
    helm repo add stackstate https://helm.stackstate.io
    helm repo update
  2. 2.
    In the StackState UI, open the main menu by clicking in the top left of the screen and go to StackPacks > Integrations > Kubernetes.
  3. 3.
    Install a new instance of the Kubernetes StackPack:
    • Specify a Kubernetes Cluster Name - this name will be used to identify the cluster in StackState.
    • Click INSTALL.
  4. 4.
    Deploy the StackState Agent, Cluster Agent, Checks Agent and kube-state-metrics on your Kubernetes cluster using the helm command provided in the StackState UI after you have installed the StackPack.
    • Once the Agents have been deployed, they will begin collecting data and push this to StackState

OpenShift quick start guide

Set up an OpenShift integration to collect topology, events, logs, change and metrics data from an OpenShift cluster and make this available in StackState.

Prerequisites for OpenShift

To set up a StackState OpenShift integration you need to have:
  • An up-and-running OpenShift Cluster.
  • A recent version of Helm 3.
  • A user with THE permission to create privileged pods, ClusterRoles, ClusterRoleBindings and SCCs:
    • ClusterRole and ClusterRoleBinding are needed to grant StackState Agents permissions to access the OpenShift API.
    • StackState Agents need to run in a privileged pod to be able to gather information on network connections and host information.

Set up an OpenShift integration

Before you begin, check the prerequisites for OpenShift.
To get data from an OpenShift cluster into StackState, follow the steps described below:
  1. 1.
    Add the StackState helm repository to the local helm client:
    helm repo add stackstate https://helm.stackstate.io
    helm repo update
  2. 2.
    In the StackState UI, open the main menu by clicking in the top left of the screen and go to StackPacks > Integrations > OpenShift.
  3. 3.
    Install a new instance of the Kubernetes StackPack:
    • Specify a OpenShift Cluster Name - this name will be used to identify the cluster in StackState.
    • Click INSTALL.
  4. 4.
    Deploy the StackState Agent, Cluster Agent, Checks Agent and kube-state-metrics on your OpenShift cluster using the helm command provided in the StackState UI after you have installed the StackPack.
    • Once the Agents have been deployed, they will begin collecting data and push this to StackState

What's next?