使用说明
项目简介
k8m 是一款 AI 驱动的迷你 Kubernetes 控制台,旨在简化 Kubernetes 集群的管理。它集成了 MCP 服务器,允许 LLM 客户端通过标准化的方式调用 Kubernetes 工具,实现智能化的集群管理和运维。
主要功能点
- Kubernetes 集群管理: 提供 Kubernetes 资源的可视化管理,包括 Pod、Deployment、Service 等,支持查看、编辑、删除等操作。
- AI 驱动功能: 内置 AI 能力,提供划词解释、资源指南、YAML 属性自动翻译、Describe 信息解读、日志 AI 问诊、运行命令推荐等智能化支持,辅助用户理解和操作 Kubernetes 资源。
- MCP 服务器集成: 内置 MCP 服务器功能,允许 LLM 客户端通过 MCP 协议连接,并调用预设的 Kubernetes 工具,实现通过大模型智能化管理 Kubernetes 集群。
- 多集群管理: 支持自动识别和纳管多个 Kubernetes 集群,方便用户在统一界面管理多个集群环境。
- Helm 集成: 集成 Helm 包管理器,支持 Helm Chart 的仓库管理、搜索、安装、升级和卸载,简化应用部署流程。
安装步骤
- 下载 k8m: 访问 GitHub仓库 下载适用于您操作系统的最新版本 k8m。
- 运行 k8m: 在终端中,导航到 k8m 可执行文件所在的目录,并运行 './k8m' 命令启动 k8m 控制台。默认情况下,k8m 将监听 '3618' 端口,您可以通过浏览器访问 'http://127.0.0.1:3618' 进入控制台。
服务器配置 (MCP Server)
k8m 内置了 MCP 服务器,无需额外安装,MCP 服务器默认会随 k8m 控制台一同启动。
对于需要连接 k8m 内置 MCP 服务器的 MCP 客户端,您需要配置 MCP 服务器的启动命令 (command) 及其参数 (args)。以下是一个 MCP 客户端配置示例 (JSON 格式):
{ "serverName": "k8m-mcp", "command": "./k8m", "args": [ "--mcp-server-port", "3619" ] }
参数注释:
- 'serverName': MCP 服务器名称,您可以自定义设置,用于在 MCP 客户端中标识不同的 MCP 服务器连接。
- 'command': MCP 服务器启动命令,这里使用 './k8m' 命令启动 k8m 控制台,同时也会启动内置的 MCP 服务器。
- 'args': 启动参数列表,用于配置 MCP 服务器的行为。
- '--mcp-server-port': MCP 服务器监听端口,默认为 '3619'。请确保此端口与 k8m 控制台的监听端口 '--port' (默认为 '3618') 不同,避免端口冲突。
基本使用方法
- 启动 k8m 控制台: 按照上述安装步骤启动 k8m 控制台,并通过浏览器访问 Web 界面。
- 连接 Kubernetes 集群: k8m 会自动识别和连接您的 Kubernetes 集群(InCluster 模式)或根据您配置的 kubeconfig 文件连接集群。
- 使用 Web 界面管理 Kubernetes: 通过 k8m 的 Web 界面,您可以浏览和管理 Kubernetes 资源,使用 AI 辅助功能提升管理效率。
- 配置 MCP 客户端连接: 在您的 MCP 客户端中,配置连接到 k8m 内置 MCP 服务器,使用上述提供的 JSON 配置示例,确保客户端能够通过 MCP 协议与 k8m 服务器通信,并调用 Kubernetes 工具。
信息
分类
开发者工具