🦊 k8s Fox Dashboard

Your k8sGPT results, but make them fox-ified

🦊 Because your Kubernetes cluster deserves a fox-themed dashboard.

---

📖 Overview

k8s Fox Dashboard is a Streamlit-based web dashboard that connects to k8sGPT and presents AI-powered Kubernetes cluster analysis results in a beautiful, fox-themed interface. It displays health status, analysis results in tables, historical trends, and provides an intuitive way to monitor your cluster's health.

✨ Features

• 🦊 Fox-Themed UI — Beautiful orange-themed dashboard with fox emojis throughout
• 🏥 Cluster Health Dashboard — Real-time health status of all cluster components
• 📊 Analysis Results Tables — Detailed k8sGPT analysis results with status indicators
• 📈 Historical Results — Track analysis trends over time
• 🔍 Filtering & Search — Filter by namespace, integration, and exclude specific sources
• 🎯 Interactive Metrics — st.metric cards for quick at-a-glance health overview
• 📋 DataFrames — Rich st.dataframe tables with sortable, filterable data
• 🔄 Auto-Refresh — One-click refresh for the latest analysis
• 🎛️ Configurable — Set k8sGPT backend URL and cluster name via env vars or sidebar

🖼️ Screenshots

🦊 Main Dashboard

The main dashboard shows a fox-themed header with the cluster health status panel displaying healthy/warning/unhealthy component counts using st.metric cards, followed by analysis results in a detailed st.dataframe table with status icons (🟢🟡🔴), Kubernetes object details, and error messages.

📜 Historical Analysis

The historical results panel shows time-series analysis data in a sortable table with timestamps, error counts, warning counts, and health indicators. A trend overview section uses st.metric to show latest error/warning counts with deltas. Expandable detail views show per-analysis breakdowns.

🏥 Health Status Panel

The health panel displays component health using color-coded metrics (🟢 Healthy, 🟡 Warnings, 🔴 Unhealthy) with detailed component information in a dataframe, including status indicators and health check details.

🦊 Sidebar Controls

The sidebar includes the k8sGPT backend URL configuration, filter options (integration, exclude, namespace), a refresh button, and an about section with fox-themed branding.

🚀 Installation

Prerequisites

• Python 3.9 or higher
• A running k8sGPT instance

Quick Start

1. Clone the repository:

   git clone https://github.com/three-foxes-in-a-trenchcoat/k8s-fox-dashboard.git
   cd k8s-fox-dashboard
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Run the dashboard:

   streamlit run main.py
   

4. Configure k8sGPT URL in the sidebar (default: http://localhost:8080)

Environment Variables

Variable	Default	Description
K8SGPT_URL	http://localhost:8080	k8sGPT backend API URL
CLUSTER_NAME	fox-cluster	Name to display for your cluster

📝 Usage

Connecting to k8sGPT

1. Launch the dashboard with streamlit run main.py
2. In the sidebar, set the k8sGPT Backend URL to your k8sGPT server address
3. Adjust filters as needed (namespace, integration, exclude)
4. Click 🔄 Refresh Dashboard to fetch the latest analysis

Filtering Results

• Integration — Filter by specific k8sGPT integration (e.g., prometheus, datadog)
• Exclude — Comma-separated list of integrations to exclude
• Namespace — Filter analysis to a specific Kubernetes namespace
• Include Details — Toggle whether to include detailed analysis data

Dashboard Sections

1. Cluster Health Status — Overview of all monitored components with healthy/warning/unhealthy counts
2. Analysis Results — Detailed table of all k8sGPT analysis results with status, objects, and errors
3. Historical Analysis — Time-series view of past analysis results with trend indicators

🏗️ Architecture

🦊 k8s Fox Dashboard (Streamlit)
    │
    ├── k8sGPT Backend API
    │   ├── /v1/analyze  — Current analysis results
    │   ├── /v1/health   — Cluster health status
    │   └── /v1/history  — Historical analysis data
    │
    └── Kubernetes Cluster
        └── k8sGPT Operator (optional)

🛠️ Development

# Create a virtual environment
python -m venv venv
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

# Run with hot-reload
streamlit run main.py --server.watchTheme

📄 License

This project is licensed under the MIT License.

🦊 Contributing

Contributions are welcome! Whether it's adding new fox emojis, improving the dashboard, or fixing bugs — we'd love your help.

1. Fork the repo
2. Create your feature branch (git checkout -b feature/amazing-fox-feature)
3. Commit your changes (git commit -m '🦊 Add amazing fox feature')
4. Push to the branch (git push origin feature/amazing-fox-feature)
5. Open a Pull Request

🙏 Acknowledgments

• k8sGPT — AI-powered Kubernetes troubleshooting
• Streamlit — Beautiful Python dashboards
• All the foxes 🦊🦊🦊 — Three Foxes in a Trenchcoat

---

Made with 🦊 and ❤️ by Three Foxes in a Trenchcoat