Documentation
Everything you need to run StackRadar: install the open-source scanner in your Kubernetes clusters, understand exactly how SBOM generation and vulnerability matching work, and fix problems when they come up.
Getting started
Installation
- Any Kubernetes clusterThe platform-agnostic installation guide: what the StackRadar scanner needs from any conformant Kubernetes cluster — k3s, kubeadm, OpenShift, Rancher, or managed cloud — plus configuration, upgrades, and uninstall.
- Amazon EKSSet up continuous SBOM generation and vulnerability scanning on Amazon EKS: connect kubectl, install the StackRadar Helm chart, and verify the scanner is reporting.
- Google GKESet up continuous SBOM generation and vulnerability scanning on Google Kubernetes Engine: connect kubectl, install the StackRadar Helm chart, and verify the scanner is reporting.
- Azure AKSSet up continuous SBOM generation and vulnerability scanning on Azure Kubernetes Service: connect kubectl, install the StackRadar Helm chart, and verify the scanner is reporting.
- Private registries & restricted networksRun the StackRadar scanner in clusters with private container registries or restricted egress: mirror the chart and image, configure a proxy, and allow the single API endpoint the agent needs.
How it works
- Architecture & data flowHow the StackRadar scanner works: what runs in your cluster, exactly what data leaves it, how SBOMs are matched against vulnerabilities, and where your data is stored.
- Vulnerability matchingHow StackRadar matches SBOM components against 300K+ OSV.dev advisories: Package URL (PURL) matching, semver range evaluation, name-version fallback, and match confidence.
- CycloneDX SBOM formatA practical reference for the CycloneDX 1.6 JSON SBOMs StackRadar generates and ingests: components, PURLs, the dependency graph, and the fields used for vulnerability matching.
Reference
- API keys & cluster scopingHow StackRadar API keys work: cluster-scoped vs org-scoped keys, why SBOM uploads require a cluster-scoped key, and how to create and rotate keys safely.
- TroubleshootingFixes for common StackRadar scanner issues: 401/403 API errors, a cluster that never appears in the dashboard, Helm install failures, and missing SBOMs.