Skip to content

🚀 K8s Tools - Kubernetes Analysis & Reporting Suite

Comprehensive Kubernetes Cluster Analysis and Reporting Tools for DevOps Engineers, SREs, and Platform Teams

License: MIT Python 3.9+ Kubernetes

Overview

K8s Tools is a powerful suite designed to provide deep insights into Kubernetes cluster operations through automated analysis and interactive reporting. The toolkit consists of two main components that work together to deliver comprehensive cluster intelligence.

Latest Release: v0.7.9 - Now with enhanced label-based analysis and application discovery features!

🎯 Key Components

  • k8s-analyzer - CLI tool for extracting and analyzing cluster data
  • k8s-reporter - Interactive web dashboard for visualization and insights

⭐ Key Benefits

  • 🔍 Deep Cluster Insights - Comprehensive resource relationship mapping
  • 📈 Temporal Analysis - Track resource lifecycle and creation patterns
  • ⚡ Resource Efficiency - Identify optimization opportunities
  • 💾 Storage Analytics - Monitor storage consumption and capacity
  • 🌐 Interactive Dashboard - User-friendly Streamlit web interface
  • 📊 Multiple Export Formats - SQLite, CSV, and JSON outputs

Quick Start

Prerequisites

1️⃣ Installation

# Install both tools using UV
uv tool install ./k8s-analyzer
uv tool install ./k8s-reporter

# Verify installation
k8s-analyzer --help
k8s-reporter --help

2️⃣ Analyze Your Cluster

# Export cluster data to SQLite
k8s-analyzer sqlite --output cluster-analysis.db

# Or export to CSV
k8s-analyzer csv --output-dir ./reports

3️⃣ Launch Interactive Dashboard

# Launch web interface
k8s-reporter --database cluster-analysis.db

# Access at http://localhost:8501

Architecture Overview

graph TB
    K8S[Kubernetes Cluster] -->|kubectl export| ANALYZER[k8s-analyzer]
    ANALYZER -->|SQLite DB| REPORTER[k8s-reporter]
    ANALYZER -->|CSV Export| CSV[CSV Files]
    ANALYZER -->|JSON Export| JSON[JSON Files]
    REPORTER -->|Streamlit| WEB[Web Dashboard]
    WEB -->|Analysis| INSIGHTS[📊 Cluster Insights]

    subgraph "Analysis Views"
        INSIGHTS --> OVERVIEW[📊 Overview]
        INSIGHTS --> SECURITY[🔒 Security] 
        INSIGHTS --> EFFICIENCY[⚡ Efficiency]
        INSIGHTS --> STORAGE[💾 Storage]
        INSIGHTS --> TEMPORAL[⏰ Temporal]
        INSIGHTS --> NAMESPACE[🏠 Namespaces]
    end

Use Cases

🔧 Operations & SRE

  • Cluster Health Monitoring - Continuous resource health assessment
  • Capacity Planning - Storage and resource utilization analysis
  • Incident Response - Quick identification of problematic resources
  • Change Impact Assessment - Before/after cluster state comparison

🛡️ Security & Compliance

  • RBAC Analysis - Service account and permission auditing
  • Security Posture - Identify pods without security contexts
  • Compliance Reporting - Generate security and compliance reports
  • Vulnerability Assessment - Track containers without resource limits

🚀 DevOps & Platform Engineering

  • Resource Optimization - Identify over/under-provisioned resources
  • Cost Management - Storage and compute efficiency analysis
  • Deployment Validation - Ensure proper resource configurations
  • Multi-cluster Management - Consistent analysis across environments

What's Next?

Community & Support

**Made with ❤️ for the Kubernetes community** [⭐ Star us on GitHub](https://github.com/k8s-tools/k8s-tools) • [📖 Documentation](.) • [💬 Get Support](https://github.com/k8s-tools/k8s-tools/issues)