LogoLogo
StackState.comDownloadSupportExplore playground
StackState v6.0
StackState v6.0
  • StackState docs!
  • Docs for all StackState products
  • 🚀Get started
    • Quick start guide
    • StackState walk-through
    • SUSE Rancher Prime
      • Air-gapped
      • Agent Air-gapped
  • 🦮Guided troubleshooting
    • What is guided troubleshooting?
    • YAML Configuration
    • Changes
    • Logs
  • 🚨Monitors and alerts
    • Monitors
    • Out of the box monitors for Kubernetes
    • Notifications
      • Configure notifications
      • Notification channels
        • Slack
        • Teams
        • Webhook
        • Opsgenie
      • Troubleshooting
    • Customize
      • Add a monitor using the CLI
      • Override monitor arguments
      • Write a remediation guide
  • 📈Metrics
    • Explore Metrics
    • Custom charts
      • Adding custom charts to components
      • Writing PromQL queries for representative charts
      • Troubleshooting custom charts
    • Advanced Metrics
      • Grafana Datasource
      • Prometheus remote_write
      • OpenMetrics
  • 📑Logs
    • Explore Logs
    • Log Shipping
  • 🔭Traces
    • Explore Traces
  • 📖Health
    • Health synchronization
    • Send health data over HTTP
      • Send health data
      • Repeat Snapshots JSON
      • Repeat States JSON
      • Transactional Increments JSON
    • Debug health synchronization
  • 🔍Views
    • Kubernetes views
    • Custom views
    • Component views
    • Explore views
    • View structure
      • Filters
      • Overview perspective
      • Highlights perspective
      • Topology perspective
      • Events perspective
      • Metrics perspective
      • Traces perspective
    • Timeline and time travel
  • 🕵️Agent
    • Network configuration
      • Proxy Configuration
    • Using a custom registry
    • Custom Secret Management
    • Request tracing
      • Certificates for sidecar injection
  • 🔭Open Telemetry
    • Getting started
    • Open telemetry collector
    • Languages
      • Generic Exporter configuration
      • Java
      • Node.js
      • .NET
      • Verify the results
    • Troubleshooting
  • CLI
    • StackState CLI
  • 🚀Self-hosted setup
    • Install StackState
      • Requirements
      • Kubernetes / OpenShift
        • Kubernetes install
        • OpenShift install
        • Required Permissions
        • Non-high availability setup
        • Small profile setup
        • Override default configuration
        • Configure storage
        • Exposing StackState outside of the cluster
      • Initial run guide
      • Troubleshooting
        • Logs
    • Configure StackState
      • Slack notifications
      • Stackpacks
    • Release Notes
      • v1.11.0 - 18/07/2024
      • v1.11.3 - 15/08/2024
      • v1.11.4 - 29/08/2024
      • v1.12.0 - 24/10/2024
      • v1.12.1 - 08/11/2024
    • Upgrade StackState
      • Steps to upgrade
      • Version-specific upgrade instructions
    • Uninstall StackState
    • Air-gapped
      • StackState air-gapped
      • StackState Kubernetes Agent air-gapped
    • Data management
      • Backup and Restore
        • Kubernetes backup
        • Configuration backup
      • Data retention
      • Clear stored data
    • Security
      • Authentication
        • Authentication options
        • File-based
        • LDAP
        • Open ID Connect (OIDC)
        • KeyCloak
        • Service tokens
      • RBAC
        • Role-based Access Control
        • Permissions
        • Roles
        • Scopes
      • Self-signed certificates
  • 🔐Security
    • Service Tokens
    • Ingestion API Keys
  • ☁️SaaS
    • User Management
  • Reference
    • StackState Query Language (STQL)
    • Chart units
Powered by GitBook
LogoLogo

Legal notices

  • Privacy
  • Cookies
  • Responsible disclosure
  • SOC 2/SOC 3
On this page
  • StackState quick start guides
  • Overview
  • Kubernetes
  • OpenShift
  • Amazon EKS
  • Google GKE
  • Azure AKS
  • KOPS
  • Self-hosted
  • What's next?
  1. Get started

Quick start guide

StackState v6.0

PreviousDocs for all StackState productsNextStackState walk-through

Last updated 10 months ago

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 Kubernetes Version

Kubernetes 1.30

Kubernetes 1.29

Kubernetes 1.28

Kubernetes 1.27

Kubernetes 1.26

Kubernetes 1.25

Kubernetes 1.24

Kubernetes 1.23

Kubernetes 1.22

Kubernetes 1.21

Supported runtime

Supported runtime

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

To get data from a Kubernetes cluster into StackState, follow the steps described below:

  1. Add the StackState helm repository to the local helm client:

    helm repo add stackstate https://helm.stackstate.io
    helm repo update
  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. 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. 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


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

OpenShift Version
Supported Kubernetes Version
OpenShift End of Support

OpenShift 4.12

Kubernetes 1.25

July 17, 2024

OpenShift 4.11

Kubernetes 1.24

February 10, 2024

OpenShift 4.10

Kubernetes 1.23

September 10, 2023

OpenShift 4.9

Kubernetes 1.22

April 18, 2023

Supported runtime

Supported runtime

Docker

ContainerD

CRI-O

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 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 an OpenShift integration

To get data from a Kubernetes cluster into StackState, follow the steps described below:

  1. Add the StackState helm repository to the local helm client:

    helm repo add stackstate https://helm.stackstate.io
    helm repo update
  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. 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. 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

Kubernetes version
Amazon EKS release
Amazon EKS End of Support
Amazon EKS End of Extended Support

1.30

May 23, 2024

July 23, 2025

July 23, 2026

1.29

January 23, 2024

March 23, 2025

March 23, 2026

1.28

September 26, 2023

November 01, 2024

November 26, 2025

1.27

May 24, 2023

July 2024

July 24, 2025

1.26

April 11, 2023

June 2024

June 11, 2025

1.25

February 21, 2023

May 2024

May 1, 2025

1.24

November 15, 2022

January 2024

January 31, 2025

1.23

August 11, 2022

October 11, 2023

October 11, 2024

1.22

April 4, 2022

June 4, 2023

September 1, 2024

1.21

July 19, 2021

February 15, 2023

July 15, 2024

1.20

May 18, 2021

November 1, 2022

N/A

1.19

February 16, 2021

August 1, 2022

N/A

1.18

October 13, 2020

August 15, 2022

N/A

Supported runtime

Supported runtime

Docker

ContainerD

CRI-O

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, 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 Amazon EKS integration

To get data from a Kubernetes cluster into StackState, follow the steps described below:

  1. Add the StackState helm repository to the local helm client:

    helm repo add stackstate https://helm.stackstate.io
    helm repo update
  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. 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. 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

Kubernetes Version
Google GKE release
Google GKE End of Support

1.30

June, 2024

August 15, 2025

1.29

January 25, 2024

March 21, 2025

1.28

December 4, 2023

February 4, 2025

1.27

June 14, 2023

August 31, 2024

1.26

April 14, 2023

June 30, 2024

Supported runtime

Supported runtime

Docker

ContainerD

CRI-O

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, 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 Google GKE integration

To get data from a Kubernetes cluster into StackState, follow the steps described below:

  1. Add the StackState helm repository to the local helm client:

    helm repo add stackstate https://helm.stackstate.io
    helm repo update
  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. 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. 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

Kubernetes Version
Azure AKS release
Azure AKS End of Support

1.30

June 2024

Not known when published

1.29

March 18, 2024

Jan 31, 2025

1.28

November 7, 2023

November 30, 2024

1.27

August 16, 2023

July 31, 2024

Supported runtime

Supported runtime

Docker

ContainerD

CRI-O

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, 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 Azure AKS integration

To get data from a Kubernetes cluster into StackState, follow the steps described below:

  1. Add the StackState helm repository to the local helm client:

    helm repo add stackstate https://helm.stackstate.io
    helm repo update
  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. 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. 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 Kubernetes Version

Kubernetes 1.30

Kubernetes 1.29

Kubernetes 1.28

Kubernetes 1.27

Kubernetes 1.26

Kubernetes 1.25

Kubernetes 1.24

Kubernetes 1.23

Kubernetes 1.22

Kubernetes 1.21

Kubernetes 1.20

Kubernetes 1.19

Kubernetes 1.18

Kubernetes 1.17

Kubernetes 1.16

Supported runtime

Supported runtime

Docker

ContainerD

CRI-O

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, 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 KOPS integration

To get data from a Kubernetes cluster into StackState, follow the steps described below:

  1. Add the StackState helm repository to the local helm client:

    helm repo add stackstate https://helm.stackstate.io
    helm repo update
  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. 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. 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 Kubernetes Version

Kubernetes 1.30

Kubernetes 1.29

Kubernetes 1.28

Kubernetes 1.27

Kubernetes 1.26

Kubernetes 1.25

Kubernetes 1.24

Kubernetes 1.23

Kubernetes 1.22

Kubernetes 1.21

Kubernetes 1.20

Kubernetes 1.19

Kubernetes 1.18

Kubernetes 1.17

Kubernetes 1.16

Supported runtime

Supported runtime

Docker

ContainerD

CRI-O

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, 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 self-hosted integration

To get data from a Kubernetes cluster into StackState, follow the steps described below:

  1. Add the StackState helm repository to the local helm client:

    helm repo add stackstate https://helm.stackstate.io
    helm repo update
  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. 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. 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?

Before you begin, check the .

When running on a self-hosted air-gapped environment prepare the agent installation first with the .

Before you begin, check the .

Before you begin, check the .

Before you begin, check the .

Before you begin, check the .

Before you begin, check the .

Generate a secret for the mutating validation webhook which is part of

Before you begin, check the .

🚀
air-gapped instructions
request tracing
StackState walk-through
Amazon EKS
Azure AKS
Google GKE
Kubernetes
KOPS
OpenShift
Self-hosted
prerequisites for Kubernetes
prerequisites for Kubernetes
prerequisites for Kubernetes
prerequisites for Kubernetes
prerequisites for Kubernetes
prerequisites for Kubernetes
prerequisites for Kubernetes