Back to Kubescape

Kubescape

README.md

4.0.616.6 KB
Original Source

Kubescape

<picture> <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cncf/artwork/master/projects/kubescape/stacked/white/kubescape-stacked-white.svg" width="150"> <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/cncf/artwork/master/projects/kubescape/stacked/color/kubescape-stacked-color.svg" width="150"> </picture>

Comprehensive Kubernetes Security from Development to Runtime

Kubescape is an open-source Kubernetes security platform that provides comprehensive security coverage, from left to right across the entire development and deployment lifecycle. It offers hardening, posture management, and runtime security capabilities to ensure robust protection for Kubernetes environments.

Kubescape was created by ARMO and is a Cloud Native Computing Foundation (CNCF) incubating project.

Please star ⭐ the repo if you want us to continue developing and improving Kubescape!


📑 Table of Contents


✨ Features

FeatureDescription
🔍 Misconfiguration ScanningScan clusters, YAML files, and Helm charts against NSA-CISA, MITRE ATT&CK®, and CIS Benchmarks
🐳 Image Vulnerability ScanningDetect CVEs in container images using Grype
🩹 Image PatchingAutomatically patch vulnerable images using Copacetic
🔧 Auto-RemediationAutomatically fix misconfigurations in Kubernetes manifests
🛡️ Admission ControlEnforce security policies with Validating Admission Policies (VAP)
📊 Runtime SecurityeBPF-based runtime monitoring via Inspektor Gadget
🤖 AI IntegrationMCP server for AI assistant integration

🎬 Demo


🚀 Quick Start

1. Install Kubescape

sh
curl -s https://raw.githubusercontent.com/kubescape/kubescape/master/install.sh | /bin/bash

💡 See Installation for more options (Homebrew, Krew, Windows, etc.)

2. Run Your First Scan

sh
# Scan your current cluster
kubescape scan

# Scan a specific YAML file or directory
kubescape scan /path/to/manifests/

# Scan a container image for vulnerabilities
kubescape scan image nginx:latest

3. Explore the Results

Kubescape provides a detailed security posture overview including:

  • Control plane security status
  • Access control risks
  • Workload misconfigurations
  • Network policy gaps
  • Compliance scores (MITRE, NSA)

📦 Installation

One-Line Install (Linux/macOS)

bash
curl -s https://raw.githubusercontent.com/kubescape/kubescape/master/install.sh | /bin/bash

Package Managers

PlatformCommand
Homebrewbrew install kubescape
Krewkubectl krew install kubescape
Arch Linuxyay -S kubescape
Ubuntusudo add-apt-repository ppa:kubescape/kubescape && sudo apt install kubescape
NixOSnix-shell -p kubescape
Chocolateychoco install kubescape
Scoopscoop install kubescape

Windows (PowerShell)

powershell
iwr -useb https://raw.githubusercontent.com/kubescape/kubescape/master/install.ps1 | iex

📖 Full Installation Guide →


🛠️ CLI Commands

Kubescape provides a comprehensive CLI with the following commands:

CommandDescription
kubescape scanScan cluster, files, or images for security issues
kubescape scan imageScan container images for vulnerabilities
kubescape fixAuto-fix misconfigurations in manifest files
kubescape patchPatch container images to fix vulnerabilities
kubescape listList available frameworks and controls
kubescape downloadDownload artifacts for offline/air-gapped use
kubescape configManage cached configurations
kubescape operatorInteract with in-cluster Kubescape operator
kubescape vapManage Validating Admission Policies
kubescape mcpserverStart MCP server for AI assistant integration
kubescape completionGenerate shell completion scripts
kubescape versionDisplay version information

📖 Usage Examples

Scanning

Scan a Running Cluster

bash
# Default scan (all frameworks)
kubescape scan

# Scan with a specific framework
kubescape scan framework nsa
kubescape scan framework mitre
kubescape scan framework cis-v1.23-t1.0.1

# Scan a specific control
kubescape scan control C-0005 -v

Scan Files and Repositories

bash
# Scan local YAML files
kubescape scan /path/to/manifests/

# Scan a Helm chart
kubescape scan /path/to/helm/chart/

# Scan a Git repository
kubescape scan https://github.com/kubescape/kubescape

# Scan with Kustomize
kubescape scan /path/to/kustomize/directory/

Scan Options

bash
# Include/exclude namespaces
kubescape scan --include-namespaces production,staging
kubescape scan --exclude-namespaces kube-system,kube-public

# Use alternative kubeconfig
kubescape scan --kubeconfig /path/to/kubeconfig

# Set compliance threshold (exit code 1 if below threshold)
kubescape scan --compliance-threshold 80

# Set severity threshold
kubescape scan --severity-threshold high

Output Formats

bash
# JSON output
kubescape scan --format json --output results.json

# JUnit XML (for CI/CD)
kubescape scan --format junit --output results.xml

# SARIF (for GitHub Code Scanning)
kubescape scan --format sarif --output results.sarif

# HTML report
kubescape scan --format html --output report.html

# PDF report
kubescape scan --format pdf --output report.pdf

Image Scanning

bash
# Scan a public image
kubescape scan image nginx:1.21

# Scan with verbose output
kubescape scan image nginx:1.21 -v

# Scan a private registry image
kubescape scan image myregistry/myimage:tag --username user --password pass

Using an Offline Grype Database

bash
# Start the offline Grype-DB server (using docker)
docker run --rm -p8080:8080 quay.io/kubescape/grype-offline-db:v6-latest

# Scan an image using the offline database:
kubescape scan image --grype-db-url http://localhost:8080/databases/ nginx:latest

Auto-Fix

Automatically fix misconfigurations in your manifest files:

bash
# First, scan and save results to JSON
kubescape scan /path/to/manifests --format json --output results.json

# Then apply fixes
kubescape fix results.json

# Dry run (preview changes without applying)
kubescape fix results.json --dry-run

# Apply fixes without confirmation prompts
kubescape fix results.json --no-confirm

Image Patching

Patch container images to fix OS-level vulnerabilities:

bash
# Start buildkitd (required)
sudo buildkitd &

# Patch an image
sudo kubescape patch --image docker.io/library/nginx:1.22

# Specify custom output tag
sudo kubescape patch --image nginx:1.22 --tag nginx:1.22-patched

# See detailed vulnerability report
sudo kubescape patch --image nginx:1.22 -v

📖 Full Patch Command Documentation →

List Frameworks and Controls

bash
# List available frameworks
kubescape list frameworks

# List all controls
kubescape list controls

# Output as JSON
kubescape list controls --format json

Offline Support

Download artifacts for air-gapped environments:

bash
# Download all artifacts
kubescape download artifacts --output /path/to/offline/dir

# Download a specific framework
kubescape download framework nsa --output /path/to/nsa.json

# Scan using downloaded artifacts
kubescape scan --use-artifacts-from /path/to/offline/dir

Configuration

bash
# View current configuration
kubescape config view

# Set account ID
kubescape config set accountID <your-account-id>

# Delete cached configuration
kubescape config delete

Operator Commands

Interact with the in-cluster Kubescape operator:

bash
# Trigger a configuration scan
kubescape operator scan configurations

# Trigger a vulnerability scan
kubescape operator scan vulnerabilities

Validating Admission Policies

Manage Kubernetes Validating Admission Policies:

bash
# Deploy the Kubescape CEL admission policy library
kubescape vap deploy-library | kubectl apply -f -

# Create a policy binding
kubescape vap create-policy-binding \
  --name my-policy-binding \
  --policy c-0016 \
  --namespace my-namespace | kubectl apply -f -

MCP Server

Start an MCP (Model Context Protocol) server for AI assistant integration:

bash
kubescape mcpserver

The MCP server exposes Kubescape's vulnerability and configuration scan data to AI assistants, enabling natural language queries about your cluster's security posture.

Available MCP Tools:

  • list_vulnerability_manifests - Discover vulnerability manifests
  • list_vulnerabilities_in_manifest - List CVEs in a manifest
  • list_vulnerability_matches_for_cve - Get details for a specific CVE
  • list_configuration_security_scan_manifests - List configuration scan results
  • get_configuration_security_scan_manifest - Get configuration scan details

🏗️ Architecture

Kubescape can run in two modes:

CLI Mode

The CLI is a standalone tool that scans clusters, files, and images on-demand.

<div align="center"> </div>

Key Components:

Operator Mode (In-Cluster)

For continuous monitoring, deploy the Kubescape operator via Helm.

<div align="center"> </div>

Additional Capabilities:

  • Continuous configuration scanning
  • Image vulnerability scanning
  • Runtime analysis with eBPF
  • Network policy generation

📖 Full Architecture Documentation →


☸️ In-Cluster Operator

The Kubescape operator provides continuous security monitoring in your cluster:

bash
# Add the Kubescape Helm repository
helm repo add kubescape https://kubescape.github.io/helm-charts/

# Install the operator
helm upgrade --install kubescape kubescape/kubescape-operator \
  --namespace kubescape \
  --create-namespace

Operator Features:

  • 🔄 Continuous misconfiguration scanning
  • 🐳 Image vulnerability scanning for all workloads
  • 🔍 Runtime threat detection (eBPF-based)
  • 🌐 Network policy generation
  • 📈 Prometheus metrics integration

📖 Operator Installation Guide →


🔌 Integrations

CI/CD

PlatformIntegration
GitHub Actionskubescape/github-action
GitLab CIDocumentation
JenkinsDocumentation

IDE Extensions

IDEExtension
VS CodeKubescape Extension
LensKubescape Lens Extension

Where You Can Use Kubescape

<div align="center"> </div>

👥 Community

Kubescape is a CNCF incubating project with an active community.

Get Involved

Contributing

We welcome contributions! Please see our:

Community Resources

Contributors

<a href="https://github.com/kubescape/kubescape/graphs/contributors"> </a>

Changelog

Kubescape changes are tracked on the releases page.


License

Copyright 2021-2025, the Kubescape Authors. All rights reserved.

Kubescape is released under the Apache 2.0 license.

Kubescape is a Cloud Native Computing Foundation (CNCF) incubating project and was contributed by ARMO.

<div align="center"> </div>