Install StackState

StackState Self-hosted v5.0.x

This page describes StackState version 5.0.

Go to the documentation for the latest StackState release.

Before you start

Extra notes for installing on:

Before you start the installation of StackState:

  • Check the requirements to make sure that your Kubernetes environment fits the setup that you will use (recommended, minimal or non- high availability).

  • Check that you have the required permissions.

  • Request access credentials to pull the StackState Docker images from StackState support.

  • Add the StackState helm repository to the local helm client:

helm repo add stackstate
helm repo update

Install StackState

Create namespace

Start by creating the namespace where you want to install StackState and deploy the secret in that namespace. In our walkthrough we will use the namespace stackstate:

kubectl create namespace stackstate

Generate values.yaml

The values.yaml file is required to deploy StackState with Helm. It contains your StackState license key, StackState Receiver API key and other important information.

Before you continue: Make sure you have the latest version of the Helm chart with helm repo update.

The script in the installation directory of the Helm chart will guide you through generating a values.yaml file that can be used to deploy StackState. You can run the script in two ways:

  • Interactive mode: When the script is run without any arguments, it will guide you through the required configuration items.

  • Non-interactive mode: Run the script with the flag -n to pass configuration on the command line, this is useful for scripting.

    ./ -n <configuration items>

The script requires the following configuration items:


Base URL


The <STACKSTATE_BASE_URL>. The external URL for StackState that users and agents will use to connect. For example https://stackstate.internal. If you haven't decided on an Ingress configuration yet, use http://localhost:8080. This can be updated later in the generated file.

Username and password**

-u -p

The username and password used by StackState to pull images from repositories.

License key


The StackState license key.

Admin API password


The password for the admin API. Note that this API contains system maintenance functionality and should only be accessible by the maintainers of the StackState installation. This can be omitted from the command line, the script will prompt for it.

Default password


The password for the default user (admin) to access StackState's UI. This can be omitted from the command line, the script will prompt for it.

Kubernetes cluster name


StackState will use this name to identify the cluster. In non-interactive mode, specifying -k will both enable automatic Kubernetes support and set the cluster name. In interactive mode, you will first be asked if you want to automatically install the Kubernetes StackPack.

Store the generated values.yaml file somewhere safe. You can reuse this file for upgrades, which will save time and (more importantly) will ensure that StackState continues to use the same API key. This is desirable as it means Agents and other data providers for StackState will not need to be updated.

Deploy StackState with Helm

The recommended deployment of StackState is a production ready, high availability setup with many services running redundantly. If required, it is also possible to run StackState in a non-redundant setup, where each service has only a single replica.

The non-high availability setup is only suitable for situations that do not require high availability.

To deploy StackState in a high availability setup on Kubernetes:

  1. Deploy the latest StackState version to the stackstate namespace with the following command:

helm upgrade \
  --install \
  --namespace stackstate \
  --values values.yaml \
stackstate \

After the install, the StackState release should be listed in the StackState namespace and all pods should be running:

# Check the release is listed
helm list --namespace stackstate

# Check pods are running
# It may take some time for all pods to be installed or available
kubectl get pods --namespace stackstate

Access the StackState UI

After StackState has been deployed you can check if all pods are up and running:

kubectl get pods --namespace stackstate

When all pods are up, you can enable a port-forward:

kubectl port-forward service/stackstate-router 8080:8080 --namespace stackstate

StackState will now be available in your browser at https://localhost:8080. Log in with the username admin and the default password provided in the values.yaml file.

Next steps are

Automatic Kubernetes support

StackState has built-in support for Kubernetes by means of the Kubernetes StackPack. To get started quickly, the StackState installation can automate installation of this StackPack and the required agent for the cluster that StackState itself will be installed on. This is not required and can always be done later from the StackPacks page of the StackState UI for StackState's cluster or any other Kuberenetes cluster.

The only required information is a name for the Kubernetes cluster that will distinguish it from the other Kubernetes clusters monitored by StackState. A good choice usually is the same name that is used in the kube context configuration. This will then automatically install the StackPack and install a Daemonset for the agent and a deployment for the so called cluster agent. For the full details, read the Kubernetes StackPack page.

Last updated