← Docs/Quick Start

Quick Start

Get up and running with Wozz in under 2 minutes.

0Prerequisites

  • ●kubectl installed and configured
  • ●Access to a Kubernetes cluster (EKS, GKE, AKS, k3s, etc.)
  • ●curl or wget

1Run the Audit

Run this command in your terminal. Make sure kubectl is pointing to the cluster you want to audit.

terminal
curl -sL wozz.io/audit.sh | bash

Or with wget:

terminal
wget -qO- wozz.io/audit.sh | bash

Privacy: Runs 100% locally. No data leaves your machine unless you use --push.

2Review Results

You'll see results directly in your terminal:

output
=====================================
WOZZ KUBERNETES AUDIT
=====================================

Cluster: prod-cluster
Namespaces: 18 | Pods: 234 | Nodes: 12

WASTE SUMMARY
─────────────
Annual Waste:  $68,420
Monthly Waste: $5,702

BREAKDOWN
─────────
Over-Provisioned Memory: $3,240/mo (57%)
Over-Provisioned CPU:    $1,890/mo (33%)
Orphaned Load Balancers: $360/mo   (6%)
Unbound PVCs:            $212/mo   (4%)

TOP ISSUES
──────────
1. api-gateway (prod) - 4Gi requested, 412Mi used
2. worker-pool (prod) - 8 CPU requested, 0.8 used
3. redis-cache (staging) - idle 22hrs/day

Run with --push to save results to your dashboard.

3Track Over Time(optional)

Push results to your dashboard to track waste trends:

terminal
curl -sL wozz.io/audit.sh | bash -s -- --push

You'll get a claim link:

output
✓ Results pushed successfully!

Claim your dashboard:
https://wozz.io/claim?token=abc123def456

This link expires in 24 hours.

Free: 7 days of history. Pro: Unlimited history + CSV exports.

CLI Options

FlagDescription
--pushSend results to your dashboard
--namespace <ns>Audit a specific namespace
--jsonOutput as JSON
--quietOnly output total waste
--context <ctx>Use specific kubectl context
--helpShow all options

GitHub Action

Catch expensive changes in PRs before they merge:

.github/workflows/wozz.yml
name: Wozz Cost Check

on:
  pull_request:
    paths: ['**/*.yaml', '**/*.yml']

jobs:
  cost-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: WozzHQ/wozz-app/action@main
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          cost-threshold: 100

Troubleshooting

Permission denied

Verify your kubectl permissions:

terminal
kubectl auth can-i get pods --all-namespaces

Metrics server not found

Works without it, but more accurate with metrics-server:

terminal
kubectl apply -f https://github.com/kubernetes-sigs/metrics-server/releases/latest/download/components.yaml

Slow on large clusters

Use --namespace to audit specific namespaces.

Next

Understanding Results

What the numbers mean

CLI Reference

All commands & flags