Quick Start
Get Kubeshark running in your Kubernetes cluster in under 60 seconds.
Prerequisites
Before you begin, ensure you have:
- A running Kubernetes cluster (v1.16+)
- kubectl configured to access your cluster
- Helm v3.0+ installed
Installation
Step 1: Add the Helm Repository
helm repo add kubeshark https://helm.kubeshark.com
helm repo update
Step 2: Install Kubeshark
helm install kubeshark kubeshark/kubeshark
For production deployments, see the full installation guide for configuration options.
Step 3: Access the Dashboard
Forward the dashboard port to your local machine:
kubectl port-forward svc/kubeshark-front 8899:80
Open http://localhost:8899 in your browser.
Verify Installation
Check that all Kubeshark pods are running:
kubectl get pods -l app.kubernetes.io/name=kubeshark
You should see output similar to:
NAME READY STATUS RESTARTS AGE
kubeshark-front-xxxxx 1/1 Running 0 1m
kubeshark-hub-xxxxx 1/1 Running 0 1m
kubeshark-worker-xxxxx 1/1 Running 0 1m
First Steps in the Dashboard
Once the dashboard loads:
- View Live Traffic: API calls appear in real-time in the traffic stream
- Filter Traffic: Use the search bar to filter by protocol, pod, or content
- Inspect Details: Click any request to see headers, payload, and response
- View Service Map: Click the “Service Map” tab to visualize service dependencies
Common Commands
| Command | Description |
|---|---|
helm repo add kubeshark https://helm.kubeshark.com | Add the Helm repository |
helm install kubeshark kubeshark/kubeshark | Install Kubeshark |
helm upgrade kubeshark kubeshark/kubeshark | Upgrade to latest version |
helm uninstall kubeshark | Remove Kubeshark |
kubectl port-forward svc/kubeshark-front 8899:80 | Access dashboard |
What’s Next?
- Dashboard Overview - Learn the Kubeshark interface
- Capture Filters - Target specific pods and namespaces
- TLS Decryption - View encrypted traffic
- Protocol Support - Configure protocol dissectors
Troubleshooting
If pods are not starting, check for common issues:
Pods stuck in Pending state:
kubectl describe pod -l app.kubernetes.io/name=kubeshark
Check Kubeshark logs:
kubectl logs -l app.kubernetes.io/name=kubeshark-hub
For more help, see the Troubleshooting Guide.