English | 中文

k8m 是一款AI驱动的 Mini Kubernetes AI Dashboard 轻量级控制台工具，专为简化集群管理设计。它基于 AMIS（前端低代码框架）构建，并通过 kom 作为 Kubernetes API 客户端，k8m 内置了 Qwen2.5-Coder-7B，支持 deepseek-ai/DeepSeek-R1-Distill-Qwen-7B 模型交互能力，同时支持接入您自己的私有化大模型（包括 ollama）。

演示DEMO

DEMO
DEMO-InCluster模式
用户名密码 demo/demo

文档

• 详细的配置和使用说明请参考文档。
• 更新日志请参考更新日志。
• 开发设计文档-中文
• 开发设计文档-English

主要特点

• 迷你化设计：所有功能整合在一个单一的可执行文件中，部署便捷，使用简单。
• 简便易用：友好的用户界面和直观的操作流程，让 Kubernetes 管理更加轻松。支持标准 k8s、AWS EKS、k3s、kind、k0s 等集群类型。
• 高效性能：后端采用 Golang 构建，前端基于百度 AMIS，保证资源利用率高、响应速度快。
• AI驱动融合 ：基于 ChatGPT 实现划词解释、资源指南、YAML 属性自动翻译、Describe 信息解读、日志 AI 问诊、运行命令推荐，并集成了 k8s-gpt 功能，实现中文展现，为管理 k8s 提供智能化支持。
• 功能插件化：特性功能插件化，按需开启，不开启不占资源。
• MCP集成: 可视化管理 MCP（Model Context Protocol），实现大模型调用 Tools，内置 k8s 多集群 MCP 工具 49 种，可组合实现超百种集群操作，可作为 MCP Server 供其他大模型软件使用。轻松实现大模型管理 k8s。可详细记录每一次 MCP 调用。支持 mcp.so 主流服务。
• MCP权限打通: 多集群管理权限与 MCP 大模型调用权限打通，一句话概述：谁使用大模型，就用谁的权限执行 MCP。安全使用，无后顾之忧，避免操作越权。
• 多集群管理：自动识别集群内部使用 InCluster 模式，配置 kubeconfig 路径后自动扫描同级目录下的配置文件，同时注册管理多个集群，支持心跳检测与自动重连。
• 多集群权限管理：支持对用户、用户组进行授权，可按集群授权，包括集群只读、Exec 命令、集群管理员三种权限。对用户组授权后，组内用户均获得相应授权。支持设置命名空间黑白名单。
• 支持k8s最新特性: 支持 APIGateway、OpenKruise 等功能特性。
• Pod文件管理：在 Console 界面左侧的文件树，右键菜单，支持 Pod 内文件的浏览、编辑、上传、下载、删除，简化日常操作。
• Pod运行管理：支持实时查看 Pod 日志，下载日志，并在 Pod 内直接执行 Shell 命令。支持 Ctrl+F 搜索，类似 grep -A -B 高亮搜索。
• API开放: 支持创建 API KEY，从第三方外部访问，提供 swagger 接口管理页面。
• 集群巡检支持：支持多集群定时巡检、自定义巡检规则，支持 Lua 脚本规则。支持发送到钉钉群、微信群、飞书群以及自定义 webhook。支持 AI 总结。
• k8s Event转发：支持多集群 k8s Event 转发到 webhook 中，可按集群、关键字、命名空间、名称等进行过滤，建立多个专门的监控转发通道。支持 AI 总结。
• CRD管理：可自动发现并管理 CRD（Custom Resource Definition）资源，树状列出所有 CRD，提高工作效率。
• Helm市场：支持 Helm 自由添加仓库，一键安装、卸载、升级 Helm 应用，支持自动更新。
• 跨平台支持：兼容 Linux、macOS 和 Windows，并支持 x86、ARM 等多种架构，确保多平台无缝运行。
• 多数据库支持：支持 SQLite、MySQL、PostgreSQL 等多种数据库。
• 完全开源：开放所有源码，无任何限制，可自由定制和扩展，可商业使用。

k8m 的设计理念是"AI驱动，轻便高效，化繁为简"，它帮助开发者和运维人员快速上手，轻松管理 Kubernetes 集群。

运行

1. 下载：从 GitHub release 下载最新版本。
2. 运行：使用 ./k8m 命令启动，访问 http://127.0.0.1:3618。
3. 登录用户名密码：
   • 用户名：k8m
   • 密码：k8m
   • 请注意上线后修改用户名密码、启用两步验证。
4. 参数：

Usage of ./k8m:
      --enable-temp-admin                是否启用临时管理员账户配置，默认关闭
      --admin-password string            管理员密码，启用临时管理员账户配置后生效 
      --admin-username string            管理员用户名，启用临时管理员账户配置后生效
      --print-config                     是否打印配置信息 (default false)
      --connect-cluster                  启动集群是是否自动连接现有集群，默认关闭
  -d, --debug                            调试模式
      --in-cluster                       是否自动注册纳管宿主集群，默认启用
      --jwt-token-secret string          登录后生成JWT token 使用的Secret (default "your-secret-key")
  -c, --kubeconfig string                kubeconfig文件路径 (default "/root/.kube/config")
      --kubectl-shell-image string       Kubectl Shell 镜像。默认为 bitnami/kubectl:latest，必须包含kubectl命令 (default "bitnami/kubectl:latest")
      --log-v int                        klog的日志级别klog.V(2) (default 2)
      --login-type string                登录方式，password, oauth, token等,default is password (default "password")
      --image-pull-timeout               Node Shell、Kubectl Shell 镜像拉取超时时间。默认为 30 秒
      --node-shell-image string          NodeShell 镜像。 默认为 alpine:latest，必须包含`nsenter`命令 (default "alpine:latest")
  -p, --port int                         监听端口 (default 3618)
  -v, --v Level                          klog的日志级别 (default 2)

也可以直接通过 docker-compose（推荐）启动：

services:
  k8m:
    container_name: k8m
    image: registry.cn-hangzhou.aliyuncs.com/minik8m/k8m
    restart: always
    ports:
      - "3618:3618"
    environment:
      TZ: Asia/Shanghai
    volumes:
      - ./data:/app/data

启动之后，访问3618端口，默认用户：k8m，默认密码k8m。
如果你想通过在线环境快速拉起体验，可以访问：k8m

容器化k8s集群方式运行

使用 KinD、MiniKube
安装一个小型 k8s 集群

KinD 方式

• 安装 KinD（Kubernetes in Docker）工具：

brew install kind

• 创建新的 Kubernetes 集群：

kind create cluster --name k8sgpt-demo

将 k8m 部署到集群中体验

安装脚本

kubectl apply -f https://raw.githubusercontent.com/weibaohui/k8m/refs/heads/main/deploy/k8m.yaml

• 访问方式：
  默认使用了 NodePort 暴露服务，请访问 31999 端口。您也可以自行配置 Ingress。
  http://NodePortIP:31999

生产部署启用主备选举插件，注意事项

• 单实例运行时，Service 的定义不要添加 k8m.io/role: leader 标签，否则将无法正常访问。
• 多实例运行时，Service 的定义必须添加 k8m.io/role: leader 标签，否则不会触发主备切换。
• 多实例运行的 YAML 文件如下：

kubectl apply -f https://raw.githubusercontent.com/weibaohui/k8m/refs/heads/main/deploy/k8m-ms.yaml

ChatGPT 配置指南

内置 GPT

从 v0.0.8 版本开始，已内置 GPT，无需额外配置。
如果您希望使用自己的 GPT 模型，请参考以下文档。

• 自托管/自定义大模型支持 - 如何使用自托管的大模型
• Ollama 配置 - 如何配置使用 Ollama 大模型。

ChatGPT 状态调试

如果设置参数后仍无效果，请尝试使用 ./k8m -v 6 获取更详细的调试信息。
日志中会输出相关信息，通过查看日志可确认 ChatGPT 是否已成功启用。

开发调试

如果您想在本地进行开发调试，请先执行一次本地前端构建，以自动生成 dist 目录。因为本项目采用二进制嵌入前端资源的方式，若缺少 dist 目录，程序会报错。

第一步：编译前端

cd ui
pnpm run build

编译并调试后端

# 下载依赖
go mod tidy
# 运行（使用 air 实现热重载）
air
# 或者直接运行
go run *.go 
# 默认监听 localhost:3618 端口

前端热加载

cd ui
pnpm run dev
# Vite 服务将监听在 localhost:3000 端口
# Vite 会将后端请求代理到 3618 端口

访问 http://localhost:3000

HELP & SUPPORT

如果您有任何进一步的问题或需要额外的帮助，请随时与我联系！

特别鸣谢

zhaomingcheng01：提出了诸多非常高质量的建议，为 k8m 的易用性做出了卓越贡献~

La0jin：提供在线资源及维护，极大提升了 k8m 的展示效果

eryajf：为我们提供了非常好用的 GitHub Actions，为 k8m 增加了自动化的发版、构建、发布等功能

联系我

微信（大罗马的太阳） 搜索 ID：daluomadetaiyang，备注 k8m。

微信群

k8m 快速上手指南

环境准备

• 操作系统：Linux / macOS / Windows
• 架构支持：x86 / ARM
• 前置依赖（可选）：
  • 若使用本地 kubeconfig 管理集群，需已配置好 ~/.kube/config
  • 若通过 Docker 运行，需安装 Docker 或 Docker Compose
• 推荐国内加速：
  • Docker 镜像源使用阿里云镜像：registry.cn-hangzhou.aliyuncs.com/minik8m/k8m

安装步骤

方式一：直接下载二进制（推荐）

# 下载最新版本（以 Linux x86 为例）
wget https://github.com/weibaohui/k8m/releases/latest/download/k8m-linux-amd64
chmod +x k8m-linux-amd64
mv k8m-linux-amd64 /usr/local/bin/k8m

方式二：使用 Docker Compose（推荐用于生产）

# docker-compose.yml
services:
  k8m:
    container_name: k8m
    image: registry.cn-hangzhou.aliyuncs.com/minik8m/k8m
    restart: always
    ports:
      - "3618:3618"
    environment:
      TZ: Asia/Shanghai
    volumes:
      - ./data:/app/data

启动服务：

docker-compose up -d

方式三：部署到 Kubernetes 集群（InCluster 模式）

kubectl apply -f https://raw.githubusercontent.com/weibaohui/k8m/refs/heads/main/deploy/k8m.yaml

访问地址：http://<NodeIP>:31999

基本使用

1. 启动 k8m：

   # 二进制方式
   ./k8m
   
   # 默认监听 3618 端口
   

2. 访问 Web 控制台：

   http://127.0.0.1:3618
   

3. 使用默认账号登录：

   • 用户名：k8m
   • 密码：k8m

4. 自动纳管当前 kubeconfig 中的集群（若存在），或在界面中手动添加集群。

⚠️ 首次上线后请立即修改默认密码并启用两步验证。