kubernetes-ai-dashboard README

README проекта с github.com/shiyi25928988/kubernetes-ai-dashboard. Одним файлом markdown: README.md.

Kubernetes AI Dashboard

K8s Cluster Management + AI Assistant Platform

Java Spring Boot Vue Kubernetes License

🇺🇸 English | 🇨🇳 简体中文

Table of Contents

Introduction

Kubernetes AI Dashboard is an operations-oriented Kubernetes management platform with an integrated AI assistant. Built on the Fabric8 Kubernetes Client for full-resource cluster operations, Spring AI for tool-calling and chat, and a built-in A2A (Agent-to-Agent) protocol framework.

[!NOTE] Designed for ops scenarios — unified K8s cluster resource management with AI-assisted operations.

Features

Tech Stack

Category Technology Version
Language Java 21
Framework Spring Boot 3.5.8
AI Framework Spring AI 1.1.6
K8s Client Fabric8 Kubernetes Client 7.3.1
ORM MyBatis Plus 3.5.14
Auth Sa-Token 1.44.0
Object Storage MinIO 8.6.0
Database MySQL 8.0+
Cache Redis 7.0+
Frontend Framework Vue 3.5
Frontend Build Vite 8
UI Components Element Plus 2.13

Project Structure

graph TD
    A[kubernetes-ai-dashboard] --> B[dashboard backend app]
    A --> C[dashboard-fe frontend]
    A --> D[common shared module]
    A --> E[ai-base AI core]
    A --> F[oss object storage]
    A --> G[user auth]
    A --> H[search full-text search]
    A --> I[message site messages]
kubernetes-ai-dashboard/
├── dashboard/              # Backend main app (cc.shiyi.dashboard)
├── dashboard-fe/           # Frontend app (Vue 3)
├── common/                 # Shared module (AOP annotations, utils)
├── ai-base/                # AI core (ChatClient pool, chat memory)
├── oss/                    # Object storage (MinIO)
├── user/                   # Auth (Sa-Token)
├── search/                 # Full-text search (Lucene)
├── message/                # Site messages
└── pom.xml

Quick Start

Prerequisites

Start Dependencies

cd docker
docker-compose up -d mysql redis minio

Backend

mvn clean install -DskipTests
cd dashboard
mvn spring-boot:run

Backend runs at http://localhost:8080

Frontend

cd dashboard-fe
npm install
npm run dev

Frontend runs at http://localhost:3000

Configuration

Config file: dashboard/src/main/resources/application.yml. All values support ${ENV_VAR:default} overrides.

Env Var Description Default
SPRING_DATASOURCE_URL MySQL JDBC URL jdbc:mysql://127.0.0.1:3306/dashboard
SPRING_DATA_REDIS_HOST Redis host localhost
MINIO_ENDPOINT MinIO URL http://localhost:9000
SPRING_AI_OPENAI_BASE_URL AI API URL -
SPRING_AI_OPENAI_API_KEY AI API Key <YOUR_API_KEY>
KUBERNETES_CLIENT_TRUST_CERTS Trust K8s API certs true
DOCKER_REGISTRY_URL Docker Registry v2 address -
DOCKER_REGISTRY_USERNAME Docker Registry username -
DOCKER_REGISTRY_PASSWORD Docker Registry password -
A2A_API_KEY A2A protocol API Key <YOUR_API_KEY>

[!IMPORTANT] There is no kubeconfig entry point in config files. Upload kubeconfigs on the Cluster Config page of the web UI — they are stored in MySQL, several clusters may coexist, but exactly one is active and all K8s operations target the active cluster. Switching clusters takes effect immediately (no restart).

API Reference

Internal API (/api/v1/*, Sa-Token login required)

Method Path Description
POST /api/v1/ai/chat AI chat (streaming/non-streaming)
GET/POST/PUT/DELETE /api/v1/k8s/* K8s resource management (namespaced + cluster-scoped)
POST/GET/DELETE /api/v1/k8s/cluster-config* kubeconfig upload / list / activate / delete / test
GET /api/v1/k8s/cluster/stats Cluster statistics
GET /api/v1/resources/ownership Resource ownership query
GET /api/v1/oss/* Object storage (buckets / files / folders)
GET /api/v1/registry/* Image registry (repositories / tags / manifests)
POST/GET /api/v1/user/* User management

A2A Protocol (/a2a, API Key auth)

Method Path Description
GET /a2a/card Get AgentCard
GET /.well-known/agent-card.json Standard discovery endpoint
POST /a2a JSON-RPC 2.0 (message/send, tasks/get, tasks/cancel)
MCP Tools (7)
Tool Service Capability
KubernetesMcpService Namespace/Pod/Deployment ops, cluster stats
SystemInfoMcpService CPU/memory/disk/uptime
CommandLineMcpService Command execution (dangerous-command blacklist)
FileMcpService File read/write (sandboxed)
SshMcpService Remote SSH commands
OssMcpService MinIO upload/list
DockerRegistryMcpService Docker registry query

Deployment

For Docker deployment see DOCKER_README.md.

# Build backend image
docker build -f dashboard/Dockerfile -t <REGISTRY>/kubernetes-ai-dashboard-backend:latest .

# Build frontend image
docker build -f dashboard-fe/Dockerfile -t <REGISTRY>/kubernetes-ai-dashboard-frontend:latest ./dashboard-fe

Contributing

Issues and Pull Requests are welcome.

License

This project uses an Internal License and is not open-sourced.

kubernetes-ai-dashboard (shiyi25928988/kubernetes-ai-dashboard)

Ищем в базе…

Что это такое?Kubernetes AI Dashboard — это веб-платформа для команд эксплуатации, которая управляет полным набором ресурсов Kubernetes (Namespace, Pod, Deployment, Service, Ingress, PVC, ConfigMap, Secret, Event, Job, CRD) и добавляет ИИ-ассистента с вызовом инструментов, встроенный набор инструментов MCP и фреймворк протокола Agent-to-Agent (A2A) для операций с кластером при помощи ИИ.
Это библиотека, которую мне нужно подключить, или самостоятельное приложение?Это самостоятельное приложение: бэкенд на Java 21 / Spring Boot 3.5, построенный на клиенте Fabric8 Kubernetes, в паре с фронтендом на Vue 3 + Vite. Встраивать его в другой проект не нужно.
Как его запустить?Запустите вспомогательные сервисы (MySQL, Redis, MinIO) через Docker Compose, затем соберите и запустите бэкенд на Spring Boot с помощью Maven и фронтенд на Vue с помощью Node.js; подробности развёртывания в Docker описаны в DOCKERREADME.md.
Что нужно установить перед запуском?Нужны JDK 21+, Maven 3.9+, Node.js 18+, Docker и Docker Compose, а также доступ к кластеру Kubernetes v1.24+.
На что обратить внимание при установке?Клиенту Kubernetes необходимо явно передать kubeconfig через KUBERNETESCLIENTCONFIGURL или KUBERNETESCLIENTCONFIGPATH, иначе приложение не запустится: автоматического определения ServiceAccount внутри кластера не предусмотрено.
Какие функции ИИ здесь есть?Spring AI обеспечивает потокового чат-ассистента с вызовом инструментов и памятью контекста. Он опирается на 7 встроенных сервисов инструментов MCP, которые охватывают K8s, информацию о системе, выполнение команд, работу с файлами, SSH, объектное хранилище и запросы к реестру Docker.
Для чего нужна конечная точка протокола A2A?Она предоставляет конечную точку Agent-to-Agent по JSON-RPC 2.0 по адресу /a2a с маршрутом обнаружения AgentCard. Через неё внешние агенты могут отправлять сообщения и управлять задачами (message/send, tasks/get, tasks/cancel). В README она описана как зарезервированная точка расширения.
Как отслеживается владение ресурсами?Ресурсы, созданные через дашборд, помечаются именем пользователя-создателя, и удалять ресурсы разрешено только тем пользователям, которые их сами создали.
Как защищён вход в систему?Для входа пользователей используется Sa-Token со случайными токенами из 32 символов и сессиями, которые хранятся в Redis. Это отдельно от аутентификации по API-ключу, которая требуется для конечных точек протокола A2A для агентов.
Какие есть похожие проекты?JeecgBoot, evenfire, casdoor, AgenticResourceRegistry, spring-ai-alibaba, ruoyi-vue-pro, apisix, mall-swarm
Автор
shiyi25928988
Размер
9.7 MB
Звёзды
307
Обновлён
КоммитNov 12
Возраст
3 мес
Коммиты · 90 дней