Skip to main content

Installation

Overview​

Install the OpsWorker Kubernetes Agent using Helm. The agent runs as a single pod in a dedicated namespace.

Steps​

1. Add the Helm Repository​

helm repo add opsworker https://charts.opsworker.ai
helm repo update

2. Install the Agent​

Use the command provided in the OpsWorker portal's Add Cluster wizard. It includes your unique cluster token:

helm install opsworker-agent opsworker/opsworker-agent \
  --namespace opsworker \
  --create-namespace \
  --set clusterToken=YOUR_CLUSTER_TOKEN

Replace YOUR_CLUSTER_TOKEN with the token from the portal.

3. Verify the Pod is Running​

kubectl get pods -n opsworker

Expected output:

NAME                               READY   STATUS    RESTARTS   AGE
opsworker-agent-xxxxx-xxxxx        1/1     Running   0          30s

4. Check Agent Logs​

kubectl logs -n opsworker -l app=opsworker-agent

Look for messages indicating successful connection to SQS.

5. Confirm in Portal​

Return to the OpsWorker portal. Your cluster status should show Connected within a minute.

Custom Installation​

With Proxy Settings​

helm install opsworker-agent opsworker/opsworker-agent \
  --namespace opsworker \
  --create-namespace \
  --set clusterToken=YOUR_CLUSTER_TOKEN \
  --set proxy.https=http://proxy.example.com:3128

With Custom Resource Limits​

helm install opsworker-agent opsworker/opsworker-agent \
  --namespace opsworker \
  --create-namespace \
  --set clusterToken=YOUR_CLUSTER_TOKEN \
  --set resources.requests.memory=256Mi \
  --set resources.limits.memory=512Mi

With Values File​

helm install opsworker-agent opsworker/opsworker-agent \
  --namespace opsworker \
  --create-namespace \
  -f values.yaml

See Configuration for the full list of values.

Upgrading​

helm repo update opsworker
helm upgrade opsworker-agent opsworker/opsworker-agent -n opsworker

Uninstalling​

helm uninstall opsworker-agent -n opsworker
kubectl delete namespace opsworker

Next Steps​