Skip to content

Operator Installation

Artifact Hub

Deploy the Obsyk operator to your Kubernetes cluster. The Helm chart is available on Artifact Hub.

Prerequisites

  • Kubernetes cluster v1.26+
  • kubectl with cluster admin access
  • helm v3.x
  • Obsyk account with cluster credentials (Client ID and Private Key from the dashboard)

Installation Methods

# Add the Obsyk Helm repository
helm repo add obsyk https://obsyk.github.io/obsyk-operator
helm repo update

# Create namespace
kubectl create namespace obsyk-system

# Create secret with credentials (save your private key to private-key.pem first)
kubectl create secret generic obsyk-credentials \
  --namespace obsyk-system \
  --from-literal=client_id=YOUR_CLIENT_ID \
  --from-file=private_key=private-key.pem

# Install the operator
helm install obsyk-operator obsyk/obsyk-operator \
  --namespace obsyk-system \
  --set agent.clusterName="my-cluster" \
  --set agent.platformURL="https://app.obsyk.ai"

Helm with Values File

Create values.yaml:

agent:
  clusterName: "my-cluster"
  platformURL: "https://app.obsyk.ai"
  credentialsSecretRef:
    name: obsyk-credentials

resources:
  limits:
    cpu: 200m
    memory: 256Mi
  requests:
    cpu: 100m
    memory: 128Mi

Install:

helm install obsyk-operator obsyk/obsyk-operator \
  --namespace obsyk-system \
  --values values.yaml

Verify Installation

# Check pod status
kubectl get pods -n obsyk-system

# Expected output:
# NAME                              READY   STATUS    RESTARTS   AGE
# obsyk-operator-7d9f8b6c4-xxxxx    1/1     Running   0          1m

# Check logs
kubectl logs -n obsyk-system -l app=obsyk-operator --tail=50

Upgrading

helm repo update
helm upgrade obsyk-operator obsyk/obsyk-operator \
  --namespace obsyk-system

Uninstalling

helm uninstall obsyk-operator -n obsyk-system
kubectl delete namespace obsyk-system

Cluster Data

Uninstalling the operator stops data collection. The cluster will show as disconnected in Obsyk but historical data is retained.