Connect a cluster without opening it

A lightweight agent inside the cluster pushes workload usage to the app. Nothing needs to reach into your cluster: the agent only makes outbound calls.

2 min read

Register the cluster

Organization → Integrations → Kubernetes → Register a cluster.

The form to register a cluster: name, provider, kube-state-metrics URL and the security inventory option.
Cluster name
A name to recognise it, such as prod-eu. The agent identifies itself with the id generated from it.
Provider (optional)
Where the cluster runs (EKS, GKE, AKS, bare metal…). It only labels the cluster and its costs.
kube-state-metrics URL (optional)
Only fill it in if kube-state-metrics is not reachable at the chart default. It is saved on the cluster so the install command stays correct.
Security inventory
Optional. Also lists Secrets (metadata only, never their data), ServiceAccounts, Namespaces and RoleBindings for the permissions and security audit, and gives the agent extra read-only access.

Install the agent

Token and command
Saving shows an agent token and the Helm command to install the agent. The token is shown only once, so Copy the command right away: you cannot close the window before copying it.
Prerequisites
Once per cluster, if not already there: metrics-server (real-time CPU and memory usage; preinstalled on EKS, GKE and AKS, check with kubectl top pod) and kube-state-metrics (declared requests and workload ownership).

Check it reports

The registered clusters: name, provider, when the agent was last seen and the actions.
Timing
The agent pushes CPU and memory samples every 1 to 5 minutes, and the Kubernetes audit page starts reporting within the hour.
Last seen
When the agent last pushed metrics. Never means it has not reported yet; an old date means the agent stopped or its token no longer works. A cluster that stops reporting shows up under Needs attention (see The organization page).

Maintaining it

Edit
Change the name, provider, kube-state-metrics URL or the security inventory. The install command is kept in line.
Regenerate token
Revokes the current token and issues a new one. Update the agent with it, or it stops pushing metrics.
Delete
Removes the cluster and revokes its tokens.
Plan limit
Clusters count as cloud accounts for your plan's account limit (see Plans & limits).