Quick start guide
StackState v6.0
StackState quick start guides
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 follow one of these guides for your appropriate environment.
Kubernetes
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 versions
Supported runtime
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,ClusterRolesandClusterRoleBindings: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:
Add the StackState helm repository to the local helm client:
In the StackState UI, open the main menu by clicking in the top left of the screen and go to
StackPacks>Integrations>Kubernetes.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.
Deploy the StackState Agent, Cluster Agent, Checks Agent and kube-state-metrics on your 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
When running on a self-hosted air-gapped environment prepare the agent installation first with the air-gapped instructions.
OpenShift
Set up an OpenShift integration to collect topology, events, logs, change and metrics data from a OpenShift cluster and make this available in StackState.
Supported versions
Supported runtime
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,ClusterRolesandClusterRoleBindings: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 an OpenShift integration
Before you begin, check the prerequisites for Kubernetes.
To get data from a Kubernetes cluster into StackState, follow the steps described below:
Add the StackState helm repository to the local helm client:
In the StackState UI, open the main menu by clicking in the top left of the screen and go to
StackPacks>Integrations>Kubernetes.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.
Deploy the StackState Agent, Cluster Agent, Checks Agent and kube-state-metrics on your 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
Amazon EKS
Set up an Amazon EKS integration to collect topology, events, logs, change and metrics data from an Amazon EKS cluster and make this available in StackState.
Supported versions
Supported runtime
Prerequisites for Amazon EKS
To set up a StackState Amazon EKS integration you need to have:
An up-and-running Amazon EKS Cluster.
A recent version of Helm 3.
A user with the permission to
create privileged pods,ClusterRolesandClusterRoleBindings: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 Amazon EKS integration
Before you begin, check the prerequisites for Kubernetes.
To get data from a Kubernetes cluster into StackState, follow the steps described below:
Add the StackState helm repository to the local helm client:
In the StackState UI, open the main menu by clicking in the top left of the screen and go to
StackPacks>Integrations>Kubernetes.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.
Deploy the StackState Agent, Cluster Agent, Checks Agent and kube-state-metrics on your 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
Google GKE
Set up a Google GKE integration to collect topology, events, logs, change and metrics data from an Google GKE cluster and make this available in StackState.
Supported versions
Supported runtime
Prerequisites for Google GKE
To set up a StackState Google GKE integration you need to have:
An up-and-running Google GKE Cluster.
A recent version of Helm 3.
A user with the permission to
create privileged pods,ClusterRolesandClusterRoleBindings: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 Google GKE integration
Before you begin, check the prerequisites for Kubernetes.
To get data from a Kubernetes cluster into StackState, follow the steps described below:
Add the StackState helm repository to the local helm client:
In the StackState UI, open the main menu by clicking in the top left of the screen and go to
StackPacks>Integrations>Kubernetes.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.
Deploy the StackState Agent, Cluster Agent, Checks Agent and kube-state-metrics on your 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
Azure AKS
Set up an Azure AKS integration to collect topology, events, logs, change and metrics data from an Azure AKS cluster and make this available in StackState.
Supported versions
Supported runtime
Prerequisites for Azure AKS
To set up a StackState Azure AKS integration you need to have:
An up-and-running Azure AKS Cluster.
A recent version of Helm 3.
A user with the permission to
create privileged pods,ClusterRolesandClusterRoleBindings: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 Azure AKS integration
Before you begin, check the prerequisites for Kubernetes.
To get data from a Kubernetes cluster into StackState, follow the steps described below:
Add the StackState helm repository to the local helm client:
In the StackState UI, open the main menu by clicking in the top left of the screen and go to
StackPacks>Integrations>Kubernetes.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.
Deploy the StackState Agent, Cluster Agent, Checks Agent and kube-state-metrics on your 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
KOPS
Set up a KOPS integration to collect topology, events, logs, change and metrics data from an KOPS cluster and make this available in StackState.
Supported versions
Supported runtime
Prerequisites for KOPS
To set up a StackState KOPS integration you need to have:
An up-and-running KOPS Cluster.
A recent version of Helm 3.
A user with the permission to
create privileged pods,ClusterRolesandClusterRoleBindings: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 KOPS integration
Before you begin, check the prerequisites for Kubernetes.
To get data from a Kubernetes cluster into StackState, follow the steps described below:
Add the StackState helm repository to the local helm client:
In the StackState UI, open the main menu by clicking in the top left of the screen and go to
StackPacks>Integrations>Kubernetes.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.
Deploy the StackState Agent, Cluster Agent, Checks Agent and kube-state-metrics on your 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
Self-hosted
Set up a Self-hosted integration to collect topology, events, logs, change and metrics data from an Self-hosted cluster and make this available in StackState.
Supported versions
Supported runtime
Prerequisites for Self-hosted
To set up a StackState Self-hosted integration you need to have:
An up-and-running Self-hosted Cluster.
A recent version of Helm 3.
A user with the permission to
create privileged pods,ClusterRolesandClusterRoleBindings:ClusterRole and ClusterRoleBinding are needed to:
Grant StackState Agents permissions to access the Kubernetes API
Generate a secret for the mutating validation webhook which is part of request tracing
StackState Agents need to run in a privileged pod to be able to gather information on network connections and host information.
Set up a self-hosted integration
Before you begin, check the prerequisites for Kubernetes.
To get data from a Kubernetes cluster into StackState, follow the steps described below:
Add the StackState helm repository to the local helm client:
In the StackState UI, open the main menu by clicking in the top left of the screen and go to
StackPacks>Integrations>Kubernetes.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.
Deploy the StackState Agent, Cluster Agent, Checks Agent and kube-state-metrics on your 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?
Last updated
