龙空技术网

client-go实战之十:标签选择(labels.Selector),重要

程序员欣宸 140

前言:

当前我们对“标签选择器用什么表示的”大概比较珍视,咱们都需要了解一些“标签选择器用什么表示的”的相关内容。那么小编同时在网络上搜集了一些关于“标签选择器用什么表示的””的相关内容,希望大家能喜欢,咱们一起来了解一下吧!

欢迎访问我的GitHub

这里分类和汇总了欣宸的全部原创(含配套源码):

本篇概览本文是《client-go实战》系列的第十篇,kubernetes真是博大精深,尽管前面已有九篇实战,依然有个十分重要的基础知识点没覆盖到,这也是今天的重要内容:标签选择器labels.Selector本文由以下内容组成准备工作:部署nginx的deployment和service按照官方文档,解读LabelSelector什么是标签选择器(labels.Selector),和LabelSelector的区别编码实战:在查找pod时用labels.Selector过滤查询结果,用labels.Selector匹配编码实战:List&Watch场景,用labels.Selector过滤其他消息源码下载上述完整源码可在GitHub下载到,地址和链接信息如下表所示():

名称

链接

备注

项目主页

该项目在GitHub上的主页

git仓库地址(https)

该项目源码的仓库地址,https协议

git仓库地址(ssh)

git@github.com:zq2599/blog_demos.git

该项目源码的仓库地址,ssh协议

这个git项目中有多个文件夹,本篇的源码在tutorials/client-go-tutorials文件夹下,如下图红框所示:

重要:labels.Selector和LabelSelector是不同的概念,切记!!!有两个重要概念需要在本文一开始就说清楚,以免引起混淆,请务必注意!labels.Selector和LabelSelector是不同的概念,重要的事情说三遍!请一定要将labels.Selector和LabelSelector分开认识和理解作为client-go的使用者,我们用的是labels.Selector,它的源码是个interfaceLabelSelector是个资源定义,类似Pod,Deployment那样的资源定义,它的源码是个struct在编码开发时,主要用到的是labels.Selector,本篇的核心也是labels.Selectorlabels.Selector和LabelSelector是不同概念,但是它们功能类似,都用于标签选择,接下来说说什么是标签选择什么是标签?举个例子用一个电脑上的常见功能来说明什么是标签来看Mac操作系统的标签功能,如下图所示,Mac系统中可以给文件夹打上标签,例如我给blog_demosquarkus这两个文件夹都打上了博客标签,然后只要点击博客标签(如下图绿色箭头位置),就能列出blog_demosquarkus这两个文件夹

labels.Selector和LabelSelector的作用尽管labels.Selector和LabelSelector是不同的概念,然而他们的功能大致相同:与Mac系统的标签选择类似,在查找各种K8S资源时,labels.Selector和LabelSelector都能根据指定的标签对资源进行过滤本篇的核心是labels.Selector,当然也会提到LabelSelector,因为用对比的方式去学习的时候印象会更深刻接下来咱们慢慢聊,先从LabelSelector说起,它最简单也最具体,可以作为突破口准备工作:部署nginx的deployment和service先准备好kubernetes环境,部署好一些资源,再用这些资源来学习LabelSelector在kubernetes环境创建名为deployment-svc.yaml的文件,内容如下

apiVersion: apps/v1kind: Deploymentmetadata:  name: nginx-deploymentspec:  selector:    matchLabels:      app: nginx  replicas: 1  template:    metadata:      labels:        app: nginx        bind-service: nginx    spec:      containers:      - name: nginx        image: nginx:latest        ports:        - containerPort: 80---apiVersion: v1kind: Servicemetadata:  name: nginx-servicespec:  type: NodePort  selector:    app: nginx  ports:  - name: http    port: 80    targetPort: 80    nodePort: 30000
再执行以下命令创建deployment和service资源
kubectl apply -f deployment-svc.yaml
访问kubernetes服务器的30000端口,可以看到nginx的首页,证明deployment和service都部署成功了

了解标签选择器LabelSelector回顾前面写的deployment-svc.yaml文件,如下图所示,deployment有自己的标签,service通过标签选择器找到了deployment,与之匹配,使得外部请求可以顺利到达nginx的pod

上图中的标签选择器,就是咱们前面提到的LabelSelector,很显然,yaml中的selector就是一种资源类型,在代码中对应的就是LabelSelector这个结构体kubernetes官方对标签选择器的描述在这里:,这里面细说了关于标签的各种写法和约束,值得认真看一遍什么时候该用labels.Selector从前面的操作可见:如果是编写yaml文件,配置类似于deployment-svc.yaml这样的内容,那么用到的就是LabelSelector,因为它对应着yaml里的一个selector对象现在换个场景:如果在用client-go编写代码,对kubernetes的资源做过滤呢?例如查询pod列表的时候,想要根据标签做过滤,那么用LabelSelector就不合适了,因为这是代码,没有yaml文件,自然也就没有LabelSelector了此时labels.Selector就派上用场了:编码时,用labels.Selector可以对资源按照标签做过滤,接下来就写代码试试labels.Selector怎么用现在k8s环境里只有一个pod,就是前面创建的那个,为了演示labels.Selector的效果,咱们再添加一个deployment,脚本如下,这个pod的app标签值等于other

apiVersion: apps/v1kind: Deploymentmetadata:  name: other-deploymentspec:  selector:    matchLabels:      app: other  replicas: 1  template:    metadata:      labels:        app: other        bind-service: none    spec:      containers:      - name: other        image: nginx:latest        ports:        - containerPort: 80
现在有两个pod了,接下来写代码,用选出其中一个
 kubectl get podsNAME                                READY   STATUS    RESTARTS   AGEnginx-deployment-544dc8b7c4-xlkj8   1/1     Running   0          2m20sother-deployment-7659c57b9d-2slm8   1/1     Running   0          5s
如何创建labels.Selector接下来就要编码实战了,先了解一下如何创建labels.Selector一共有四种方法创建labels.Selector,可以用在不同的使用场景创建NewRequirement对象,加入labels.Selectorlabels.Parse方法,将字符串转为labels.Selector对象(最简单)labels.SelectorFromSet方法,用map生成labels.Selector对象metav1.LabelSelectorAsSelector方法,将LabelSelector对象转为labels.Selector对象理论已经差不多了,开始编码实战吧编码为了后续文章的实战代码能统一管理,这里继续使用前文《client-go实战之七:准备一个工程管理后续实战的代码

》创建的client-go-tutorials工程,将代码写在这个工程中client-go-tutorials工程中新增名label.go的文件,整个工程结构如下图所示

tree client-go-tutorials client-go-tutorials├── action│   ├── action.go│   ├── conflict.go│   ├── controller.go│   ├── controller_demo.go│   ├── label.go│   └── list_pod.go├── go.mod├── go.sum└── main.go1 directory, 9 files
为了个整个系列保持一致,先新增一个结构体
type Lable struct{}
然后是个辅助方法listPods,接收labels.Selector对象作为入参,然后在查询pod列表的时候用这个labels.Selector来过滤
// listPods 根据传入的selector过滤func listPods(clientset *kubernetes.Clientset, selector labels.Selector, prefix string) {	namespace := "default"	// 查询pod列表	pods, err := clientset.CoreV1().Pods(namespace).List(context.TODO(), metav1.ListOptions{		// 传入的selector在这里用到		LabelSelector: selector.String(),	})	if err != nil {		panic(err.Error())	}	nums := len(pods.Items)	log.Printf("[%v] 查到[%d]个pod\n", prefix, nums)	// 如果没有pod就返回了	if nums < 1 {		return	}	// 遍历列表中的每个pod	for index, pod := range pods.Items {		log.Printf("[%v] %v. pod : %v\n", prefix, index+1, pod.Name)	}}
然后是主方法,里面展示了前面提到的四种labels.Selector对象的创建方式,以及如何用做匹配功能
func (lable Lable) DoAction(clientset *kubernetes.Clientset) error {	// 第一种: 创建Requirement对象,指定类型是Equals(等于)	equalRequirement, err := labels.NewRequirement("app", selection.Equals, []string{"other"})	if err != nil {		log.Println("1. create equalRequirement fail, ", err)		return err	}	selector := labels.NewSelector().Add(*equalRequirement)	// 验证,应该只查到app等于other的pod	listPods(clientset, selector, "用Requirement创建,Equal操作")	// 第一种: 创建Requirement对象,指定类型是In,not_exists不会有任何pod匹配到	inRequirement, err := labels.NewRequirement("app", selection.In, []string{"other", "nginx", "not_exists"})	if err != nil {		log.Println("2. create equalRequirement fail, ", err)		return err	}	selector = labels.NewSelector().Add(*inRequirement)	// 验证,应该查到app=other的pod	listPods(clientset, selector, "用Requirement创建,In操作")	// 第二种:labels.Parse方法	parsedSelector, err := labels.Parse("bind-service=none,app notin (not_exists)")	if err != nil {		log.Println("3. create equalRequirement fail, ", err)		return err	}	// 验证,应该查到app=other的pod	listPods(clientset, parsedSelector, "用Parse创建")	// 第三种:labels.SelectorFromSet方法	setSelector := labels.SelectorFromSet(labels.Set(map[string]string{"app": "nginx"}))	// 验证,应该查到app=nginx的pod	listPods(clientset, setSelector, "用SelectorFromSet创建")	// 第四种:metav1.LabelSelectorAsSelector方法	// 适用于当前环境已有资源对象的场景,可以取出LabelSelector对象来转换成labels.Selector	// 先创建一个LabelSelector	labelSelector := &metav1.LabelSelector{		MatchLabels: map[string]string{"app": "other"},	}	// 将LabelSelector转为labels.Selector	convertSelector, err := metav1.LabelSelectorAsSelector(labelSelector)	if err != nil {		log.Println("4. create equalRequirement fail, ", err)		return err	}	// 验证,应该查到app=nginx的pod	listPods(clientset, convertSelector, "用LabelSelector转换")	// labels.Selector的第五种用法:用labels.Selector匹配	// 准备好一个selector	matchSelector := labels.SelectorFromSet(labels.Set(map[string]string{"app": "nginx"}))	// 查询pod列表	pods, err := clientset.CoreV1().Pods(namespace).List(context.TODO(), metav1.ListOptions{})	if err != nil {		panic(err.Error())	}	// 遍历列表中的每个pod	for _, pod := range pods.Items {		if matchSelector.Matches(labels.Set(pod.GetLabels())) {			log.Printf("app=nginx匹配成功[%s]\n", pod.Name)		} else {			log.Printf("app=nginx匹配失败[%s]\n", pod.Name)		}	}	return nil}
再回到main.go文件,增加一个新的action的支持,如下图黄框所示

有了上面的代码,在运行程序的时候,增加-action=label参数,就会执行前面的lable.go中的代码了如果您使用的是vscode,将launch.json改为以下内容,就能直接运行代码了

{    "version": "0.2.0",    "configurations": [                {            "name": "Launch Package",            "type": "go",            "request": "launch",            "mode": "auto",            "program": "${workspaceFolder}",            "args": ["-action=label"]        }    ]}
运行结果如下,功能正常,符合预期
2023/03/11 19:57:53 解析命令完毕,开始加载配置文件2023/03/11 19:57:53 加载配置文件完毕,即将执行业务 [label]2023/03/11 19:57:53 [用Requirement创建,Equal操作] 查到[1]个pod2023/03/11 19:57:53 [用Requirement创建,Equal操作] 1. pod : other-deployment-7b57cc4f89-bdxj82023/03/11 19:57:53 [用Requirement创建,In操作] 查到[2]个pod2023/03/11 19:57:53 [用Requirement创建,In操作] 1. pod : nginx-deployment-5659dc6c45-hsx7j2023/03/11 19:57:53 [用Requirement创建,In操作] 2. pod : other-deployment-7b57cc4f89-bdxj82023/03/11 19:57:53 [用Parse创建] 查到[1]个pod2023/03/11 19:57:53 [用Parse创建] 1. pod : other-deployment-7b57cc4f89-bdxj82023/03/11 19:57:53 [用SelectorFromSet创建] 查到[1]个pod2023/03/11 19:57:53 [用SelectorFromSet创建] 1. pod : nginx-deployment-5659dc6c45-hsx7j2023/03/11 19:57:53 [用LabelSelector转换] 查到[1]个pod2023/03/11 19:57:53 [用LabelSelector转换] 1. pod : other-deployment-7b57cc4f89-bdxj82023/03/11 19:57:53 执行完成
在List&Watch场景labels.Selector除了用在获取资源列表的时候,在Controller的List&Watch时也能用到,咱们使用List&Watch来监听指定类型的资源变化,可以用labels.Selector来监听指定标签的资源,这样其他资源的变化事件就不会推送过来关于Controller和List&Watch,可以参考《client-go实战之九:手写一个kubernetes的controller》,先来来看原有的List&Watch代码,在controller_demo.go文件中

修改后的完整DoAction方法如下,构造labels.Selector对象,改用NewFilteredListWatchFromClient方法,如此,只有匹配了这个labels.Selector的pod的事件,才会被apiserver发送到informer

func (controllerDemo ControllerDemo) DoAction(clientset *kubernetes.Clientset) error {	setSelector := labels.SelectorFromSet(labels.Set(map[string]string{"app": "nginx"}))	optionsModifer := func(options *metav1.ListOptions) {		options.LabelSelector = setSelector.String()	}	podListWatcher := cache.NewFilteredListWatchFromClient(clientset.CoreV1().RESTClient(), "pods", metav1.NamespaceDefault, optionsModifer)	// 创建ListWatch对象,指定要监控的资源类型是pod,namespace是default	// podListWatcher := cache.NewListWatchFromClient(clientset.CoreV1().RESTClient(), "pods", v1.NamespaceDefault, fields.Everything())	// 创建工作队列	queue := workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter())	// 创建informer,并将返回的存储对象保存在变量indexer中	indexer, informer := cache.NewIndexerInformer(podListWatcher, &v1.Pod{}, 0, cache.ResourceEventHandlerFuncs{		// 响应新增资源事件的方法,可以按照业务需求来定制,		// 这里的做法比较常见:写入工作队列		AddFunc: func(obj interface{}) {			key, err := cache.MetaNamespaceKeyFunc(obj)			if err == nil {				queue.Add(key)			}		},		// 响应修改资源事件的方法,可以按照业务需求来定制,		// 这里的做法比较常见:写入工作队列		UpdateFunc: func(old interface{}, new interface{}) {			key, err := cache.MetaNamespaceKeyFunc(new)			if err == nil {				queue.Add(key)			}		},		// 响应修改资源事件的方法,可以按照业务需求来定制,		// 这里的做法比较常见:写入工作队列,注意删除的时候生成key的方法和新增修改不一样		DeleteFunc: func(obj interface{}) {			// IndexerInformer uses a delta queue, therefore for deletes we have to use this			// key function.			key, err := cache.DeletionHandlingMetaNamespaceKeyFunc(obj)			if err == nil {				queue.Add(key)			}		},	}, cache.Indexers{})	// 创建Controller对象,将所需的三个变量对象传入	controller := NewController(queue, indexer, informer)	// Now let's start the controller	stop := make(chan struct{})	defer close(stop)	// 在协程中启动controller	go controller.Run(1, stop)	// Wait forever	select {}	return nil}
至此,labels.Selector的实战就完成了,这是个重要的功能,在查找和监听的场景都会用到,希望本文能够给给您一些参考,帮助您在client-go开发中做到精确过滤和选择欢迎关注头条号:程序员欣宸学习路上,你不孤单,欣宸原创一路相伴...

标签: #标签选择器用什么表示的