client-go实战之八:更新资源时的冲突错误处理

欢迎访问我的GitHub

这里分类和汇总了欣宸的全部原创(含配套源码)：https://github.com/zq2599/blog_demos

本篇概览

• 本文是《client-go实战》系列的第七篇，来了解一个常见的错误：版本冲突，以及client-go官方推荐的处理方式
  
• 本篇由以下部分组成
  

• 什么是版本冲突（from kubernetes官方）
  
• 编码，复现版本冲突
  
• 版本冲突的解决思路（from kubernetes官方）
  
• 版本冲突的实际解决手段（from client-go官方）
  
• 编码，演示如何解决版本冲突
  
• 自定义入参，对抗更高的并发
  

什么是版本冲突（from kubernetes官方）

• 简单的说，就是同时出现多个修改请求，针对同一个kubernetes资源的时候，会出现一个请求成功其余请求都失败的情况
  
• 这里有kubernetes官方对版本冲突的描述：https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
  
• 以下是个人的理解
  

• 首先，在逻辑上来说，提交冲突是肯定存在的，多人同时获取到同一个资源的信息（例如同一个pod），然后各自在本地修改后提交，就有可能出现A的提交把B的提交覆盖的情况，这一个点就不展开了，数据库的乐观锁和悲观锁都可以用来处理并发冲突
  
• kubernetes应对提交冲突的方式是资源版本号，属于乐观锁类型（Kubernetes leverages the concept of resource versions to achieve optimistic concurrency）
  
• 基于版本实现并发控制是常见套路，放在kubernetes也是一样，基本原理如下图所示，按照序号看一遍即可理解：左右两人从后台拿到的资源都是1.0版本，然而右侧提交的1.1的时候，服务器上已经被左侧更新到1.1了，于是服务器不接受右侧提交
  
  

编码，复现版本冲突

• 接下来，咱们将上述冲突用代码复现出来，具体的功能如下
  

• 创建一个deployment资源，该资源带有一个label，名为biz-version，值为101
  
• 启动5个协程，每个协程都做同样的事情：读取deployment，得到label的值后，加一，再提交保存
  
• 正常情况下，label的值被累加了5次，那么最终的值应该等于101+5=106
  
• 等5个协程都执行完毕后，再读读取一次deployment，看label值是都等于106
  

• 接下来就写代码实现上述功能
  
• 为了后续文章的实战代码能统一管理，这里继续使用前文《client-go实战之七：准备一个工程管理后续实战的代码
  》创建的client-go-tutorials工程，将代码写在这个工程中
  
• 在client-go-tutorials工程中新增名为的conflict.go的文件，整个工程结构如下图所示
  

1. $ tree client-go-tutorials
2. client-go-tutorials
3. ├── action
4. │   ├── action.go
5. │   ├── conflict.go
6. │   └── list_pod.go
7. ├── client-go-tutorials
8. ├── go.mod
9. ├── go.sum
10. └── main.go

复制代码

• 接下来的代码都写在conflict.go中
  
• 首先是新增两个常量
  

1. const (
2.         // deployment的名称
3.         DP_NAME string = "demo-deployment"
4.         // 用于更新的标签的名字
5.         LABEL_CUSTOMIZE string = "biz-version"
6. )

复制代码

• 然后是辅助方法，返回32位整型的指针，后面会用到
  

1. func int32Ptr(i int32) *int32 { return &i }

复制代码

• 创建deployment的方法，要注意的是增加了一个label，名为LABEL_CUSTOMIZE，其值为101
  

1. // 创建deployment
2. func create(clientset *kubernetes.Clientset) error {
3.         deploymentsClient := clientset.AppsV1().Deployments(apiv1.NamespaceDefault)
5.         deployment := &appsv1.Deployment{
6.                 ObjectMeta: metav1.ObjectMeta{
7.                         Name:   DP_NAME,
8.                         Labels: map[string]string{LABEL_CUSTOMIZE: "101"},
9.                 },
10.                 Spec: appsv1.DeploymentSpec{
11.                         Replicas: int32Ptr(1),
12.                         Selector: &metav1.LabelSelector{
13.                                 MatchLabels: map[string]string{
14.                                         "app": "demo",
15.                                 },
16.                         },
17.                         Template: apiv1.PodTemplateSpec{
18.                                 ObjectMeta: metav1.ObjectMeta{
19.                                         Labels: map[string]string{
20.                                                 "app": "demo",
21.                                         },
22.                                 },
23.                                 Spec: apiv1.PodSpec{
24.                                         Containers: []apiv1.Container{
25.                                                 {
26.                                                         Name:  "web",
27.                                                         Image: "nginx:1.12",
28.                                                         Ports: []apiv1.ContainerPort{
29.                                                                 {
30.                                                                         Name:          "http",
31.                                                                         Protocol:      apiv1.ProtocolTCP,
32.                                                                         ContainerPort: 80,
33.                                                                 },
34.                                                         },
35.                                                 },
36.                                         },
37.                                 },
38.                         },
39.                 },
40.         }
42.         // Create Deployment
43.         fmt.Println("Creating deployment...")
44.         result, err := deploymentsClient.Create(context.TODO(), deployment, metav1.CreateOptions{})
45.         if err != nil {
46.                 return err
47.         }
49.         fmt.Printf("Created deployment %q.\n", result.GetObjectMeta().GetName())
51.         return nil
52. }

复制代码

• 按照名称删除deployment的方法，实战的最后会调用，将deployment清理掉
  

1. // 按照名称删除
2. func delete(clientset *kubernetes.Clientset, name string) error {
3.         deletePolicy := metav1.DeletePropagationBackground
5.         err := clientset.AppsV1().Deployments(apiv1.NamespaceDefault).Delete(context.TODO(), name, metav1.DeleteOptions{PropagationPolicy: &deletePolicy})
7.         if err != nil {
8.                 return err
9.         }
11.         return nil
12. }

复制代码

• 再封装一个get方法，用于所有更新操作完成后，获取最新的deployment，检查其label值是否符合预期
  

1. // 按照名称查找deployment
2. func get(clientset *kubernetes.Clientset, name string) (*v1.Deployment, error) {
3.         deployment, err := clientset.AppsV1().Deployments(apiv1.NamespaceDefault).Get(context.TODO(), name, metav1.GetOptions{})
4.         if err != nil {
5.                 return nil, err
6.         }
8.         return deployment, nil
9. }

复制代码

• 接下来是最重要的更新方法，这里用的是常见的先查询再更新的方式，查询deployment，取得标签值之后加一再提交保存
  

1. // 查询指定名称的deployment对象，得到其名为biz-version的label，加一后保存
2. func updateByGetAndUpdate(clientset *kubernetes.Clientset, name string) error {
4.         deployment, err := clientset.AppsV1().Deployments(apiv1.NamespaceDefault).Get(context.TODO(), name, metav1.GetOptions{})
6.         if err != nil {
7.                 return err
8.         }
10.         // 取出当前值
11.         currentVal, ok := deployment.Labels[LABEL_CUSTOMIZE]
13.         if !ok {
14.                 return errors.New("未取得自定义标签")
15.         }
17.         // 将字符串类型转为int型
18.         val, err := strconv.Atoi(currentVal)
20.         if err != nil {
21.                 fmt.Println("取得了无效的标签，重新赋初值")
22.                 currentVal = "101"
23.         }
25.         // 将int型的label加一，再转为字符串
26.         deployment.Labels[LABEL_CUSTOMIZE] = strconv.Itoa(val + 1)
28.         _, err = clientset.AppsV1().Deployments(apiv1.NamespaceDefault).Update(context.TODO(), deployment, metav1.UpdateOptions{})
29.         return err
30. }

复制代码

• 最后，是主流程代码，为了能在现有工程框架下运行，这里新增一个struct，并实现了action接口的DoAction方法，这个DoAction方法中就是主流程
  

[code]type Confilct struct{}func (conflict Confilct) DoAction(clientset *kubernetes.Clientset) error {        fmt.Println("开始创建deployment")        // 开始创建deployment        err := create(clientset)        if err != nil {                return err        }        // 如果不延时，就会导致下面的更新过早，会报错