### 歡迎訪問我的GitHub
> 這裡分類和彙總了欣宸的全部原創(含配套原始碼)：[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos)

- 本文是《k8s自定義controller三部曲》的第二篇，上一篇我們在k8s環境註冊了API物件Student，此時如果建立Student物件就會在etcd儲存該物件資訊；
### 三部曲所有文章連結
1. [《k8s自定義controller三部曲之一:建立CRD（Custom Resource Definition）》](https://blog.csdn.net/boling_cavalry/article/details/88917818)；
2. [《k8s自定義controller三部曲之二:自動生成程式碼》](https://blog.csdn.net/boling_cavalry/article/details/88924194)；
3. [《k8s自定義controller三部曲之三：編寫controller程式碼》](https://blog.csdn.net/boling_cavalry/article/details/88934063)；

### 原始碼下載
- 接下來詳細講述應用的編碼過程，如果您不想自己寫程式碼，也可以在GitHub下載完整的應用原始碼，地址和連結資訊如下表所示：

| 名稱      |   連結 |   備註|
| :-------- | :----| :----|
| 專案主頁| https://github.com/zq2599/blog_demos | 該專案在GitHub上的主頁 |
| git倉庫地址(https)| https://github.com/zq2599/blog_demos.git | 該專案原始碼的倉庫地址，https協議 |
| git倉庫地址(ssh)| git@github.com:zq2599/blog_demos.git | 該專案原始碼的倉庫地址，ssh協議 |

- 這個git專案中有多個資料夾，本章原始碼在k8s_customize_controller這個資料夾下，如下圖紅框所示：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190401000525549.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)
### 為什麼要做controller
- 但如果僅僅是在etcd儲存Student物件是沒有什麼意義的，試想透過deployment建立pod時，如果只在etcd建立pod物件，而不去node節點建立容器，那這個pod物件只是一條資料而已，沒有什麼實質性作用，其他物件如service、pv也是如此；
    controller的作用就是監聽指定物件的新增、刪除、修改等變化，針對這些變化做出相應的響應（例如新增pod的響應為建立docker容器），關於controller的詳細設計，最好的參考就是Harry (Lei) Zhang老師在twitter上的分享，如下圖，地址是：https://twitter.com/resouer/status/1009996649832185856
    ![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190331114526283.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 如上圖，API物件的變化會透過Informer存入佇列（WorkQueue），在Controller中消費佇列的資料做出響應，響應相關的具體程式碼就是我們要做的真正業務邏輯；

### 自動生成程式碼是什麼
- 從上圖可以發現整個邏輯還是比較複雜的，為了簡化我們的自定義controller開發，k8s的大師們利用自動程式碼生成工具將controller之外的事情都做好了，我們只要專注於controller的開發就好。
- 關於controller的程式碼我們留待下一章完成，本章關注的是如何自動生成程式碼的實戰，將上圖中controller之外的事情都完成了；

### 開始實戰
- 接下來要做的事情就是編寫API物件Student相關的宣告的定義程式碼，然後用程式碼生成工具結合這些程式碼，自動生成Client、Informet、WorkQueue相關的程式碼；
- 在\$GOPATH/src/目錄下建立一個資料夾 **k8s_customize_controller** ：
- 進入資料夾k8s_customize_controller，執行如下命令建立三層目錄：

```shell
mkdir -p pkg/apis/bolingcavalry
```

- 在新建的bolingcavalry目錄下建立檔案**register.go**，內容如下：

```go
package bolingcavalry

const (
        GroupName = "bolingcavalry.k8s.io"
        Version   = "v1"
)
```

- 在新建的bolingcavalry目錄下建立名為**v1**的資料夾；
- 在新建的v1資料夾下建立檔案**doc.go**，內容如下：

```go
// +k8s:deepcopy-gen=package

// +groupName=bolingcavalry.k8s.io
package v1
```

- 上述程式碼中的兩行註釋，都是程式碼生成工具會用到的，一個是宣告為整個v1包下的型別定義生成DeepCopy方法，另一個宣告瞭這個包對應的API的組名，和CRD中的組名一致；
- 在v1資料夾下建立檔案**types.go**，裡面定義了Student物件的具體內容：

```go
package v1

import (
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// +genclient
// +genclient:noStatus
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

type Student struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              StudentSpec `json:"spec"`
}

type StudentSpec struct {
	name   string `json:"name"`
	school string `json:"school"`
}

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

// StudentList is a list of Student resources
type StudentList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

Items []Student `json:"items"`
}
```
- 從上述原始碼可見，Student物件的內容已經被設定好，主要有name和school這兩個欄位，表示學生的名字和所在學校，因此建立Student物件的時候內容就要和這裡匹配了；
- 在v1目錄下建立register.go檔案，此檔案的作用是透過addKnownTypes方法使得client可以知道Student型別的API物件：

```go
package v1

import (
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/runtime"
	"k8s.io/apimachinery/pkg/runtime/schema"

"k8s_customize_controller/pkg/apis/bolingcavalry"
)

var SchemeGroupVersion = schema.GroupVersion{
	Group:   bolingcavalry.GroupName,
	Version: bolingcavalry.Version,
}

var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

func Resource(resource string) schema.GroupResource {
	return SchemeGroupVersion.WithResource(resource).GroupResource()
}

func Kind(kind string) schema.GroupKind {
	return SchemeGroupVersion.WithKind(kind).GroupKind()
}

func addKnownTypes(scheme *runtime.Scheme) error {
	scheme.AddKnownTypes(
		SchemeGroupVersion,
		&Student{},
		&StudentList{},
	)

// register the type in the scheme
	metav1.AddToGroupVersion(scheme, SchemeGroupVersion)
	return nil
}
```

- 至此，為自動生成程式碼做的準備工作已經完成了，目前為止，$GOPATH/src目錄下的檔案和目錄結構是這樣的：

```shell
[root@golang src]# tree
.
└── k8s_customize_controller
    └── pkg
        └── apis
            └── bolingcavalry
                ├── register.go
                └── v1
                    ├── doc.go
                    ├── register.go
                    └── types.go

5 directories, 4 files
```

- 執行以下命令，會先下載依賴包，再下載程式碼生成工具，再執行程式碼生成工作：

```shell
cd $GOPATH/src \
&& go get -u k8s.io/apimachinery/pkg/apis/meta/v1 \
&& go get -u k8s.io/code-generator/... \
&& cd $GOPATH/src/k8s.io/code-generator \
&& ./generate-groups.sh all \
k8s_customize_controller/pkg/client \
k8s_customize_controller/pkg/apis \
bolingcavalry:v1
```

- 如果程式碼寫得沒有問題，會看到以下輸出：

```shell
Generating deepcopy funcs
Generating clientset for bolingcavalry:v1 at k8s_customize_controller/pkg/client/clientset
Generating listers for bolingcavalry:v1 at k8s_customize_controller/pkg/client/listers
Generating informers for bolingcavalry:v1 at k8s_customize_controller/pkg/client/informers
```

- 此時再去\$GOPATH/src/k8s_customize_controller目錄下執行tree命令，可見已生成了很多內容：

```shell
[root@master k8s_customize_controller]# tree
.
└── pkg
    ├── apis
    │   └── bolingcavalry
    │       ├── register.go
    │       └── v1
    │           ├── doc.go
    │           ├── register.go
    │           ├── types.go
    │           └── zz_generated.deepcopy.go
    └── client
        ├── clientset
        │   └── versioned
        │       ├── clientset.go
        │       ├── doc.go
        │       ├── fake
        │       │   ├── clientset_generated.go
        │       │   ├── doc.go
        │       │   └── register.go
        │       ├── scheme
        │       │   ├── doc.go
        │       │   └── register.go
        │       └── typed
        │           └── bolingcavalry
        │               └── v1
        │                   ├── bolingcavalry_client.go
        │                   ├── doc.go
        │                   ├── fake
        │                   │   ├── doc.go
        │                   │   ├── fake_bolingcavalry_client.go
        │                   │   └── fake_student.go
        │                   ├── generated_expansion.go
        │                   └── student.go
        ├── informers
        │   └── externalversions
        │       ├── bolingcavalry
        │       │   ├── interface.go
        │       │   └── v1
        │       │       ├── interface.go
        │       │       └── student.go
        │       ├── factory.go
        │       ├── generic.go
        │       └── internalinterfaces
        │           └── factory_interfaces.go
        └── listers
            └── bolingcavalry
                └── v1
                    ├── expansion_generated.go
                    └── student.go

21 directories, 27 files
```

- 如上所示，zz_generated.deepcopy.go就是DeepCopy程式碼檔案，client目錄下的內容都是客戶端相關程式碼，在開發controller時會用到；
- client目錄下的clientset、informers、listers的身份和作用可以和前面的圖結合來理解；

- 至此，自動生成程式碼的步驟已經完成，我們已經為後面編寫controller做好了充分的準備，接下來的章節就是編寫controller了，點選連結繼續實戰：[《k8s自定義controller三部曲之三：編寫controller程式碼》](https://blog.csdn.net/boling_cavalry/article/details/88934063)

### 歡迎關注ITpub：程式設計師欣宸
> [學習路上，你不孤單，欣宸原創一路相伴...](http://blog.itpub.net/70017844/)

k8s自定義controller三部曲之二:自動生成程式碼

相關文章