Skip to main content

Deploying the Atlas Agent on Kubernetes with Helm

This guide explains how to deploy the Atlas Agent for database schema monitoring on Kubernetes using Helm charts. By following these steps, you can automate schema monitoring and reporting to Atlas Cloud in your Kubernetes environment.

Prerequisites

  • An Atlas Cloud account
  • A Kubernetes cluster
  • An API key for your agent
  • Optional: Password to the database you want to connect to

Create a namespace for the agent​

kubectl create namespace atlas-agent

Create a secret containing sensitive information​

Create a Secret named atlas-agent with your API key,

kubectl create secret generic atlas-agent --from-literal api-key=YOUR_API_KEY --namespace atlas-agent

If you wish the Agent to have access to your database using a password, create a second secret named atlas-agent-db with your database password:

kubectl create secret generic atlas-agent-db --from-literal password=YOUR_DB_PASSWORD --namespace atlas-agent

Install the agent​

Create a file named values.yaml with the following content:

apiKeySecret:
  name: atlas-agent
  key: api-key
image:
  tag: "latest"
livenessProbe:
  httpGet:
    path: /livez
    port: 80
readinessProbe:
  initialDelaySeconds: 5
  httpGet:
    path: /readyz
    port: 80
extraEnvs:
  - name: ATLAS_AGENT_DB_PASSWORD
    valueFrom:
      secretKeyRef:
        name: atlas-agent-db
        key: password

Install the agent using Helm:

helm install atlas-agent oci://ghcr.io/ariga/charts/atlas-agent --namespace atlas-agent -f values.yaml

Verify that the agent is running:

kubectl wait --namespace atlas-agent --for=condition=Ready pods --all