Skip to content

installation.md

Latest commit

 

History

History
146 lines (105 loc) · 3.32 KB

installation.md

File metadata and controls

146 lines (105 loc) · 3.32 KB

Installation Guide

Prerequisites

  • Kubernetes cluster (1.19+)
  • Prometheus installed and scraping
  • Grafana installed (optional, for dashboards)
  • Helm 3.0+ (for Helm installation)

Installation Options

Option 1: Helm (Recommended)

# Install from OCI registry
helm install onax oci://ghcr.io/varaxlabs/charts/onax \
  --namespace monitoring \
  --create-namespace

# Or install with custom values
helm install onax oci://ghcr.io/varaxlabs/charts/onax \
  --namespace monitoring \
  --create-namespace \
  --set metrics.serviceMonitor.enabled=true \
  --set logging.level=debug

Option 2: Raw Manifests

kubectl apply -f https://raw.githubusercontent.com/varaxlabs/onax/main/deploy/manifests/operator.yaml

Option 3: Build from Source

# Clone repository
git clone https://github.com/varaxlabs/onax.git
cd onax

# Deploy using Helm from local chart
helm install onax ./deploy/helm/onax \
  --namespace monitoring \
  --create-namespace

Configure Prometheus Scraping

If using Prometheus Operator

The Helm chart creates a ServiceMonitor by default when metrics.serviceMonitor.enabled=true.

If using vanilla Prometheus

Add to your prometheus.yaml:

scrape_configs:
  - job_name: 'onax'
    kubernetes_sd_configs:
      - role: pod
        namespaces:
          names:
            - monitoring
    relabel_configs:
      - source_labels: [__meta_kubernetes_pod_label_app_kubernetes_io_name]
        action: keep
        regex: onax
      - source_labels: [__meta_kubernetes_pod_ip]
        action: replace
        target_label: __address__
        replacement: $1:8080

Import Grafana Dashboards

Method 1: Import by URL

  1. Open Grafana
  2. Click "+" → "Import"
  3. Paste the raw GitHub URL:
    • Overview: https://raw.githubusercontent.com/varaxlabs/onax/main/dashboards/cronjob-overview.json
    • Details: https://raw.githubusercontent.com/varaxlabs/onax/main/dashboards/cronjob-details.json
  4. Select your Prometheus data source
  5. Click "Import"

Method 2: Import from JSON

# Download dashboards
curl -o cronjob-overview.json \
  https://raw.githubusercontent.com/varaxlabs/onax/main/dashboards/cronjob-overview.json

curl -o cronjob-details.json \
  https://raw.githubusercontent.com/varaxlabs/onax/main/dashboards/cronjob-details.json

Then import via Grafana UI.

Configure Alerts

If using Prometheus Operator

kubectl apply -f https://raw.githubusercontent.com/varaxlabs/onax/main/alerts/cronjob-alerts.yaml

If using vanilla Prometheus

kubectl apply -f https://raw.githubusercontent.com/varaxlabs/onax/main/alerts/cronjob-alerts-configmap.yaml

Then add the ConfigMap to your Prometheus rule files.

Verify Installation

# Check pod is running
kubectl get pods -n monitoring -l app.kubernetes.io/name=onax

# Check logs
kubectl logs -n monitoring -l app.kubernetes.io/name=onax

# Port-forward to check metrics
kubectl port-forward -n monitoring svc/onax 8080:8080

# In another terminal
curl http://localhost:8080/metrics | grep cronjob_monitor

You should see metrics for all CronJobs in your cluster.

Uninstallation

Helm

helm uninstall onax --namespace monitoring

Raw Manifests

kubectl delete -f https://raw.githubusercontent.com/varaxlabs/onax/main/deploy/manifests/operator.yaml