脚本之家，脚本语言编程技术及教程分享平台！
分类导航

Python|VBS|Ruby|Lua|perl|VBA|Golang|PowerShell|Erlang|autoit|Dos|bat|

服务器之家 - 脚本之家 - Golang - 自动生成代码controller tool的简单使用

自动生成代码controller tool的简单使用

2022-10-08 15:04李大鹅 Golang

这篇文章主要为大家介绍了自动生成代码controller tool的简单使用示例，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪

介绍

在上一篇code-generator简单介绍中重点介绍了如何使用code-generator来自动生成代码，通过自动生成的代码可以帮助我们像访问k8s内置资源那样来操作我们的CRD，其实就是帮助我们生成ClientSet、Informer、Lister等工具包。

但是我们需要自己定义types.go文件以及需要自己去编写crd文件。工作量其实也是很大的，那么有没有工具像code-generator那样帮助我们生成代码呢？答案是肯定的，那就是接下来要介绍的controller-tools

controller-tools

controller-tools主要可以帮我们自动生成types.go所需要的内容以及自动帮我们生成crd。

同样首先将其clone到本地：

?
1
$ git clone https://github.com/kubernetes-sigs/controller-tools.git

在项目的cmd目录下，我们可以看到有controller-gen、helpgen、type-scaffold三个工具。

其中type-scaffold可以用来生成我们需要的types.go文件，controller-gen可以生成zz_xxx.deepcopy.go文件以及crd文件。

我们使用go install进行安装：

?
1
2
$ cd controller-gen
$ go install ./cmd/{controller-gen,type-scaffold}

安装完成后我们可以去GOPATH下的bin目录下查看。

自动生成代码controller tool的简单使用

接着我们就可以新建一个项目，来使用controller-tools提供的工具为我们自动生成代码了。

?
1
2
3
4
5
6
7
8
9
10
11
$ mkdir controller-test && cd controller-test
$ go mod init controller-test
$ mkdir -p pkg/apis/example.com/v1
$ tree
.
├── go.mod
└── pkg
    └── apis
        └── example.com
            └── v1
4 directories, 1 file

接下来我们就可以使用工具来生成我们所需要的代码了,首先我们生成types.go所需要的内容，由于type-scaffold不支持导入文本，所以生成后我们需要复制到types.go文件中：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
$ type-scaffold --kind Foo
// FooSpec defines the desired state of Foo
type FooSpec struct {
        // INSERT ADDITIONAL SPEC FIELDS -- desired state of cluster
}
// FooStatus defines the observed state of Foo.
// It should always be reconstructable from the state of the cluster and/or outside world.
type FooStatus struct {
        // INSERT ADDITIONAL STATUS FIELDS -- observed state of cluster
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// Foo is the Schema for the foos API
// +k8s:openapi-gen=true
type Foo struct {
        metav1.TypeMeta   `json:",inline"`
        metav1.ObjectMeta `json:"metadata,omitempty"`
        Spec   FooSpec   `json:"spec,omitempty"`
        Status FooStatus `json:"status,omitempty"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// FooList contains a list of Foo
type FooList struct {
        metav1.TypeMeta `json:",inline"`
        metav1.ListMeta `json:"metadata,omitempty"`
        Items           []Foo `json:"items"`
}

然后在types.go文件中将import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"添加上就行。

当然自动生成只是一个模版，里面的具体细节还是需要我们自己去填写，比如我们填充FooSpec。

资源类型定义好了，那么如何能让client-go识别我们的资源呢，这里就需要其注册进去。我们可以在register.go中定义GV(Group Version),以及通过标签指定groupName。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// register.go
// +groupName=example.com
package v1
import (
    "k8s.io/apimachinery/pkg/runtime"
    "k8s.io/apimachinery/pkg/runtime/schema"
    "k8s.io/apimachinery/pkg/runtime/serializer"
)
var (
    Scheme       = runtime.NewScheme()
    GroupVersion = schema.GroupVersion{
        Group:   "example.com",
        Version: "v1",
    }
    Codec = serializer.NewCodecFactory(Scheme)
)

在types.go中调用Scheme.AddKnownTypes方法即可：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
// types.go
package v1
import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
// FooSpec defines the desired state of Foo
type FooSpec struct {
    // INSERT ADDITIONAL SPEC FIELDS -- desired state of cluster
    Name     string `json:"name"`
    Replicas int32  `json:"replicas"`
}
// FooStatus defines the observed state of Foo.
// It should always be reconstructable from the state of the cluster and/or outside world.
type FooStatus struct {
    // INSERT ADDITIONAL STATUS FIELDS -- observed state of cluster
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// Foo is the Schema for the foos API
// +k8s:openapi-gen=true
type Foo struct {
    metav1.TypeMeta   `json:",inline"`
    metav1.ObjectMeta `json:"metadata,omitempty"`
    Spec   FooSpec   `json:"spec,omitempty"`
    Status FooStatus `json:"status,omitempty"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// FooList contains a list of Foo
type FooList struct {
    metav1.TypeMeta `json:",inline"`
    metav1.ListMeta `json:"metadata,omitempty"`
    Items           []Foo `json:"items"`
}
func init() {
    Scheme.AddKnownTypes(GroupVersion, &Foo{}, &FooList{})
}

接下来就需要生成deepcopy.go文件了：

?
1
$ controller-gen object paths=./pkg/apis/example.com/v1/types.go

同样，我们使用controller-gen生成crd:

?
1
2
3
$ mkdir config
$ go mod tidy
$ controller-gen crd paths=./... output:crd:dir=config/crd

这时候我们查看项目结构：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
.
├── config
│   └── crd
│       └── example.com_foos.yaml
├── go.mod
├── go.sum
└── pkg
    └── apis
        └── example.com
            └── v1
                ├── register.go
                ├── types.go
                └── zz_generated.deepcopy.go
6 directories, 6 files

最后我们来进行验证，首先创建一个cr：

?
1
2
3
4
5
6
7
apiVersion: example.com/v1
kind: Foo
metadata:
  name: crd-test
spec:
  name: test
  replicas: 2

将crd和cr添加到集群后，我们来编写main.go文件来进行验证：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
package main
import (
    "context"
    v1 "controller-test/pkg/apis/example.com/v1"
    "fmt"
    "k8s.io/client-go/rest"
    "k8s.io/client-go/tools/clientcmd"
    "log"
)
func main() {
    config, err := clientcmd.BuildConfigFromFlags("", clientcmd.RecommendedHomeFile)
    if err != nil {
        log.Fatalln(err)
    }
    // 这边需要使用原始的 RESTClient
    config.APIPath = "/apis/"
    config.NegotiatedSerializer = v1.Codec
    config.GroupVersion = &v1.GroupVersion
    client, err := rest.RESTClientFor(config)
    if err != nil {
        log.Fatalln(err)
    }
    foo := &v1.Foo{}
    err = client.Get().Namespace("default").Resource("foos").Name("crd-test").Do(context.TODO()).Into(foo)
    if err != nil {
        log.Fatalln(err)
    }
    newObj := foo.DeepCopy()
    newObj.Spec.Name = "test2"
    fmt.Println(foo.Spec.Name)
    fmt.Println(newObj.Spec.Name)
}
//=======
// 输出结果
test
test2

以上就是自动生成代码controller tool的简单使用的详细内容，更多关于自动生成代码controller tool的资料请关注服务器之家其它相关文章！

原文链接：https://www.cnblogs.com/huiyichanmian/p/16261635.html

  • controller
  • 代码生成
  • Tool

    • 延伸 · 阅读

    精彩推荐
    • Golang秒懂Golang匿名函数

      秒懂Golang匿名函数

      所谓匿名函数，就是没有名字的函数,本文重点给大家介绍Golang匿名函数的相关知识，通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的...

      温柔的风4882021-03-30
    • Golanggolang实现简单rpc调用过程解析

      golang实现简单rpc调用过程解析

      这篇文章主要介绍了golang实现简单rpc调用,包括RPC具体实现结合实例代码给大家讲解的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友...

      神技圈子4462022-10-07
    • GolangGo语言操作redis用法实例

      Go语言操作redis用法实例

      这篇文章主要介绍了Go语言操作redis用法,实例分析了Go语言操作redis的技巧,具有一定参考借鉴价值,需要的朋友可以参考下 ...

      niuniu3682020-04-20
    • Golang详解如何在Go项目中输出版本信息

      详解如何在Go项目中输出版本信息

      这篇文章主要介绍了详解如何在Go项目中输出版本信息，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友...

      silenceper4612020-06-02
    • Golanggolang 限制同一时间的并发量操作

      golang 限制同一时间的并发量操作

      这篇文章主要介绍了golang 限制同一时间的并发量操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...

      小辣抓9292021-02-25
    • Golanggo语言net包rpc远程调用的使用示例

      go语言net包rpc远程调用的使用示例

      本篇文章主要介绍了go语言net包rpc远程调用的使用示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧 ...

      怀素真3462020-05-11
    • Golanggolang判断key是否在map中的代码

      golang判断key是否在map中的代码

      这篇文章主要介绍了golang判断key是否在map中的代码，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...

      chrispink_yang11682021-05-27
    • Golang如何使用GoKart对Go代码进行静态安全分析

      如何使用GoKart对Go代码进行静态安全分析

      GoKart是一款针对Go代码安全的静态分析工具，该工具能够从Go源代码中查找使用了SSA(单一静态分配)形式的代码漏洞。...

      FreeBuf10572021-11-04
    最近更新
    编辑推荐
    阅读排行
    热门标签
    心跳超时 　 指针类型 　 new() 　 make() 　 并发模型 　 切片 　 静态WEB服务器 　 端口扫描器 　 Go语言入门教程 　 基础语 　 Slices 　 Maps 　 Golang编程 　 panic 　 接受者类型 　 嵌入类型 　 Slice 　 Golang教程 　 Golang项目 　 内存模型 　 开发环境搭建 　 大小端判断 　 代码组织结构 　 复合类型 　 GOPATH 　 工作目录 　 实例 　 struct类型 　 并发技术 　 buffered 　
    © 2019-2022 脚本之家 | 服务器之家(www.tuohang.net)旗下站点 版权所有关于我们联系我们版权申明网站地图