controller-tool的簡單使用

李大鵝 發表於 2022-05-12

介紹

在上一篇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-genhelpgentype-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目錄下檢視。

image

接著我們就可以新建一個專案,來使用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"新增上就行。

當然自動生成只是一個模版,裡面的具體細節還是需要我們自己去填寫,比如我們填充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

最後我們來進行驗證,首先建立一個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