client-go是由k8s发布且维护的专门用于开发者和kubernetes交互的客户端库。它支持对k8s资源的CRUD操作(create、read、update、delete),事件监听和处理,访问kubernetes集群的上下文和配置。
client go是独立于kubernetes集群之外,但是又和集群交互的客户端机器。在这台机器上安装go环境以及和kubernetes建立连接。
Linux
安装go环境
在新的节点(在我这里是虚拟机)上安装go环境,首先下载go的安装包,在官网下载。All releases - The Go Programming Language
由于我安装的是server版的虚拟机,所以安装go环境的时候,使用curl命令来下载安装包。因为要确定go环境与k8s集群的兼容性,所以要查看集群的k8s版本。
[root@master ~]# kubectl version --short
Client Version: v1.23.1
Server Version: v1.23.1
查看kubernetes官方文档发现是与go的1.19.5版本相匹配
[root@client ~]# curl -L -O https://go.dev/dl/go1.19.5.linux-amd64.tar.gz
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 75 100 75 0 0 131 0 --:--:-- --:--:-- --:--:-- 131
100 65.7M 100 65.7M 0 0 3446k 0 0:00:19 0:00:19 --:--:-- 3513k
[root@client ~]# file go1.22.5.linux-amd64.tar.gz
# 验证下载文件的类型是否为压缩包
go1.22.5.linux-amd64.tar.gz: gzip compressed data, max compression, original size modulo 2^32 232839680 gzip compressed data, unknown method, has CRC, extra field, has comment, encrypted, from FAT filesystem (MS-DOS, OS/2, NT), original size modulo 2^32 232839680
[root@client ~]# rm -rf /usr/local/go && tar -C /usr/local -xzf go1.22.5.linux-amd64.tar.gz
将go加入环境变量,并查看go的版本,以确定go是否安装成功。
[root@client ~]# export PATH=$PATH:/usr/local/go/bin
[root@client ~]# go version
go version go1.19.5 linux/amd64
将go持久化的加入环境变量,将上面的export PATH=...写入系统文件。
[root@client ~]# vim ~/.bashrc
[root@client ~]# source ~/.bashrc
配置client-go
如果您使用的 Kubernetes 版本 >= v1.17.0,请使用相应的 v0.x.y 标签。例如,k8s.io/client-go@v0.20.4 对应于 Kubernetes v1.20.4。我的版本为1.23.1,所以下载相应的client-go版本:
go get k8s.io/client-go@v0.23.1
go mod文件创建并启动go模式支持:
go mod init <module-name>
export GO111MODULE=on
随后会创建一个初始的go.mod文件,包含模块名称和go的版本信息等,随着项目部署或者添加依赖项,go会自动更新,go.mod文件会自动更新,记录所有依赖及其版本,同时生成go.sum文件,以确保依赖项的一致性和完整性。因此go.mod文件会逐渐积累项目所需的所有依赖以及版本信息。
利用client-go抓取信息
编写main.go文件
package main
import (
"flag"
"fmt"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/tools/clientcmd"
"context"
)
func main() {
// 配置 k8s 集群外 kubeconfig 配置文件
var kubeconfig *string
kubeconfig = flag.String("kubeconfig", "/etc/k8scoonfig/config", "absolute path to the kubeconfig file")
namespace := flag.String("namespace","default","the namespace to list the pod from")
flag.Parse()
// use the current context in kubeconfig
config, err := clientcmd.BuildConfigFromFlags("", *kubeconfig)
if err != nil {
panic(err.Error())
}
// create the clientset
clientset, err := kubernetes.NewForConfig(config)
if err != nil {
panic(err.Error())
}
// 获取集群中所有 Pod 列表
pods, err := clientset.CoreV1().Pods("").List(context.TODO(), metav1.ListOptions{})
if err != nil {
panic(err.Error())
}
fmt.Printf("There are %d pods in the k8s cluster\n", len(pods.Items))
// 获取指定 namespace 中的 Pod 列表
pods, err = clientset.CoreV1().Pods(*namespace).List(context.TODO(), metav1.ListOptions{})
if err != nil {
panic(err)
}
fmt.Printf("There are %d pods in namespace %s\n", len(pods.Items), namespace)
for _, pod := range pods.Items {
fmt.Printf("Name: %s, Status: %s, CreateTime: %v\n", pod.Name, pod.Status.Phase, pod.CreationTimestamp)
}
}
当指定namespace为monitor-sa,可以看到client-go成功抓取了集群中该namespace的pod数量。
[root@client client_go_examples]# ./app -kubeconfig=/etc/k8scoonfig/config -namespace="monitor-sa"
There are 18 pods in the k8s cluster
There are 3 pods in namespace monitor-sa
Name: node-exporter-jb9jp, Status: Running, CreateTime: 2024-07-06 11:47:33 +0000 UTC
Name: node-exporter-kpvxd, Status: Running, CreateTime: 2024-07-06 11:47:33 +0000 UTC
Name: node-exporter-pwdw4, Status: Running, CreateTime: 2024-07-06 11:47:33 +0000 UTC
windows
下载kubectl。注意这里下载保存的地方就是后面要引用的地方,所以最好记住保存路径,且不要保存在下载文件夹。https://storage.googleapis.com/kubernetes-release/release/v1.18.0/bin/windows/amd64/kubectl.exe
然后把他加入环境变量,这里的kube是存储kubectl.exe的文件夹。
打开windows命令行,测试kubectl是否正常工作。
配置kube-config,将复制到linux系统的config文件也同样复制到windows,我这里的目录是C:/user/.kube/config。随后配置到vscode中。
VSCode
下载client-go到本地,然后在vscode中下载go的插件,以及code runner插件:
然后cstrl+shift+p,进入vscode的搜索行,安装go的插件依赖。搜索Go:install/update tools
如果出现这种情况,则需要设环境变量。设置如下四个环境变量,其中go_path是你要运行的go代码的存放目录,而go_root是你下载go存放的目录。
查看path,如果有以下这项则为正常:
此时再尝试下载GO:install/update tools,则成功。
安装成功后,在gopath目录下安装client-go
go get k8s.io/client-go@v0.23.1
go get k8s.io/apimachinery@v0.23.1
#使用 go mod tidy 确保所有依赖项已被正确下载并添加到项目中:
go mod tidy
go run main.go
发现运行成功: