Comment on page
StackState Self-hosted v4.5.x
This page describes StackState v4.5.x. The StackState 4.5 version range is End of Life (EOL) and no longer supported. We encourage customers still running the 4.5 version range to upgrade to a more recent release.
StackState Agent V2
To retrieve topology, events and metrics data from a OpenShift cluster, you will need to have the following installed in the cluster:
- StackState Agent V2 on each node in the cluster
- StackState Cluster Agent on one node
The OpenShift integration collects topology data in an OpenShift cluster, as well as metrics and events. To achieve this, different types of StackState Agent are used:
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 an OpenShift cluster with checks that integrate with other services.
StackState Agents on OpenShift
StackState Cluster Agent is deployed as a Deployment. There is one instance for the entire cluster:
- Topology and events data for all resources in the cluster are retrieved from the OpenShift API
- Control plane metrics are retrieved from the OpenShift API
StackState Agent V2 is deployed as a DaemonSet with one instance on each node in the cluster:
- Host information is retrieved from the OpenShift API.
- Container information is collected from the Docker daemon.
- Metrics are retrieved from kubelet running on the node and also from kube-state-metrics if this is deployed on the same node.
By default, metrics are also retrieved from kube-state-metrics if that is deployed on the same node as the StackState Agent pod. This can cause issues on a large Kubernetes cluster. To avoid this, it is advisable to enable cluster checks so that metrics are gathered from kube-state-metrics by a dedicated StackState ClusterCheck Agent.
On large OpenShift clusters, you can run the
kubernetes_statecheck on the ClusterCheck Agent. This check gathers metrics from kube-state-metrics and sends them to StackState. The ClusterCheck Agent is also useful to run checks that do not need to run on a specific node and monitor non-containerized workloads such as:
- Out-of-cluster datastores and endpoints (for example, RDS or CloudSQL).
- Load-balanced cluster services (for example, Kubernetes services).
StackState Agent v2.15.0 is supported to monitor the following versions of OpenShift:
- OpenShift 4.3 - 4.8
- Docker container runtime (not containerd, cri-o)
- Default networking
The StackState Agent, Cluster Agent and kube-state-metrics can be installed together using the Cluster Agent Helm Chart:
- 1.If you do not already have it, you will need to add the StackState helm repository to the local helm client:helm repo add stackstate https://helm.stackstate.iohelm repo update
- 2.Deploy the StackState Agent, Cluster Agent and kube-state-metrics. Use the helm command provided in the StackState UI after you have installed the StackPack. For large OpenShift clusters, you can enable cluster checks to run the kubernetes_state check in a StackState ClusterCheck Agent pod.
In addition to the variables included in the provided helm command, it is also recommended to provide a
stackstate.cluster.authToken. This is an optional variable, however, if not provided a new, random value will be generated each time a helm upgrade is performed. This could leave some pods in the cluster with an incorrect configuration.
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>' \
--set 'agent.scc.enabled'=true \
--set 'kube-state-metrics.securityContext.enabled'=false \
To upgrade the Agents running in your OpenShift cluster, run the helm upgrade command provided on the StackState UI StackPacks > Integrations > OpenShift screen. This is the same command used to deploy the StackState Agent and Cluster Agent.
To enable cluster checks and deploy the ClusterCheck Agent pod, create a
values.yamlfile to deploy the
cluster-agentHelm chart and add the following YAML segment:
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 OpenShift 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.
# 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
StackState Agent V2 can be configured to reduce data production, tune the process blacklist, or turn off specific features when not needed. The required settings are described in detail on the page advanced Agent configuration.
To integrate with other external 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 an OpenShift cluster with checks that integrate with other services.
To check the status of the OpenShift integration, check that the StackState Cluster Agent (
cluster-agent) pod and all of the StackState Agent (
cluster-agent-agent) pods have status
❯ 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
To find the status of an Agent check:
- 1.Find the Agent pod that is running on the node where you would like to find a check status:kubectl get pod --output wide
- 2.Run the command:kubectl exec <agent-pod-name> -n <agent-namespace> -- agent status
- 3.Look for the check name under the
To uninstall the StackState Cluster Agent and the StackState Agent from your OpenShift cluster, run a Helm uninstall:
helm uninstall <release_name> --namespace <namespace>
# If you used the standard install command provided when you installed the StackPack
helm uninstall stackstate-cluster-agent --namespace stackstate