mcpField
K
Kom - Kubernetes Operations Manager

Kom - Kubernetes Operations Manager

ローカル
github.comクラウド・インフラ15111 週間前に更新
リポジトリ公式サイト

Kom - Kubernetes Operations Manager について

kom は、kubectl と client-go を SDK レベルでラップした Kubernetes 操作ツールで、k8s を管理する MCP サーバーとしても動作します。Go のコードや MCP クライアントからクラスターリソースを管理したい開発者や運用担当者を対象としています。

主な機能

  1. 01リソースの CRUD、Pod ログ取得、Pod 内ファイル操作
  2. 02組み込みリソースと CRD への対応
  3. 03AWS EKS を含む複数クラスターの登録
  4. 04SQL 文による k8s リソースの検索
  5. 05stdio と SSE の両モードに対応した MCP サーバー

活用シーン

  1. 01MCP クライアントからの複数の Kubernetes クラスターの管理
  2. 02Go プログラムでのチェーン呼び出しによるクラスターリソースの操作
  3. 03SQL 文を使った Pod などのフィルタリングとページング

MCP 対応

kom は MCP サーバーとして動作し、クラスター、Deployment、Pod、ノード、ストレージ、YAML などの操作をカバーする約 59 種のツールを MCP クライアントに公開します。

#sdk#sql#mcp#cluster#k8s#kubectl#client-go#kom#crd

設定

ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。

インストール方法は未掲載です

このサーバーのパッケージやリモートエンドポイントはまだ取得できていません。プロジェクトの README の手順に従ってください。

リポジトリ

ツール

ツール一覧はまだ取得されていません

ローカルサーバーのツールはマシン上で起動して初めて取得できます。メンテナーはまだツール一覧を提供していません。

詳細

Kom - Kubernetes 運用管理ツール

英語 | 中文 kom FOSSA Status

概要

kom は Kubernetes 操作用のツールで、SDK レベルの kubectl、client-go の利用をラップしたものに相当します。 Kubernetes リソースを作成、更新、削除、取得するなど、管理するためのさまざまな機能を提供します。このプロジェクトは、さまざまな Kubernetes リソースタイプの操作に対応しており、カスタムリソース定義（CRD）も扱えます。 kom を使うことで、リソースの作成、削除、更新、取得、ログの取得、POD 内のファイル操作などを簡単に実行でき、SQL 文を使って k8s リソースをクエリ、管理することもできます。

特徴

  1. 簡単に使用できます：kom は、組み込みリソースや CRD リソースの操作を含め、作成、更新、削除、取得、一覧表示など、豊富な機能を提供します。
  2. マルチクラスターに対応：RegisterCluster を使って、複数の Kubernetes クラスターを簡単に管理できます。AWS EKS クラスターにも対応しています。
  3. MCP に対応：複数クラスターの MCP 管理に対応し、stdio と sse の両方のモードをサポートします。58 種類のツールを内蔵し、SSE モード、プライベートデプロイ、複数ユーザーでの共有に対応しています。100 種類を超える組み合わせ操作をサポートします。
  4. 複数の名前空間に対応：kom.Namespace("default","kube-system").List(&items) を使って、複数の名前空間をまたいでリソースをクエリできます。
  5. メソッドチェーンに対応：kom はメソッドチェーンを提供し、リソースをより簡単かつ直感的に操作できます。
  6. カスタムリソース定義（CRD）に対応：kom はカスタムリソース定義（CRD）に対応しており、カスタムリソースを簡単に定義、操作できます。
  7. コールバック機構に対応し、k8s 操作と強く結合することなく、ビジネスロジックを簡単に拡張できます。
  8. POD 内のファイル操作に対応し、ファイルのアップロード、ダウンロード、削除を簡単に行えます。
  9. 高頻度の操作をラップした機能に対応しています。deployment の restart、scale、起動・停止など、20 種類以上の操作機能を提供します。
  10. SQL による k8s リソースのクエリに対応しています。select * from pod where metadata.namespace='kube-system' or metadata.namespace='default' order by metadata.creationTimestamp desc
  11. クエリキャッシュに対応しています。高頻度または一括クエリのシナリオでは、キャッシュの有効期限を設定してクエリ性能を向上できます。リストのフィルター条件はキャッシュの影響を受けません。
  12. Prometheus クエリに対応しています。クラスター内の Prometheus サービスまたは外部の Prometheus アドレスを使ったモニタリングデータのクエリに対応し、瞬時クエリと範囲クエリをサポートします。また、複数の結果解析方法を提供します。

サンプルプログラム

k8m は軽量な Kubernetes 管理ツールです。kom と amis をベースに実装されており、単一ファイルで、複数のプラットフォームアーキテクチャに対応しています。

  1. ダウンロード：https://github.com/weibaohui/k8m から最新バージョンをダウンロードします。
  2. 実行：./k8m コマンドで起動し、http://127.0.0.1:3618 にアクセスします。

インストール

import (
    "github.com/weibaohui/kom"
    "github.com/weibaohui/kom/callbacks"
)
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()
	// 其他逻辑
}

使用例

0. マルチクラスター k8s MCP 対応

stdio と sse の両方のモードに対応しています。 複数の tools に対応しています。任意のリソースのクエリ、一覧表示、削除、説明操作、および POD ログの読み取り操作が含まれます。

1. コードに統合する
// 一行代码启动MCP Server
mcp.RunMCPServer("kom mcp server", "0.0.1", 9096)
2. コンパイルする
# 源码启动
go build main.go 
//编译为kom
3. 起動する

起動後は、stdio と sse の 2 つのモードに対応します。 k8s の管理には、デフォルトで KUBECONFIG env 環境変数を使用します。

# 设置KUBECONFIG环境变量
export KUBECONFIG = /Users/xxx/.kube/config

# 运行
./kom 
# MCP Server 访问地址
http://IP:9096/sse

この時点で、コンパイルして得られたバイナリファイルは stdio モードとして使用できます。 http://IP:9096/sse モードは、sse モードとして使用できます。

4. MCP ツールに統合する

stdio と sse の 2 つの方法で統合できます。 Cursor、Claude Desktop（stdio モードのみ対応）、Windsurf などの MCP ツールへの統合に適しています。また、これらのソフトウェアの UI 操作画面から追加することもできます。

{
  "mcpServers": {
    "kom": {
      "type": "sse",
      "url": "http://IP:9096/sse"
    }
  }
}

{
    "mcpServers": {
        "k8m": {
            "command": "path/to/kom",
            "args": []
        }
    }
}
MCP ツール一覧（59 種類）
类别方法描述
集群管理（1）list_k8s_clusters列出所有已注册的Kubernetes集群
DaemonSet管理（1）restart_k8s_daemonset通过集群、命名空间和名称,重启DaemonSet
部署管理（12）scale_k8s_deployment通过集群、命名空间、名称 扩缩容Deployment，设置副本数
restart_k8s_deployment通过集群、命名空间和名称,重启Deployment
stop_k8s_deployment停止Deployment
restore_k8s_deployment恢复Deployment副本数
update_k8s_deployment_image_tag更新Deployment中容器的镜像Tag
get_k8s_deployment_rollout_history查询升级历史
undo_k8s_deployment_rollout回滚
pause_k8s_deployment_rollout暂停升级
resume_k8s_deployment_rollout恢复升级
get_k8s_deployment_rollout_status查询升级状态
get_k8s_deployment_hpa_list查询Deployment的HPA列表
list_k8s_deploy_event列出Deployment相关的事件
动态资源管理(含CRD，8)get_k8s_resource通过集群、命名空间和名称获取Kubernetes资源详情
describe_k8s_resource通过集群、命名空间和名称获取Kubernetes资源详情
delete_k8s_resource通过集群、命名空间和名称删除Kubernetes资源
list_k8s_resource按集群和资源类型列出Kubernetes资源
annotate_k8s_resource为Kubernetes资源添加或删除注解
label_k8s_resource为Kubernetes资源添加或删除标签
patch_k8s_resource通过集群、命名空间和名称更新Kubernetes资源
GetDynamicResource获取动态资源
节点管理（11）taint_k8s_node为节点添加污点
untaint_k8s_node为节点移除污点
cordon_k8s_node设置节点为不可调度状态
uncordon_k8s_node设置节点为可调度状态
drain_k8s_node清空节点上的Pod并防止新的Pod调度
get_k8s_node_ip_usage查询节点IP资源使用情况
list_k8s_node获取Node列表
get_k8s_top_node获取Node节点CPU和内存资源用量排名列表
get_k8s_pod_count_running_on_node查询某个节点上运行的Pod数量统计
get_k8s_node_resource_usage查询节点资源使用情况统计
TaintNodeTool为节点添加污点
事件管理（1）list_k8s_event按集群和命名空间列出Kubernetes事件
Ingress管理（1）set_default_k8s_ingressclass设置IngressClass为默认
Pod 管理（18）run_command_in_k8s_pod在Pod内执行命令
list_k8s_pod_event列出Pod相关的事件
list_files_in_k8s_pod获取Pod中指定路径下的文件列表
list_pod_all_files获取Pod中指定路径下的所有文件列表，包含子目录
delete_k8s_pod删除Pod
delete_pod_file删除Pod中的指定文件
get_k8s_pod_linked_env获取Pod运行时的环境变量信息
get_pod_linked_env_from_yaml通过Pod yaml 定义 获取Pod定义中的环境变量信息
get_k8s_pod_linked_services获取与Pod关联的Service
get_pod_linked_ingresses获取与Pod关联的Ingress
get_pod_linked_endpoints获取与Pod关联的Endpoints
list_k8s_pod获取Pod列表
get_k8s_top_pod获取Pod CPU 内存 资源用量排名 列表
ListPodFilesTool列出Pod文件
ListAllPodFilesTool列出Pod所有文件
DeletePodFileTool删除Pod文件
UploadPodFileTool上传Pod文件
GetPodLogsTool获取Pod日志
describe_k8s_pod描述Pod容器组
存储管理（3）set_k8s_default_storageclass设置StorageClass为默认
get_k8s_storageclass_pvc_count获取StorageClass下的PVC数量
get_k8s_storageclass_pv_count获取StorageClass下的PV数量
YAML管理（2）apply_k8s_yaml通过YAML创建或更新Kubernetes资源
delete_k8s_yaml通过YAML删除Kubernetes资源
启动命令
mcp.RunMCPServer("kom mcp server", "0.0.1", 3619)
AI工具集成
Claude Desktop
  1. 打开Claude Desktop设置面板
  2. 在API配置区域添加MCP Server地址
  3. 启用SSE事件监听功能
  4. 验证连接状态
{
  "mcpServers": {
    "k8m": {
      "command": "path/to/kom",
      "args": []
    }
  }
}
Cursor
  1. 进入Cursor设置界面
  2. 找到扩展服务配置选项
  3. 支持sse、stdio两种方式。sse 方式填写http://localhost:9096/sse,stdio方式填写kom的文件位置。
Windsurf
  1. 访问配置中心
  2. 设置API服务器地址
  3. 支持sse、stdio两种方式。sse 方式填写http://localhost:9096/sse,stdio方式填写kom的文件位置。
cherry studio
  1. 点击左下角设置
  2. 点击MCP 服务器
  3. 点击添加服务器
  4. 支持sse、stdio两种方式。sse 方式填写http://localhost:9096/sse,stdio方式填写kom的文件位置。
1. 多集群管理
注册多集群
// 注册InCluster集群，名称为InCluster
kom.Clusters().RegisterInCluster()
// 注册两个带名称的集群,分别名为orb和docker-desktop
kom.Clusters().RegisterByPathWithID("/Users/kom/.kube/orb", "orb")
kom.Clusters().RegisterByPathWithID("/Users/kom/.kube/config", "docker-desktop")
// 注册一个名为default的集群，那么kom.DefaultCluster()则会返回该集群。
kom.Clusters().RegisterByPathWithID("/Users/kom/.kube/config", "default")
注册AWS EKS集群
// 配置 EKS 集群信息
config := aws.EKSAuthConfig{
    AccessKey:       "XXX",        // AWS Access Key ID
    SecretAccessKey: "yyy",        // AWS Secret Access Key
    Region:          "us-east-1",  // AWS 区域
    ClusterName:     "k8m",        // EKS 集群名称
}

// 注册 AWS EKS 集群
_, err := kom.Clusters().RegisterAWSCluster(config)
if err != nil {
    fmt.Printf("注册 EKS 集群失败: %v", err)
    return
}

// 使用注册的 EKS 集群
var pods []corev1.Pod
clusterID := fmt.Sprintf("%s-%s", config.Region, config.ClusterName) // 集群ID格式: {Region}-{ClusterName}
err = kom.Cluster(clusterID).Resource(&corev1.Pod{}).Namespace("kube-system").List(&pods).Error

AWS EKS 集群注册说明：

  • AccessKey: AWS 访问密钥 ID
  • SecretAccessKey: AWS 秘密访问密钥
  • Region: AWS 区域，如 us-east-1、ap-southeast-1 等
  • ClusterName: EKS 集群名称
  • RoleARN: (可选) 要承担的 IAM 角色 ARN，用于跨账户访问
  • 集群注册后会自动生成 ID，格式为 {Region}-{ClusterName}
  • 支持 IAM 角色承担机制实现跨账户集群访问
  • AWS 凭证信息仅在内存中使用，程序重启后自动清理
显示已注册集群
kom.Clusters().Show()
选择默认集群
// 使用默认集群,查询集群内kube-system命名空间下的pod
// 首先尝试返回 ID 为 "InCluster" 的实例，如果不存在，
// 则尝试返回 ID 为 "default" 的实例。
// 如果上述两个名称的实例都不存在，则返回 clusters 列表中的任意一个实例。
var pods []corev1.Pod
err = kom.DefaultCluster().Resource(&corev1.Pod{}).Namespace("kube-system").List(&pods).Error
选择指定集群
// 选择orb集群,查询集群内kube-system命名空间下的pod
var pods []corev1.Pod
err = kom.Cluster("orb").Resource(&corev1.Pod{}).Namespace("kube-system").List(&pods).Error
2. 内置资源对象的增删改查以及Watch示例

定义一个 Deployment 对象，并通过 kom 进行资源操作。

var item v1.Deployment
var items []v1.Deployment
创建某个资源
item = v1.Deployment{
		ObjectMeta: metav1.ObjectMeta{
			Name:      "nginx",
			Namespace: "default",
		},
		Spec: v1.DeploymentSpec{
			Template: corev1.PodTemplateSpec{
				Spec: corev1.PodSpec{
					Containers: []corev1.Container{
						{Name: "test", Image: "nginx:1.14.2"},
					},
				},
			},
		},
	}
err := kom.DefaultCluster().Resource(&item).Create(&item).Error
Get查询某个资源
// 查询 default 命名空间下名为 nginx 的 Deployment
err := kom.DefaultCluster().Resource(&item).Namespace("default").Name("nginx").Get(&item).Error
// 查询 default 命名空间下名为 nginx 的 Deployment，并使用缓存 5 秒
// 5秒内，不会再次查询，批量操作、高频操作下，建议启用缓存
err := kom.DefaultCluster().Resource(&item).Namespace("default").Name("nginx").WithCache(5 * time.Second).Get(&item).Error
List查询资源列表
// 查询 default 命名空间下的 Deployment 列表
err := kom.DefaultCluster().Resource(&item).Namespace("default").List(&items).Error
// 查询 default、kube-system 命名空间下的 Deployment 列表
err := kom.DefaultCluster().Resource(&item).Namespace("default","kube-system").List(&items).Error
// 查询 所有 命名空间下的 Deployment 列表
err := kom.DefaultCluster().Resource(&item).Namespace("*").List(&items).Error
err := kom.DefaultCluster().Resource(&item).AllNamespace().List(&items).Error
// 设置5秒缓存，对列表生效
err := kom.DefaultCluster().Resource(&item).WithCache(5 * time.Second).List(&nodeList).Error
通过Label查询资源列表
// 查询 default 命名空间下 标签为 app:nginx 的 Deployment 列表
err := kom.DefaultCluster().Resource(&item).Namespace("default").WithLabelSelector("app=nginx").List(&items).Error
通过多个Label查询资源列表
// 查询 default 命名空间下 标签为 app:nginx m:n 的 Deployment 列表
err := kom.DefaultCluster().Resource(&item).Namespace("default").WithLabelSelector("app=nginx").WithLabelSelector("m=n").List(&items).Error
通过Field查询资源列表
// 查询 default 命名空间下 标签为 metadata.name=test-deploy 的 Deployment 列表
// filedSelector 一般支持原生的字段定义。如metadata.name,metadata.namespace,metadata.labels,metadata.annotations,metadata.creationTimestamp,spec.nodeName,spec.serviceAccountName,spec.schedulerName,status.phase,status.hostIP,status.podIP,status.qosClass,spec.containers.name等字段
err := kom.DefaultCluster().Resource(&item).Namespace("default").WithFieldSelector("metadata.name=test-deploy").List(&items).Error
分页查询资源
var list []corev1.Pod
var total int64
sql := "select * from pod where metadata.namespace=? or metadata.namespace=?     order by  metadata.creationTimestamp desc "
err := kom.DefaultCluster().Sql(sql, "kube-system", "default").
		FillTotalCount(&total).
		Limit(5).
		Offset(10).
		List(&list).Error
fmt.Printf("total %d\n", total)  //返回总数 480
fmt.Printf("Count %d\n", len(list)) //返回条目数=limit=5
更新资源内容
// 更新名为nginx 的 Deployment，增加一个注解
err := kom.DefaultCluster().Resource(&item).Namespace("default").Name("nginx").Get(&item).Error
if item.Spec.Template.Annotations == nil {
	item.Spec.Template.Annotations = map[string]string{}
}
item.Spec.Template.Annotations["kom.kubernetes.io/restartedAt"] = time.Now().Format(time.RFC3339)
err = kom.DefaultCluster().Resource(&item).Update(&item).Error
PATCH 更新资源
// 使用 Patch 更新资源,为名为 nginx 的 Deployment 增加一个标签，并设置副本数为5
patchData := `{
    "spec": {
        "replicas": 5
    },
    "metadata": {
        "labels": {
            "new-label": "new-value"
        }
    }
}`
err := kom.DefaultCluster().Resource(&item).Patch(&item, types.StrategicMergePatchType, patchData).Error
删除资源
// 删除名为 nginx 的 Deployment
err := kom.DefaultCluster().Resource(&item).Namespace("default").Name("nginx").Delete().Error
强制删除资源
// 删除名为 nginx 的 Deployment
err := kom.DefaultCluster().Resource(&item).Namespace("default").Name("nginx").ForceDelete().Error
通用类型资源的获取（适用于k8s内置类型以及CRD）
// 指定GVK获取资源
var list []corev1.Event
err := kom.DefaultCluster().GVK("events.k8s.io", "v1", "Event").Namespace("default").List(&list).Error
Watch资源变更
// watch default 命名空间下 Pod资源 的变更
var watcher watch.Interface
var pod corev1.Pod
err := kom.DefaultCluster().Resource(&pod).Namespace("default").Watch(&watcher).Error
if err != nil {
	fmt.Printf("Create Watcher Error %v", err)
	return err
}
go func() {
	defer watcher.Stop()

	for event := range watcher.ResultChan() {
		err := kom.DefaultCluster().Tools().ConvertRuntimeObjectToTypedObject(event.Object, &pod)
		if err != nil {
			fmt.Printf("无法将对象转换为 *v1.Pod 类型: %v", err)
			return
		}
		// 处理事件
		switch event.Type {
		case watch.Added:
			fmt.Printf("Added Pod [ %s/%s ]\n", pod.Namespace, pod.Name)
		case watch.Modified:
			fmt.Printf("Modified Pod [ %s/%s ]\n", pod.Namespace, pod.Name)
		case watch.Deleted:
			fmt.Printf("Deleted Pod [ %s/%s ]\n", pod.Namespace, pod.Name)
		}
	}
}()
Describe查询某个资源
// Describe default 命名空间下名为 nginx 的 Deployment
var describeResult []byte
err := kom.DefaultCluster().Resource(&item).Namespace("default").Name("nginx").Describe(&item).Error
fmt.Printf("describeResult: %s", describeResult)
3. YAML 创建、更新、删除
yaml := `apiVersion: v1
kind: ConfigMap
metadata:
  name: example-config
  namespace: default
data:
  key: value
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: example-deployment
  namespace: default
spec:
  replicas: 1
  selector:
    matchLabels:
      app: example
  template:
    metadata:
      labels:
        app: example
    spec:
      containers:
        - name: example-container
          image: nginx
`
// 第一次执行Apply为创建，返回每一条资源的执行结果 
results := kom.DefaultCluster().Applier().Apply(yaml)
// 第二次执行Apply为更新，返回每一条资源的执行结果
results = kom.DefaultCluster().Applier().Apply(yaml)
// 删除，返回每一条资源的执行结果
results = kom.DefaultCluster().Applier().Delete(yaml)
4. Pod 操作
获取日志
// 获取Pod日志
var stream io.ReadCloser
err := kom.DefaultCluster().Namespace("default").Name("random-char-pod").Ctl().Pod().ContainerName("container").GetLogs(&stream, &corev1.PodLogOptions{}).Error
reader := bufio.NewReader(stream)
line, _ := reader.ReadString('\n')
fmt.Println(line)
执行命令

在Pod内执行命令，需要指定容器名称，并且会触发Exec()类型的callbacks。

// 在Pod内执行ps -ef命令
var execResult string
err := kom.DefaultCluster().Namespace("default").Name("random-char-pod").Ctl().Pod().ContainerName("container").Command("ps", "-ef").ExecuteCommand(&execResult).Error
fmt.Printf("execResult: %s", execResult)
端口转发
err := kom.DefaultCluster().Resource(&v1.Pod{}).
		Namespace("default").
		Name("nginx-deployment-f576985cc-7czqr").
    Ctl().Pod().
		ContainerName("nginx").
		PortForward("20088", "80", stopCh).Error
// 监听0.0.0.0上的20088端口，转发到Pod的80端口
流式执行命令

在Pod内执行命令，并且会触发StreamExec()类型的callbacks。适合执行ping 等命令

cb := func(data []byte) error {
		fmt.Printf("Data %s\n", string(data))
		return nil
	}
err := kom.DefaultCluster().Namespace("kube-system").Name("traefik-d7c9c5778-p9nf4").Ctl().Pod().ContainerName("traefik").Command("ping", "127.0.0.1").StreamExecute(cb, cb).Error
//输出：
//Data PING 127.0.0.1 (127.0.0.1): 56 data bytes
//Data 64 bytes from 127.0.0.1: seq=0 ttl=42 time=0.023 ms
//Data 64 bytes from 127.0.0.1: seq=1 ttl=42 time=0.011 ms
//Data 64 bytes from 127.0.0.1: seq=2 ttl=42 time=0.012 ms
//Data 64 bytes from 127.0.0.1: seq=3 ttl=42 time=0.016 ms
文件列表
// 获取Pod内/etc文件夹列表
kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().ContainerName("nginx").ListFiles("/etc")
所有文件列表，包括隐藏文件
// 获取Pod内/etc文件夹列表
kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().ContainerName("nginx").ListAllFiles("/etc")
文件下载
// 下载Pod内/etc/hosts文件
kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().ContainerName("nginx").DownloadFile("/etc/hosts")
文件下载(Tar压缩)
// 下载Pod内/etc/hosts文件，以tar方式进行打包后，获取，下载
kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().ContainerName("nginx").DownloadTarFile("/etc/hosts")
文件上传
// 上传文件内容到Pod内/etc/demo.txt文件
kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().ContainerName("nginx").SaveFile("/etc/demo.txt", "txt-context")
// os.File 类型文件直接上传到Pod内/etc/目录下
file, _ := os.Open(tempFilePath)
kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().ContainerName("nginx").UploadFile("/etc/", file)
文件删除
// 删除Pod内/etc/xyz文件
kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().ContainerName("nginx").DeleteFile("/etc/xyz")
获取关联资源-Service
// 获取Pod关联的Service
svcs, err := kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().LinkedService()
for _, svc := range svcs {
	fmt.Printf("service name %v\n", svc.Name)
}
获取关联资源-Ingress
// 获取Pod关联的Ingress
ingresses, err := kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().LinkedIngress()
for _, ingress := range ingresses {
	fmt.Printf("ingress name %v\n", ingress.Name)
}
获取关联资源-PVC
// 获取Pod关联的PVC
pvcs, err := kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().LinkedPVC()
for _, pvc := range pvcs {
	fmt.Printf("pvc name %v\n", pvc.Name)
}
获取关联资源-PV
// 获取Pod关联的PVC
pvs, err := kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().LinkedPV()
for _, pv := range pvs {
	fmt.Printf("pv name %v\n", pv.Name)
}
获取关联资源-Endpoints
// 获取Pod关联的Endpoints
endpoints, err := kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().LinkedEndpoints()
for _, endpoint := range endpoints {
	fmt.Printf("endpoint name %v\n", endpoint.Name)
}
获取关联资源-运行时Env

从Pod内执行env命令获得ENV配置信息

envs, err := kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().LinkedEnv()
for _, env := range envs {
		fmt.Printf("env %s %s=%s\n", env.ContainerName, env.EnvName, env.EnvValue)
	}
获取关联资源-定义Env

从pod定义上提取ENV配置信息

envs, err := kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().LinkedEnvFromPod()
for _, env := range envs {
		fmt.Printf("env %s %s=%s\n", env.ContainerName, env.EnvName, env.EnvValue)
	}
获取关联资源-节点

根据Pod 定义中声明的NodeSelector、NodeAffinity、污点容忍度、NodeName等配置信息，返回可用节点列表。暂未考虑Pod亲和性、CPU内存等运行时调度因素。

nodes, err := kom.DefaultCluster().Namespace("default").Name("nginx").Ctl().Pod().LinkedNode()
for _, node := range nodes {
    fmt.Printf("reason:%s\t node name %s\n", node.Reason, node.Name)
}
5. 自定义资源定义（CRD）增删改查及Watch操作

在没有CR定义的情况下，如何进行增删改查操作。操作方式同k8s内置资源。 将对象定义为unstructured.Unstructured，并且需要指定Group、Version、Kind。 因此可以通过kom.DefaultCluster().GVK(group, version, kind)来替代kom.DefaultCluster().Resource(interface{}) 为方便记忆及使用，kom提供了kom.DefaultCluster().CRD(group, version, kind)来简化操作。 下面给出操作CRD的示例： 首先定义一个通用的处理对象，用来接收CRD的返回结果。

var item unstructured.Unstructured
创建CRD
yaml := `apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: crontabs.stable.example.com
spec:
  group: stable.example.com
  versions:
    - name: v1
      served: true
      storage: true
      schema:
        openAPIV3Schema:
          type: object
          properties:
            spec:
              type: object
              properties:
                cronSpec:
                  type: string
                image:
                  type: string
                replicas:
                  type: integer
  scope: Namespaced
  names:
    plural: crontabs
    singular: crontab
    kind: CronTab
    shortNames:
    - ct`
result := kom.DefaultCluster().Applier().Apply(yaml)
创建CRD的CR对象
item = unstructured.Unstructured{
		Object: map[string]interface{}{
			"apiVersion": "stable.example.com/v1",
			"kind":       "CronTab",
			"metadata": map[string]interface{}{
				"name":      "test-crontab",
				"namespace": "default",
			},
			"spec": map[string]interface{}{
				"cronSpec": "* * * * */8",
				"image":    "test-crontab-image",
			},
		},
	}
err := kom.DefaultCluster().CRD("stable.example.com", "v1", "CronTab").Namespace(item.GetNamespace()).Name(item.GetName()).Create(&item).Error
Get获取单个CR对象
err := kom.DefaultCluster().CRD("stable.example.com", "v1", "CronTab").Name(item.GetName()).Namespace(item.GetNamespace()).Get(&item).Error
List获取CR对象的列表
var crontabList []unstructured.Unstructured
// 查询default命名空间下的CronTab
err := kom.DefaultCluster().CRD("stable.example.com", "v1", "CronTab").Namespace(crontab.GetNamespace()).List(&crontabList).Error
// 查询所有命名空间下的CronTab
err := kom.DefaultCluster().CRD("stable.example.com", "v1", "CronTab").AllNamespace().List(&crontabList).Error
err := kom.DefaultCluster().CRD("stable.example.com", "v1", "CronTab").Namespace("*").List(&crontabList).Error
更新CR对象
patchData := `{
    "spec": {
        "image": "patch-image"
    },
    "metadata": {
        "labels": {
            "new-label": "new-value"
        }
    }
}`
err := kom.DefaultCluster().CRD("stable.example.com", "v1", "CronTab").Name(crontab.GetName()).Namespace(crontab.GetNamespace()).Patch(&crontab, types.StrategicMergePatchType, patchData).Error
删除CR对象
err := kom.DefaultCluster().CRD("stable.example.com", "v1", "CronTab").Name(crontab.GetName()).Namespace(crontab.GetNamespace()).Delete().Error
强制删除CR对象
err := kom.DefaultCluster().CRD("stable.example.com", "v1", "CronTab").Name(crontab.GetName()).Namespace(crontab.GetNamespace()).ForceDelete().Error
Watch CR对象
var watcher watch.Interface

err := kom.DefaultCluster().CRD("stable.example.com", "v1", "CronTab").Namespace("default").Watch(&watcher).Error
if err != nil {
    fmt.Printf("Create Watcher Error %v", err)
}
go func() {
    defer watcher.Stop()
    
    for event := range watcher.ResultChan() {
    var item *unstructured.Unstructured
    
    item, err := kom.DefaultCluster().Tools().ConvertRuntimeObjectToUnstructuredObject(event.Object)
    if err != nil {
        fmt.Printf("无法将对象转换为 Unstructured 类型: %v", err)
        return
    }
    // 处理事件
    switch event.Type {
        case watch.Added:
            fmt.Printf("Added Unstructured [ %s/%s ]\n", item.GetNamespace(), item.GetName())
        case watch.Modified:
            fmt.Printf("Modified Unstructured [ %s/%s ]\n", item.GetNamespace(), item.GetName())
        case watch.Deleted:
            fmt.Printf("Deleted Unstructured [ %s/%s ]\n", item.GetNamespace(), item.GetName())
        }
    }
}()
Describe查询某个CRD资源
// Describe default 命名空间下名为 nginx 的 Deployment
var describeResult []byte
err := kom.DefaultCluster().CRD("stable.example.com", "v1", "CronTab").Namespace("default").Name(item.GetName()).Describe(&item).Error
fmt.Printf("describeResult: %s", describeResult)
获取CRD下的Pod资源
pods, err := kom.DefaultCluster().CRD("apps.kruise.io", "v1beta1", "StatefulSet").
Namespace("default").Name("sample").Ctl().CRD().ManagedPods()
	for _, pod := range pods {
		fmt.Printf("Get pods: %v", pod.GetName())
	}
6. 集群参数信息
// 集群文档
kom.DefaultCluster().Status().Docs()
// 集群资源信息
kom.DefaultCluster().Status().APIResources()
// 集群已注册CRD列表
kom.DefaultCluster().Status().CRDList()
// 集群版本信息
kom.DefaultCluster().Status().ServerVersion()
// 获取集群内各资源种类数量
kom.DefaultCluster().Status().GetResourceCountSummary(10)
7. callback机制
  • 内置了callback机制，可以自定义回调函数，当执行完某项操作后，会调用对应的回调函数。
  • 如果回调函数返回true，则继续执行后续操作，否则终止后续操作。
  • 当前支持的callback有：get,list,create,update,patch,delete,exec,stream-exec,logs,watch,doc.
  • 内置的callback名称有："kom:get","kom:list","kom:create","kom:update","kom:patch","kom:watch","kom:delete","kom:pod:exec","kom:pod:stream:exec","kom:pod:logs","kom:pod:port:forward","kom:doc"
  • 支持回调函数排序，默认按注册顺序执行，可以通过kom.DefaultCluster().Callback().After("kom:get")或者.Before("kom:get")设置顺序。
  • 支持删除回调函数，通过kom.DefaultCluster().Callback().Delete("kom:get")
  • 支持替换回调函数，通过kom.DefaultCluster().Callback().Replace("kom:get",cb)
// 为Get获取资源注册回调函数
kom.DefaultCluster().Callback().Get().Register("get", cb)
// 为List获取资源注册回调函数
kom.DefaultCluster().Callback().List().Register("list", cb)
// 为Create创建资源注册回调函数
kom.DefaultCluster().Callback().Create().Register("create", cb)
// 为Update更新资源注册回调函数
kom.DefaultCluster().Callback().Update().Register("update", cb)
// 为Patch更新资源注册回调函数
kom.DefaultCluster().Callback().Patch().Register("patch", cb)
// 为Delete删除资源注册回调函数
kom.DefaultCluster().Callback().Delete().Register("delete", cb)
// 为Watch资源注册回调函数
kom.DefaultCluster().Callback().Watch().Register("watch",cb)
// 为Exec Pod内执行命令注册回调函数
kom.DefaultCluster().Callback().Exec().Register("exec", cb)
// 为Logs获取日志注册回调函数
kom.DefaultCluster().Callback().Logs().Register("logs", cb)
// 删除回调函数
kom.DefaultCluster().Callback().Get().Delete("get")
// 替换回调函数
kom.DefaultCluster().Callback().Get().Replace("get", cb)
// 指定回调函数执行顺序，在内置的回调函数执行完之后再执行
kom.DefaultCluster().Callback().After("kom:get").Register("get", cb)
// 指定回调函数执行顺序，在内置的回调函数执行之前先执行
// 案例1.在Create创建资源前，进行权限检查，没有权限则返回error，后续创建动作将不再执行
// 案例2.在List获取资源列表后，进行特定的资源筛选，从列表(Statement.Dest)中删除不符合要求的资源，然后返回给用户
kom.DefaultCluster().Callback().Before("kom:create").Register("create", cb)

// 自定义回调函数
func cb(k *kom.Kubectl) error {
    stmt := k.Statement
    gvr := stmt.GVR
    ns := stmt.Namespace
    name := stmt.Name
    // 打印信息
    fmt.Printf("Get %s/%s(%s)\n", ns, name, gvr)
    fmt.Printf("Command %s/%s(%s %s)\n", ns, name, stmt.Command, stmt.Args)
    return nil
	// return fmt.Errorf("error") 返回error将阻止后续cb的执行
}
8. SQLによるk8sリソースのクエリ
  • SQL()メソッドを使ってk8sリソースをクエリできます。シンプルで効率的です。
  • Table名には、CRDリソースを含め、クラスター内に登録されているすべてのリソースの正式名称と略称を指定できます。クラスターに登録されていれば、どのリソースもクエリできます。
  • 代表的なTable名は、pod,deployment,service,ingress,pvc,pv,node,namespace,secret,configmap,serviceaccount,role,rolebinding,clusterrole,clusterrolebinding,crd,cr,hpa,daemonset,statefulset,job,cronjob,limitrange,horizontalpodautoscaler,poddisruptionbudget,networkpolicy,endpoints,ingressclass,mutatingwebhookconfiguration,validatingwebhookconfiguration,customresourcedefinition,storageclass,persistentvolumeclaim,persistentvolume,horizontalpodautoscaler,podsecurityです。いずれもクエリできます。
  • 現在、クエリフィールドは*のみをサポートしています。つまり、select *
  • 現在、クエリ条件は =，!=,>=,<=,<>,like,in,not in,and,or,betweenをサポートしています。
  • 現在、ソートフィールドは単一フィールドでのソートをサポートしています。デフォルトでは作成時刻の降順で並べ替えられます。
k8s組み込みリソースのクエリ
    sql := "select * from deploy where metadata.namespace='kube-system' or metadata.namespace='default' order by  metadata.creationTimestamp asc   "

	var list []v1.Deployment
	err := kom.DefaultCluster().Sql(sql).List(&list).Error
	for _, d := range list {
		fmt.Printf("List Items foreach %s,%s at %s \n", d.GetNamespace(), d.GetName(), d.GetCreationTimestamp())
	}
CRDリソースのクエリ
    // vm 为kubevirt 的CRD
    sql := "select * from vm where (metadata.namespace='kube-system' or metadata.namespace='default' )  "
	var list []unstructured.Unstructured
	err := kom.DefaultCluster().Sql(sql).List(&list).Error
	for _, d := range list {
		fmt.Printf("List Items foreach %s,%s\n", d.GetNamespace(), d.GetName())
	}
チェーン形式のSQLクエリ
// 查询pod 列表
err := kom.DefaultCluster().From("pod").
		Where("metadata.namespace = ?  or metadata.namespace= ? ", "kube-system", "default").
		Order("metadata.creationTimestamp desc").
		List(&list).Error
k8sリソースのネストされたリスト属性のサポート
// spec.containers为列表，其下的ports也为列表，我们查询ports的name
sql := "select * from pod where spec.containers.ports.name like '%k8m%'  "
var list []v1.Pod
err := kom.DefaultCluster().Sql(sql).List(&list).Error
for _, d := range list {
	t.Logf("List Items foreach %s,%s\n", d.GetNamespace(), d.GetName())
}
9. その他の操作
Deploymentの再起動
err = kom.DefaultCluster().Resource(&Deployment{}).Namespace("default").Name("nginx").Ctl().Rollout().Restart()
Deploymentのスケール
// 将名称为nginx的deployment的副本数设置为3
err = kom.DefaultCluster().Resource(&Deployment{}).Namespace("default").Name("nginx").Ctl().Scaler().Scale(3)
Deploymentの停止
// 将名称为nginx的deployment的副本数设置为0
// 当前运行副本数量记录到注解中
err = kom.DefaultCluster().Resource(&Deployment{}).Namespace("default").Name("nginx").Ctl().Scaler().Stop()
Deploymentの再開
// 将名称为nginx的deployment的副本数从注解中恢复，如果没有注解，默认恢复到1
err = kom.DefaultCluster().Resource(&Deployment{}).Namespace("default").Name("nginx").Ctl().Scaler().Restore()
DeploymentのTag更新
// 将名称为nginx的deployment的中的容器镜像tag升级为alpine
err = kom.DefaultCluster().Resource(&Deployment{}).Namespace("default").Name("nginx").Ctl().Deployment().ReplaceImageTag("main","20241124")
Deployment Rollout History
// 查询名称为nginx的deployment的升级历史
result, err := kom.DefaultCluster().Resource(&Deployment{}).Namespace("default").Name("nginx").Ctl().Rollout().History()
Deployment Rollout Undo
// 将名称为nginx的deployment进行回滚
result, err := kom.DefaultCluster().Resource(&Deployment{}).Namespace("default").Name("nginx").Ctl().Rollout().Undo()
// 将名称为nginx的deployment进行回滚到指定版本(history 查询)
result, err := kom.DefaultCluster().Resource(&Deployment{}).Namespace("default").Name("nginx").Ctl().Rollout().Undo("6")
Deployment Rollout Pause
// 暂停升级过程
err := kom.DefaultCluster().Resource(&Deployment{}).Namespace("default").Name("nginx").Ctl().Rollout().Pause()
Deployment Rollout Resume
// 恢复升级过程
err := kom.DefaultCluster().Resource(&Deployment{}).Namespace("default").Name("nginx").Ctl().Rollout().Resume()
Deployment Rollout Status
// 将名称为nginx的deployment的中的容器镜像tag升级为alpine
result, err := kom.DefaultCluster().Resource(&Deployment{}).Namespace("default").Name("nginx").Ctl().Rollout().Status()
Deployment HPA
// 显示deployment的hpa 
list, err := kom.DefaultCluster().Resource(&v1.Deployment{}).Namespace("default").Name("nginx-web").Ctl().Deployment().HPAList()
for _, item := range list {
    t.Logf("HPA %s\n", item.Name)
}
ノードへのテイント設定
err = kom.DefaultCluster().Resource(&Node{}).Name("kind-control-plane").Ctl().Node().Taint("dedicated=special-user:NoSchedule")
ノードのテイント削除
err = kom.DefaultCluster().Resource(&Node{}).Name("kind-control-plane").Ctl().Node().UnTaint("dedicated=special-user:NoSchedule")
ノードのCordon
err = kom.DefaultCluster().Resource(&Node{}).Name("kind-control-plane").Ctl().Node().Cordon()
ノードのUnCordon
err = kom.DefaultCluster().Resource(&Node{}).Name("kind-control-plane").Ctl().Node().UnCordon()
ノードのDrain
err = kom.DefaultCluster().Resource(&Node{}).Name("kind-control-plane").Ctl().Node().Drain()
ノードのIPリソース状況の確認

キャッシュ時間を設定して、k8s APIへの頻繁な問い合わせを防止できます。

nodeName := "lima-rancher-desktop"
total, used, available := kom.DefaultCluster().Resource(&corev1.Node{}).WithCache(5 * time.Second).Name(nodeName).Ctl().Node().IPUsage()
fmt.Printf("Total %d, Used %d, Available %d\n", total, used, available)
//Total 256, Used 6, Available 250
ノードのIPリソース使用状況の統計

キャッシュ時間を設定して、k8s APIへの頻繁な問い合わせを防止できます。

nodeName := "lima-rancher-desktop"
total, used, available := kom.DefaultCluster().Resource(&corev1.Node{}).WithCache(5 * time.Second).Name(nodeName).Ctl().Node().PodCount()
fmt.Printf("Total %d, Used %d, Available %d\n", total, used, available)
//Total 110, Used 9, Available 101
ノードのリソース使用量の統計

キャッシュ時間を設定して、k8s APIへの頻繁な問い合わせを防止できます。

nodeName := "lima-rancher-desktop"
usage := kom.DefaultCluster().Resource(&corev1.Node{}).WithCache(5 * time.Second).Name(nodeName).Ctl().Node().ResourceUsage()
fmt.Printf("Node Usage %s\n", utils.ToJSON(usage))

現在のリクエスト値、制限値、割り当て可能値、使用率を含みます。

{
  "requests": {
    "cpu": "200m",
    "memory": "140Mi"
  },
  "limits": {
    "memory": "170Mi"
  },
  "allocatable": {
    "cpu": "4",
    "ephemeral-storage": "99833802265",
    "hugepages-1Gi": "0",
    "hugepages-2Mi": "0",
    "hugepages-32Mi": "0",
    "hugepages-64Ki": "0",
    "memory": "8127096Ki",
    "pods": "110"
  },
  "usageFractions": {
    "cpu": {
      "requestFraction": 5,
      "limitFraction": 0
    },
    "ephemeral-storage": {
      "requestFraction": 0,
      "limitFraction": 0
    },
    "memory": {
      "requestFraction": 1.76397571777176,
      "limitFraction": 2.1419705144371375
    }
  }
}
リソースへのラベル追加
err = kom.DefaultCluster().Resource(&Node{}).Name("kind-control-plane").Ctl().Label("name=zhangsan")
リソースからのラベル削除
err = kom.DefaultCluster().Resource(&Node{}).Name("kind-control-plane").Ctl().Label("name-")
リソースへのアノテーション追加
err = kom.DefaultCluster().Resource(&Node{}).Name("kind-control-plane").Ctl().Annotate("name=zhangsan")
リソースからのアノテーション削除
err = kom.DefaultCluster().Resource(&Node{}).Name("kind-control-plane").Ctl().Annotate("name-")
NodeSellの作成
ns, pod, container, err  := kom.DefaultCluster().Resource(&v1.Node{}).Name("kind-control-plane").Ctl().Node().CreateNodeShell()
fmt.Printf("Node Shell ns=%s podName=%s containerName=%s", ns, pod, container)
kubectl Shellの作成
ns, pod, container, err := kom.DefaultCluster().Resource(&v1.Node{}).Name(name).Ctl().Node().CreateKubectlShell(kubeconfig)
fmt.Printf("Kubectl Shell ns=%s podName=%s containerName=%s", ns, pod, container)
StorageClass配下のPVC数の集計
count, err := kom.DefaultCluster().Resource(&v1.StorageClass{}).Name("hostpath").Ctl().StorageClass().PVCCount()
fmt.Printf("pvc count %d\n", count)
StorageClass配下のPV数の集計
count, err := kom.DefaultCluster().Resource(&v1.StorageClass{}).Name("hostpath").Ctl().StorageClass().PVCount()
fmt.Printf("pv count %d\n", count)
StorageClassをデフォルトに設定
err := kom.DefaultCluster().Resource(&v1.StorageClass{}).Name("hostpath").Ctl().StorageClass().SetDefault()
IngressClassをデフォルトに設定
err := kom.DefaultCluster().Resource(&v1.IngressClass{}).Name("nginx").Ctl().IngressClass().SetDefault()
Deployment/StatefulSet/DaemonSet配下のPodリストの集計
list, err := kom.DefaultCluster().Namespace("default").Name("managed-pods").Ctl().Deployment().ManagedPods()
for _, pod := range list {
	fmt.Printf("ManagedPod: %v", pod.Name)
}
すべてのノードのラベルセットを取得
// labels 类型为map[string]string
labels, err := kom.DefaultCluster().Resource(&v1.Node{}).Ctl().Node().AllNodeLabels()
fmt.Printf("%s", utils.ToJSON(labels))

{
          "beta.kubernetes.io/arch": "arm64",
          "beta.kubernetes.io/os": "linux",
          "kubernetes.io/arch": "arm64",
          "kubernetes.io/hostname": "kind-control-plane",
          "kubernetes.io/os": "linux",
          "kubernetes.io/role": "agent",
          "node-role.kubernetes.io/agent": "",
          "node-role.kubernetes.io/control-plane": "",
          "type": "kwok",
          "uat": "test",
          "x": "x"
}
Podリソースの使用率を確認
podName := "coredns-ccb96694c-jprpf"
ns := "kube-system"
usage := kom.DefaultCluster().Resource(&corev1.Pod{}).Name(podName).Namespace(ns).Ctl().Pod().ResourceUsage()
fmt.Printf("Pod Usage %s\n", utils.ToJSON(usage))

現在のリクエスト値、制限値、割り当て可能値、使用率を含みます。

{
  "requests": {
    "cpu": "100m",
    "memory": "70Mi"
  },
  "limits": {
    "memory": "170Mi"
  },
  "allocatable": {
    "cpu": "4",
    "ephemeral-storage": "99833802265",
    "hugepages-1Gi": "0",
    "hugepages-2Mi": "0",
    "hugepages-32Mi": "0",
    "hugepages-64Ki": "0",
    "memory": "8127096Ki",
    "pods": "110"
  },
  "usageFractions": {
    "cpu": {
      "requestFraction": 2.5,
      "limitFraction": 0
    },
    "memory": {
      "requestFraction": 0.88198785888588,
      "limitFraction": 2.1419705144371375
    }
  }
}
フィールドのドキュメント説明を取得
var docResult []byte
	item := v1.Deployment{}
	field := "spec.replicas"
	field = "spec.template.spec.containers.name"
	field = "spec.template.spec.containers.imagePullPolicy"
	field = "spec.template.spec.containers.livenessProbe.successThreshold"
	err := kom.DefaultCluster().
		Resource(&item).DocField(field).Doc(&docResult).Error
	fmt.Printf("Get Deployment Doc [%s] :%s", field, string(docResult))
10. Prometheusクエリ

komは強力なPrometheusクエリ機能を提供しており、クラスター内のPrometheusサービスまたは外部Prometheusアドレスを使って、監視データをクエリできます。

クラスター内のPrometheusサービスを使用

名前空間とサービス名を指定して、クラスター内のPrometheusサービスアドレスを自動的に解決します：

ctx := context.Background()

// 使用命名客户端（例如 "prometheus-k8s"）
res, err := kom.DefaultCluster().
	WithContext(ctx).
	Prometheus().
	WithInClusterEndpoint("prometheus-k8s", "monitoring").
	Expr(`up`).
	WithTimeout(5 * time.Second).
	Query()

if err != nil {
	klog.V(6).Infof("查询失败（可能集群中未安装指定的 Prometheus）: %v", err)
	return
}

klog.V(6).Infof("查询结果: %s", res.AsString())

説明：

  • WithInClusterEndpoint(namespace, svcName)：指定した名前空間内のPrometheus Serviceを自動的に検索します。
  • 一般的なポート（9090）とポート名（web、http、prometheus、metrics）を自動的に識別します。
  • 生成されるアドレスの形式：http://service-name.namespace.svc:port
外部Prometheusアドレスを使用

Prometheusへのアクセスアドレスを直接指定します：

ctx := context.Background()

value, err := kom.DefaultCluster().
	WithContext(ctx).
	Prometheus().
	WithAddress("http://127.0.0.1:43422/").
	Expr(`sum by (instance) (irate(node_cpu_seconds_total{mode!="idle"}[1m])) / sum by (instance) (irate(node_cpu_seconds_total[1m])) * 100`).
	QueryRange(time.Now().Add(-1*time.Hour), time.Now(), time.Minute)

if err != nil {
	klog.V(6).Infof("查询失败: %v", err)
	return
}

klog.V(6).Infof(" value: %s", value.AsString())
瞬時クエリ

指定した時刻にクエリを実行します：

// 在当前时间点查询
res, err := kom.DefaultCluster().
	Prometheus().
	WithAddress("http://127.0.0.1:9090").
	Expr(`up`).
	Query()

// 在指定时间点查询
res, err := kom.DefaultCluster().
	Prometheus().
	WithAddress("http://127.0.0.1:9090").
	Expr(`up`).
	QueryAt(time.Now().Add(-1 * time.Hour))
レンジクエリ

時間範囲を指定してクエリを実行します：

start := time.Now().Add(-1 * time.Hour)
end := time.Now()
step := time.Minute

res, err := kom.DefaultCluster().
	Prometheus().
	WithAddress("http://127.0.0.1:9090").
	Expr(`rate(http_requests_total[5m])`).
	QueryRange(start, end, step)
クエリ結果の解析

komはPrometheusのクエリ結果を解析する複数の方法を提供しています：

スカラー値として解析：

val, ok := res.AsScalar()
if ok {
	fmt.Printf("标量值: %f\n", val)
}

ベクトル（瞬時クエリ結果）として解析：

samples := res.AsVector()
for _, sample := range samples {
	fmt.Printf("Metric: %v, Value: %f, Timestamp: %v\n",
		sample.Metric, sample.Value, sample.Timestamp)
}

行列（レンジクエリ結果）として解析：

series := res.AsMatrix()
for _, s := range series {
	fmt.Printf("Series Metric: %v\n", s.Metric)
	for _, point := range s.Samples {
		fmt.Printf("  Timestamp: %v, Value: %f\n",
			point.Timestamp, point.Value)
	}
}

生の結果を取得：

value, warnings := res.Raw()
fmt.Printf("原始结果: %s, 警告: %v\n", value.String(), warnings)

文字列形式で取得（デバッグに便利）：

fmt.Printf("查询结果: %s\n", res.AsString())
便利なクエリメソッド

komは、特定の型のクエリ結果を直接取得できる便利なメソッドを提供しています：

スカラーを直接取得：

val, err := kom.DefaultCluster().
	Prometheus().
	WithAddress("http://127.0.0.1:9090").
	Expr(`sum(up)`).
	QueryScalar()

ベクトルを直接取得：

samples, err := kom.DefaultCluster().
	Prometheus().
	WithAddress("http://127.0.0.1:9090").
	Expr(`up`).
	QueryVector()

行列を直接取得：

series, err := kom.DefaultCluster().
	Prometheus().
	WithAddress("http://127.0.0.1:9090").
	Expr(`rate(http_requests_total[5m])`).
	QueryRange(time.Now().Add(-1*time.Hour), time.Now(), time.Minute).
	QueryMatrix()
タイムアウト時間の設定

クエリにタイムアウト時間を設定します：

res, err := kom.DefaultCluster().
	Prometheus().
	WithAddress("http://127.0.0.1:9090").
	Expr(`up`).
	WithTimeout(5 * time.Second).
	Query()
クエリパラメーターの説明
メソッドパラメーター説明
WithInClusterEndpointnamespace, svcNameクラスター内のPrometheusサービスを使用します
WithAddressaddress外部Prometheusアドレスを使用します
ExprexprPromQLクエリ式を設定します
WithTimeoutdurationクエリのタイムアウト時間を設定します
Query-瞬時クエリを実行します
QueryAttime指定した時刻に瞬時クエリを実行します
QueryRangestart, end, stepレンジクエリを実行します
QueryScalar-クエリを実行してスカラー値を返します
QueryVector-クエリを実行してベクトルを返します
QueryMatrix-クエリを実行して行列を返します

ライセンス

FOSSA Status

コメント

Markdown 対応

MCP は初めてですか？

プロトコルの概要から最初のサーバーの導入まで、よくある疑問にまとめて答えます。

AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。