这篇文章主要介绍了自动生成代码controller tool怎么使用的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇自动生成代码controller tool怎么使用文章都会有所收获,下面我们
这篇文章主要介绍了自动生成代码controller tool怎么使用的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇自动生成代码controller tool怎么使用文章都会有所收获,下面我们一起来看看吧。
controller-tools主要可以帮我们自动生成types.Go所需要的内容以及自动帮我们生成crd。
同样首先将其clone到本地:
$ 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
进行安装:
$ cd controller-gen$ go install ./cmd/{controller-gen,type-scaffold}
安装完成后我们可以去GOPATH下的bin目录下查看。
接着我们就可以新建一个项目,来使用controller-tools提供的工具为我们自动生成代码了。
$ 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 └── v14 directories, 1 file
接下来我们就可以使用工具来生成我们所需要的代码了,首先我们生成types.go
所需要的内容,由于type-scaffold
不支持导入文本,所以生成后我们需要复制到types.go
文件中:
$ type-scaffold --kind Foo// FooSpec defines the desired state of Footype 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=truetype 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 Footype 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。
// register.go// +groupName=example.compackage v1import ("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方法即可:
// types.gopackage v1import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"// FooSpec defines the desired state of Footype FooSpec struct {// INSERT ADDITIONAL SPEC FIELDS -- desired state of clusterName 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=truetype 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 Footype FooList struct {metav1.TypeMeta `json:",inline"`metav1.ListMeta `json:"metadata,omitempty"`Items []Foo `json:"items"`}func init() {Scheme.AddKnownTypes(GroupVersion, &Foo{}, &FooList{})}
接下来就需要生成deepcopy.go文件了:
$ controller-gen object paths=./pkg/apis/example.com/v1/types.go
同样,我们使用controller-gen生成crd
:
$ mkdir config$ go mod tidy$ controller-gen crd paths=./... output:crd:dir=config/crd
这时候我们查看项目结构:
.├── config│ └── crd│ └── example.com_foos.yaml├── go.mod├── go.sum└── pkg └── apis └── example.com └── v1 ├── register.go ├── types.go └── zz_generated.deepcopy.go6 directories, 6 files
最后我们来进行验证,首先创建一个cr:
apiVersion: example.com/v1kind: Foometadata: name: crd-testspec: name: test replicas: 2
将crd和cr添加到集群后,我们来编写main.go文件来进行验证:
package mainimport ("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)}// 这边需要使用原始的 RESTClientconfig.APIPath = "/apis/"config.NegotiatedSerializer = v1.Codecconfig.GroupVersion = &v1.GroupVersionclient, 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)}//=======// 输出结果testtest2
关于“自动生成代码controller tool怎么使用”这篇文章的内容就介绍到这里,感谢各位的阅读!相信大家对“自动生成代码controller tool怎么使用”知识都有一定的了解,大家如果还想学习更多知识,欢迎关注编程网精选频道。
--结束END--
本文标题: 自动生成代码controller tool怎么使用
本文链接: https://www.lsjlt.com/news/329385.html(转载时请注明来源链接)
有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341
下载Word文档到电脑,方便收藏和打印~
2024-05-22
2024-05-22
2024-05-22
2024-05-21
2024-05-21
2024-05-21
2024-05-21
2024-05-21
2024-05-21
2024-05-21
回答
回答
回答
回答
回答
回答
回答
回答
回答
回答
0