KubePolaris

🌟 Enterprise-Grade Kubernetes Multi-Cluster Management Platform

Website • Quick Start • Documentation • Discussions • Roadmap

中文 | English

---

📖 About

KubePolaris is a modern Kubernetes cluster management platform built with React + Go. It provides an intuitive web interface to help DevOps and development teams efficiently manage and monitor multiple Kubernetes clusters.

"Polaris" refers to the North Star, symbolizing stable and reliable guidance for Kubernetes cluster operations.

Why KubePolaris?

• 🎯 User-Centric - Clean, intuitive interface that lowers the K8s learning curve
• 🏢 Enterprise-Ready - Complete permission control, audit logs, multi-cluster management
• 🔌 Ecosystem Integration - Seamless integration with Prometheus, Grafana, AlertManager, ArgoCD
• 🚀 Out-of-the-Box - One-click Docker deployment, easy to get started
• 💯 Fully Open Source - Apache 2.0 License, community-driven

✨ Features

🏗️ Cluster Management Multi-cluster unified management Support kubeconfig / Token import Real-time cluster health monitoring Resource usage overview dashboard	📦 Workload Management Deployment / StatefulSet / DaemonSet Job / CronJob management Scale, rolling update, rollback Online YAML editor with syntax highlighting
🖥️ Node Management Node list and details Cordon / Uncordon / Drain operations Labels and taints management SSH terminal remote access	📊 Monitoring & Alerting Prometheus metrics integration Grafana dashboard embedding AlertManager integration Multi-channel notifications
🔐 Security & Permissions User / Role management RBAC fine-grained access control LDAP authentication integration Operation audit logs	🚀 DevOps Integration ArgoCD GitOps integration Global resource search Log center aggregation Web Terminal (Pod/Kubectl/SSH)

🎬 Screenshots

📸 More Screenshots

Cluster Overview	Workload Management

Pod Management	Web Terminal

🚀 Quick Start

Option 1: Docker Run (Quickest)

docker pull registry.cn-hangzhou.aliyuncs.com/clay-wangzhi/kubepolaris:latest
docker run --rm -p 8080:8080 registry.cn-hangzhou.aliyuncs.com/clay-wangzhi/kubepolaris:latest

# Access http://localhost:8080
# Default credentials: admin / KubePolaris@2026

Uses built-in SQLite, no external dependencies required. For production use, deploy with Docker Compose and MySQL.

Option 2: Docker Compose (Recommended)

# Environmental requirements Docker 20.10+ and Docker Compose 2.0+

# Clone the repository
git clone https://github.com/clay-wangzhi/KubePolaris.git
cd KubePolaris

# Configure environment variables
cp .env.example .env
vim .env  # Set your passwords

# Start services
docker compose up -d

# Access http://${ip}
# Default credentials: admin / KubePolaris@2026

Option 3: Kubernetes Deployment

# Add Helm repository
helm repo add kubepolaris https://clay-wangzhi.github.io/KubePolaris
helm repo update

# Install
helm install kubepolaris kubepolaris/kubepolaris \
  --namespace kubepolaris \
  --create-namespace

# Check status
helm status kubepolaris -n kubepolaris

Option 4: Run from Source

# Requirements
# - Go 1.24+
# - Node.js 18+
# - MySQL 8.0+

# Start backend (port 8080)
cd kubepolaris
go run main.go

# Start frontend (port 5173)
cd ui
npm install && npm run dev

# Access http://localhost:5173

📚 For detailed installation guide, see Installation Documentation

🏗️ Architecture

┌─────────────────────────────────────────────────────────────────┐
│                        KubePolaris                               │
├─────────────────────────────────────────────────────────────────┤
│  ┌─────────────────────────────────────────────────────────┐    │
│  │                    Frontend (React)                      │    │
│  │  React 19 · TypeScript · Ant Design · Monaco · xterm.js │    │
│  └─────────────────────────────────────────────────────────┘    │
│                              │                                   │
│                         REST / WebSocket                         │
│                              │                                   │
│  ┌─────────────────────────────────────────────────────────┐    │
│  │                     Backend (Go)                         │    │
│  │      Gin · GORM · k8s client-go · WebSocket · JWT       │    │
│  └─────────────────────────────────────────────────────────┘    │
│                              │                                   │
│         ┌────────────────────┼────────────────────┐             │
│         │                    │                    │             │
│    ┌────▼────┐         ┌────▼────┐         ┌────▼────┐         │
│    │  MySQL  │         │   K8s   │         │ Monitor │         │
│    │  Store  │         │ Clusters│         │Prometheus│         │
│    └─────────┘         └─────────┘         └─────────┘         │
└─────────────────────────────────────────────────────────────────┘

Tech Stack

Layer	Technology	Version
Frontend	React, TypeScript, Ant Design, Vite	19.x, 5.8, 5.x, 7.x
Backend	Go, Gin, GORM	1.24, 1.9, 1.30
Database	MySQL	8.0+
K8s Client	client-go	0.29
Monitoring	Prometheus, Grafana	-

📁 Project Structure

kubepolaris/
├── main.go                 # Application entry + embed
├── internal/               # Internal packages
│   ├── handlers/           # HTTP handlers
│   ├── services/           # Business services
│   ├── models/             # Data models
│   ├── middleware/         # Middleware
│   ├── router/             # Router configuration
│   └── k8s/                # K8s client wrapper
├── ui/                     # Frontend (source + build output)
│   ├── src/
│   │   ├── pages/          # Page components
│   │   ├── components/     # Common components
│   │   ├── services/       # API services
│   │   └── types/          # Type definitions
│   └── dist/               # Build output (embedded into binary)
├── docs/                   # Documentation site (Docusaurus)
├── deploy/                 # Deployment configs
│   ├── docker/             # Grafana & MySQL configs
│   └── helm/               # Kubernetes Helm Chart
├── Dockerfile              # Multi-stage build (single binary)
├── docker-compose.yaml     # Docker Compose orchestration
└── .env.example            # Environment variables template

📊 Feature Status

Module	Status	Description
Cluster Management	✅	Import, switch, monitor, delete
Node Management	✅	List, details, operations, SSH
Workloads	✅	Deploy/STS/DS/Job/CronJob
Pod Management	✅	List, logs, terminal, delete
Config Management	✅	ConfigMap, Secret
Network Management	✅	Service, Ingress
Storage Management	✅	PV, PVC, StorageClass
User & Permissions	✅	Users, roles, RBAC
Monitoring	✅	Prometheus, Grafana
Alerting	✅	AlertManager integration
GitOps	✅	ArgoCD integration
Audit Logs	✅	Operation logs, session audit
Global Search	✅	Cross-cluster resource search
i18n	🚧	Planned for v1.1

🗺️ Roadmap

See ROADMAP.md for the detailed plan.

Upcoming

• v1.1 (Q2 2026) - i18n support, OAuth2/OIDC integration, cost analysis
• v1.2 (Q3 2026) - Multi-tenancy, NetworkPolicy management, Service Mesh visualization
• v2.0 (Q4 2026) - Cluster lifecycle management, backup & restore, plugin system

🤝 Contributing

We welcome all contributions!

• 🐛 Report Bug
• 💡 Request Feature
• 📖 Improve Documentation
• 🔧 Submit PR

How to Contribute

# 1. Fork and clone
git clone https://github.com/YOUR_USERNAME/kubepolaris.git

# 2. Create feature branch
git checkout -b feature/amazing-feature

# 3. Commit changes
git commit -m 'feat: add amazing feature'

# 4. Push and create PR
git push origin feature/amazing-feature

📚 Documentation

Document	Link
🏠 Official Website	kubepolaris.clay-wangzhi.com
📖 User Documentation	docs
🚀 Quick Start	quick-start
📦 Installation Guide	installation
🔧 Configuration	configuration
🔌 API Reference	api-reference

💬 Community

• 💭 GitHub Discussions - Q&A and feature discussions
• 📢 Slack - Real-time chat
• 📧 Mailing List: kubepolaris@googlegroups.com

🔒 Security

If you discover a security vulnerability, please see SECURITY.md for the reporting process.

📄 License

KubePolaris is open-sourced under the Apache License 2.0.

🙏 Acknowledgements

Thanks to these amazing open source projects:

• Kubernetes - Container orchestration platform
• Gin - Go web framework
• Ant Design - React UI component library
• client-go - Kubernetes Go client
• xterm.js - Terminal component

Special thanks to all contributors!

---

If KubePolaris helps you, please give us a ⭐️ Star!