Comment on page
StackState Self-hosted v4.6.x
The Kubernetes integration is used to create a near real-time synchronization of topology and associated internal services from a Kubernetes cluster to StackState. This StackPack allows monitoring of the following:
- Nodes, pods, containers and services
- Configmaps, secrets and volumes
The Kubernetes integration collects topology data in a Kubernetes cluster as well as metrics and events.
- In StackState:
The following prerequisites are required to install the Kubernetes StackPack and deploy the StackState Agent and Cluster Agent:
- A Kubernetes Cluster must be up and running.
- A recent version of Helm 3.
- A user with permissions 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.
From StackState Agent v2.16, the following container runtimes are supported:
Note that versions of StackState Agent prior to v2.16 support the Docker container runtime only.
Install the Kubernetes StackPack from the StackState UI StackPacks > Integrations screen. You will need to provide the following parameters:
- Kubernetes Cluster Name - A name to identify the cluster. This does not need to match the cluster name used in
kubeconfig, however, that is usually a good candidate for a unique name.
If the Agent StackPack is not already installed, this will be automatically installed together with the Kubernetes StackPack. This is required to work with the StackState Agent, which will need to be deployed on each node in the Kubernetes cluster.
For the Kubernetes integration to retrieve topology, events and metrics data, you will need to have the following installed on your Kubernetes cluster:
- StackState Agent V2 on each node in the cluster
- StackState Cluster Agent on one node
To integrate with other services, a separate instance of the StackState Agent should be deployed on a standalone VM. It is not currently possible to configure a StackState Agent deployed on a Kubernetes cluster with checks that integrate with other services.
The kubernetes_state check is responsible for gathering metrics from kube-state-metrics and sending them to StackState. It is configured on the StackState Cluster Agent and, by default, runs in the StackState Agent pod that is on the same node as the kube-state-metrics pod.
In a default deployment, all pods running a StackState Agent must be configured with sufficient CPU and memory requests and limits to run the check. This can consume a lot of memory in a large Kubernetes cluster. Since only one StackState Agent pod will actually run the check, a lot of CPU and memory resources will be allocated, but not be used.
To remedy this situation, the kubernetes_state check can be configured to run as a cluster check. In this case, only the ClusterCheck Agent requires resources to run the check and the allocation for other pods can be reduced.
- 1.Update the
values.yamlfile used to deploy the
cluster-agent, for example:
# clusterChecks.enabled -- Enables the cluster checks functionality _and_ the clustercheck pods.
# agent.config.override -- Disables kubernetes_state check on regular agent pods.
- name: auto_conf.yaml
# clusterAgent.config.override -- Defines kubernetes_state check for clusterchecks agents. Auto-discovery
# with ad_identifiers does not work here. Use a specific URL instead.
- name: conf.yaml
- kube_state_url: http://YOUR_KUBE_STATE_METRICS_SERVICE_NAME:8080/metrics
- 1.Deploy the
cluster_agentusing the updated
helm upgrade --install \
--namespace stackstate \
--set-string 'stackstate.apiKey'='<your-api-key>' \
--set-string 'stackstate.cluster.name'='<your-cluster-name>' \
--set-string 'stackstate.cluster.authToken=<your-cluster-token>' \
--set-string 'stackstate.url'='<stackstate-receiver-api-address>' \
--values values.yaml \
To check the status of the Kubernetes integration, check that the StackState Cluster Agent (
cluster-agent) pod and all of the StackState Agent (
cluster-agent-agent) pods have status ready.
❯ kubectl get deployment,daemonset --namespace stackstate
NAME READY UP-TO-DATE AVAILABLE AGE
deployment.apps/stackstate-cluster-agent 1/1 1 1 5h14m
NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE
daemonset.apps/stackstate-cluster-agent-agent 10 10 10 10 10 <none> 5h14m
The Kubernetes integration retrieves the following data:
The table below shows which event category will be assigned to each event type in StackState:
Object change events
The Kubernetes integration will detect changes in Kubernetes objects and will create an event of type
Element Properties Changewith a diff with a YAML representation of the changed object.
Element Properties Change event
Changes will be detected in the following object types:
Secret(a hash of the content will be compared)
Note that, in order to reduce noise of changes, the following object properties will not be compared:
Kubernetes Component properties
The Kubernetes integration makes all metrics from the Kubernetes cluster available in StackState. Relevant metrics are automatically mapped to the associated components.
All retrieved metrics can be browsed or added to a component as a telemetry stream. Select the data source StackState Metrics and type
kubernetesin the Select box to get a full list of all available metrics.
Add a Kubernetes metrics stream to a component
The Kubernetes integration retrieves components and relations for the Kubernetes cluster.
StackState Agent versions prior to 2.16: Topology information is only gathered from Kubernetes clusters that use the Docker container runtime.
The following Kubernetes topology data is available in StackState as components:
The following relations between components are retrieved:
- Container → Volume
- CronJob → Job
- DaemonSet → Pod
- Deployment → ReplicaSet
- Job → Pod
- Ingress → Service
- Namespace → CronJob, DaemonSet, Deployment, Job, ReplicaSet, Service, StatefulSet
- Node → Cluster relation
- Pod → ConfigMap, Container, Deployment, Node, Secret, Volume
- ReplicaSet → Pod
- Service → ExternalService, Pod
- StatefulSet → Pod
- Direct communication between processes
- Process → Process communication via Kubernetes service
- Process → Process communication via headless Kubernetes service
The Kubernetes integration does not retrieve any traces data.
All tags defined in Kubernetes will be retrieved and added to the associated components and relations in StackState.
The StackState Agent talks to the kubelet and kube-state-metrics API.
The StackState Agent and Cluster Agent connect to the Kubernetes API to retrieve cluster wide information and Kubernetes events. The following API endpoints used:
A number of actions are added to StackState when the Kubernetes StackPack is installed. They are available from the Actions section on the right of the screen when a Kubernetes component is selected or from the component context menu, displayed when you hover over a Kubernetes component in the Topology Perspective
Details of installed actions can be found in the StackState UI Settings > Actions > Component Actions screen.
When the Kubernetes integration is enabled, the following Kubernetes views are available in StackState for each cluster:
- Kubernetes - Applications -
- Kubernetes - Infrastructure -
- Kubernetes - Namespaces -
- Kubernetes - Workload Controllers -
The code for the StackState Agent Kubernetes check is open source and available on GitHub at:
To uninstall the Kubernetes StackPack, go to the StackState UI StackPacks > Integrations > Kubernetes screen and click UNINSTALL. All Kubernetes StackPack specific configuration will be removed from StackState.
Kubernetes StackPack v3.9.9 (2022-03-02)
- Improvement: Documentation for
Kubernetes StackPack v3.9.8 (2021-11-30)
- Bug Fix: Support nodes without instanceId
Kubernetes StackPack v3.9.7 (2021-10-06)
- Bug Fix: Fix metrics for generic events
Kubernetes StackPack v3.9.6 (2021-08-20)
- Improvement: Add description to Views
Kubernetes StackPack v3.9.5 (2021-07-14)
- Improvement: Documentation update
- Improvement: Update of
stackstate.urlfor the installation documentation of the StackState Agent