Skip to main content

Install the agent

The agent connects your environment to nullplatform so it can run actions, respond to events, and execute workflows inside your infrastructure. Setting it up takes three steps:

  1. Authenticate the agent: create an API key with the agent and ops roles.
  2. Install the agent: use Helm for production clusters, or run the binary locally for development.
  3. Create a notification channel: connect the agent to platform events. Without this, the agent registers but stays idle.

Which install method is right for me?

Install with HelmLocal install
Best forProduction and Kubernetes clustersLocal development and testing
Requires KubernetesYesNo
Setup timeA few minutesUnder a minute

Before you start

Both methods need an API key with the agent and ops roles. See Authenticate the agent to set one up.

Pick your path

tip

Installing on Kubernetes and pulling agent code from a private GitHub repo? See Authenticate private repos with a GitHub App for a more secure alternative to personal access tokens.