Quickstart

This guide installs Kuberhealthy, deploys a sample HealthCheck, and shows how to verify results.

Install

Helm (recommended)

helm install kuberhealthy deploy/helm/kuberhealthy -n kuberhealthy --create-namespace

Kustomize

kubectl apply -k github.com/kuberhealthy/kuberhealthy/deploy/kustomize/base?ref=main

Apply a sample HealthCheck

If you installed Kuberhealthy in a different namespace, update the metadata.namespace value below.

kubectl apply -f - <<'YAML'
apiVersion: kuberhealthy.github.io/v2
kind: HealthCheck
metadata:
  name: quickstart-check
  namespace: kuberhealthy
spec:
  runInterval: 5m
  timeout: 1m
  podSpec:
    spec:
      containers:
        - name: check
          image: docker.io/curlimages/curl:8.5.0
          imagePullPolicy: IfNotPresent
          command:
            - sh
            - -c
            - |
              set -euo pipefail
              echo "Reporting to $KH_REPORTING_URL"
              curl -fsS \
                -H "Content-Type: application/json" \
                -H "kh-run-uuid: $KH_RUN_UUID" \
                -d '{"ok":true,"errors":[]}' "$KH_REPORTING_URL"
      restartPolicy: Never
YAML

Verify

kubectl -n kuberhealthy get healthchecks
kubectl -n kuberhealthy port-forward svc/kuberhealthy 8080:80
curl -fsS http://localhost:8080/json

Open http://localhost:8080 to view the status UI.

Next steps

Write your own HealthCheck to validate real workflows (including multi-step synthetic simulations) in any language. Start with CHECK_CREATION.md and the client libraries listed in README.md.

Uninstall

Kustomize:

kubectl delete -k deploy/kustomize/base

Helm:

helm uninstall kuberhealthy -n kuberhealthy

Optional:

kubectl delete namespace kuberhealthy