自動生成代碼controller?tool的簡單使用
更新時間：2022年05月13日 16:42:37 作者：李大鵝
這篇文章主要為大家介紹了自動生成代碼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到本地：
$ 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
└── v1
4 directories, 1 file
接下來我們就可以使用工具來生成我們所需要的代碼了,首先我們生成types.go所需要的內容，由于type-scaffold不支持導入文本，所以生成后我們需要復制到types.go文件中：
$ 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"添加上就行。
當然自動生成只是一個模版，里面的具體細節(jié)還是需要我們自己去填寫，比如我們填充FooSpec。
資源類型定義好了，那么如何能讓client-go識別我們的資源呢，這里就需要其注冊進去。我們可以在register.go中定義GV(Group Version),以及通過標簽指定groupName。
// 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方法即可：
// 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文件了：
$ 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.go
6 directories, 6 files
最后我們來進行驗證，首先創(chuàng)建一個cr：
apiVersion: example.com/v1 kind: Foo metadata: name: crd-test spec: name: test replicas: 2
將crd和cr添加到集群后，我們來編寫main.go文件來進行驗證：
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的資料請關注腳本之家其它相關文章！
相關文章
這篇文章主要介紹了Golang的語言結構和變量問題,在golang中定義變量的一般形式是使用 var 關鍵字，本文通過實例代碼給大家介紹的非常詳細，需要的朋友可以參考下2021-11-11
這篇文章主要為大家介紹了go?variant底層原理深入解析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-11-11
這篇文章主要介紹了Golang 時間和日期相關函數(shù),本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-12-12
前文我們介紹了如何進行 HTTP 調用，并通過 GET 請求的例子，講述了 query 參數(shù)和 header 參數(shù)如何設置，以及響應體的獲取方法。 本文繼上文，接下來會通過 POST 請求，對其他參數(shù)的設置進行介紹，感興趣的可以了解一下2022-12-12
Go語言拋棄C/C++中的開發(fā)者管理內存的方式,實現(xiàn)了主動申請與主動釋放管理,增加了逃逸分析和垃圾回收,將開發(fā)者從內存管理中釋放出來,作為進階的Go開發(fā),了解掌握Go的內存管理還是很有必要的2023-09-09
這篇文章主要介紹了Golang語言中的interface的相關資料，幫助大家更好的理解和使用golang，感興趣的朋友可以了解下2021-01-01
這篇文章主要為大家介紹了Go庫text與template包使用示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-12-12
這篇文章主要介紹了golang-gorm自動建表問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-02-02
Golang中fsnotify包監(jiān)聽文件變化的原理詳解
Golang提供了一個強大的fsnotify包,它能夠幫助我們輕松實現(xiàn)文件系統(tǒng)的監(jiān)控,本文將深入探討fsnotify包的原理,感興趣的小伙伴可以跟隨小編一起學習一下2023-12-12
這篇文章主要介紹了golang 通過ssh代理連接mysql的操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12