Kom - Kubernetes Operations Manager

产品定位

Kom是一个Kubernetes操作管理工具，旨在简化Kubernetes资源的操作和管理，提供丰富的功能和易用的接口。

核心功能

1. 简单易用：提供创建、更新、删除、获取、列表等操作，支持内置资源和CRD资源的操作。
2. 多集群支持：通过RegisterCluster轻松管理多个Kubernetes集群。
3. MCP支持：支持多集群的MCP管理，支持stdio和sse两种模式，内置48种工具。
4. 跨命名空间查询：支持跨命名空间查询资源。
5. 链式调用：提供链式调用，使操作资源更加简单和直观。
6. 自定义资源定义（CRD）支持：轻松定义和操作自定义资源。
7. 回调机制：支持回调机制，轻松拓展业务逻辑。
8. Pod内文件操作：支持上传、下载、删除文件。
9. 高频操作封装：如Deployment的restart重启、scale扩缩容、启停等20余项操作功能。
10. SQL查询Kubernetes资源：支持使用SQL语句查询Kubernetes资源。
11. 查询缓存：在高频、批量查询场景下，可设置缓存过期时间，提升查询性能。

适用场景

1. Kubernetes资源管理：适用于需要频繁操作Kubernetes资源的场景。
2. 多集群管理：适用于需要管理多个Kubernetes集群的场景。
3. 自定义资源操作：适用于需要操作自定义资源定义（CRD）的场景。
4. Pod内文件操作：适用于需要在Pod内进行文件操作的场景。
5. 高频查询优化：适用于需要高频查询Kubernetes资源并优化性能的场景。

工具列表

Kom内置了49种工具，涵盖集群管理、部署管理、动态资源管理、节点管理、Pod管理、YAML管理、存储管理、Ingress管理等多个类别。具体工具列表如下：

使用教程

使用依赖

1. 确保已安装Go环境。
2. 确保已配置Kubernetes集群的kubeconfig文件。

安装教程

1. 导入Kom库：

import (
    "github.com/weibaohui/kom"
    "github.com/weibaohui/kom/callbacks"
)

1. 注册回调和集群：

func main() {
    // 注册回调，务必先注册
    callbacks.RegisterInit()
    // 注册集群
    defaultKubeConfig := os.Getenv("KUBECONFIG")
    if defaultKubeConfig == "" {
        defaultKubeConfig = filepath.Join(homedir.HomeDir(), ".kube", "config")
    }
    _, _ = kom.Clusters().RegisterInCluster()
    _, _ = kom.Clusters().RegisterByPathWithID(defaultKubeConfig, "default")
    kom.Clusters().Show()
    // 其他逻辑
}

调试方式

1. 启动MCP Server：

mcp.RunMCPServer("kom mcp server", "0.0.1", 9096)

1. 编译并运行：

go build main.go
./kom

1. 访问MCP Server：

http://IP:9096/sse

常见问题解答

1. 如何注册多个集群？ 使用kom.Clusters().RegisterByPathWithID方法注册多个集群。
2. 如何查询跨命名空间的资源？ 使用kom.Namespace("default","kube-system").List(&items)方法查询跨命名空间的资源。
3. 如何使用SQL查询Kubernetes资源？ 使用kom.DefaultCluster().Sql(sql).List(&list)方法执行SQL查询。
4. 如何操作Pod内的文件？ 使用kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().ContainerName("nginx").ListFiles("/etc")方法操作Pod内的文件。

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。