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

### 本篇概覽
- k8s系統中controller扮演著重要角色，開發自定義controller是深入學習和理解controller的有效途徑，《k8s自定義controller三部曲》系列會逐步完成一次完整的自定義controller實戰；

### 實戰概要
整個三部曲的目標如下：
1. 建立自定義API物件（Custom Resource Definition），名為**Student**；
2. 用程式碼生成工具生成informer和client相關程式碼；
3. 建立並執行自定義控制器，k8s環境中所有Student相關的"增、刪、改"操作都會被此控制器監聽到，可以根據實際需求在控制器中編寫業務程式碼；

### 環境資訊
- 實戰環境的版本資訊如下，請確保以下軟體都已執行正常（Etcd只是用來檢視資料的，可以選擇不裝），並且kubectl工具可以在k8s環境正常操作：
1. 作業系統 ：CentOS Linux release 7.6.1810
2. Kubernetes：1.13
3. Go版本：1.12
4. Etcd：3.3.1（檢視資料時用到，也可以不安裝）

### 本篇概要
- 本篇是三部曲的第一篇，我們先自定義一個API物件Student，然後讓k8s接收Student的定義，這樣我們在k8s建立Student物件時，k8s就能接收並儲存了，就像先有了pod定義，才能建立pod一樣；

### 原始碼下載
- 接下來詳細講述應用的編碼過程，如果您不想自己寫程式碼，也可以在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)

### 建立CRD
- 建立CRD的第一步是透過官方文件做初步瞭解，地址：https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#create-a-customresourcedefinition
- 登入可以執行kubectl命令的機器，建立student.yaml檔案，內容如下：
```yaml
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
  # metadata.name的內容是由"複數名.分組名"構成，如下，students是複數名，bolingcavalry.k8s.io是分組名
  name: students.bolingcavalry.k8s.io
spec:
  # 分組名，在REST API中也會用到的，格式是: /apis/分組名/CRD版本
  group: bolingcavalry.k8s.io
  # list of versions supported by this CustomResourceDefinition
  versions:
    - name: v1
      # 是否有效的開關.
      served: true
      # 只有一個版本能被標註為storage
      storage: true
  # 範圍是屬於namespace的
  scope: Namespaced
  names:
    # 複數名
    plural: students
    # 單數名
    singular: student
    # 型別名
    kind: Student
    # 簡稱，就像service的簡稱是svc
    shortNames:
    - stu
```

- 在student.yaml所在目錄執行命令 **kubectl apply -f student.yaml** ，即可在k8s環境建立Student的定義，今後如果發起對型別為 **Student** 的物件的處理，k8s的api server就能識別到該物件型別了，如下所示，可以用 **kubectl get crd** 和 **kubectl describe crd stu** 命令檢視更多細節， **stu** 是在student.yaml中定義的簡稱：

```shell
[root@master custom_controller]# kubectl apply -f student.yaml
customresourcedefinition.apiextensions.k8s.io/students.bolingcavalry.k8s.io created
[root@master custom_controller]# kubectl get crd
NAME                            CREATED AT
students.bolingcavalry.k8s.io   2019-03-30T13:33:13Z
[root@master custom_controller]# kubectl describe crd stu
Name:         students.bolingcavalry.k8s.io
Namespace:    
Labels:       <none>
Annotations:  kubectl.kubernetes.io/last-applied-configuration:
                {"apiVersion":"apiextensions.k8s.io/v1beta1","kind":"CustomResourceDefinition","metadata":{"annotations":{},"name":"students.bolingcavalry...
API Version:  apiextensions.k8s.io/v1beta1
Kind:         CustomResourceDefinition
Metadata:
  Creation Timestamp:  2019-03-30T13:33:13Z
  Generation:          1
  Resource Version:    292010
  Self Link:           /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/students.bolingcavalry.k8s.io
  UID:                 5e4ceb6e-52f0-11e9-96e1-000c29f1f9c9
  ...
  ..
  .
```

- 如果您已配置好etcdctl，可以訪問k8s的etcd上儲存的資料，那麼執行以下命令，就可以看到新的CRD已經儲存在etcd中了：

```shell
ETCDCTL_API=3 etcdctl --endpoints=https://127.0.0.1:2379 --cacert=/etc/kubernetes/pki/etcd/ca.crt --cert=/etc/kubernetes/pki/etcd/healthcheck-client.crt --key=/etc/kubernetes/pki/etcd/healthcheck-client.key get /registry/apiextensions.k8s.io/customresourcedefinitions/ --prefix
```

- 上述命令用來檢視路徑**/registry/apiextensions.k8s.io/customresourcedefinitions/**之下的所有鍵值對，可以見到剛才建立的CRD資訊，如下：

```shell
/registry/apiextensions.k8s.io/customresourcedefinitions/students.bolingcavalry.k8s.io{
    "kind": "CustomResourceDefinition",
    "apiVersion": "apiextensions.k8s.io/v1beta1",
    "metadata": {
        "name": "students.bolingcavalry.k8s.io",
        "uid": "5e4ceb6e-52f0-11e9-96e1-000c29f1f9c9",
        "generation": 1,
        "creationTimestamp": "2019-03-30T13:33:13Z",
        "annotations": {
            "kubectl.kubernetes.io/last-applied-configuration": "{\"apiVersion\":\"apiextensions.k8s.io/v1beta1\",\"kind\":\"CustomResourceDefinition\",\"metadata\":{\"annotations\":{},\"name\":\"students.bolingcavalry.k8s.io\"},\"spec\":{\"group\":\"bolingcavalry.k8s.io\",\"names\":{\"kind\":\"Student\",\"plural\":\"students\",\"shortNames\":[\"stu\"],\"singular\":\"student\"},\"scope\":\"Namespaced\",\"versions\":[{\"name\":\"v1\",\"served\":true,\"storage\":true}]}}\n"
        }
    },
    "spec": {
        "group": "bolingcavalry.k8s.io",
        "version": "v1",
        "names": {
            "plural": "students",
            "singular": "student",
            "shortNames": [
                "stu"
            ],
            "kind": "Student",
            "listKind": "StudentList"
        },
        "scope": "Namespaced",
        "versions": [
            {
                "name": "v1",
                "served": true,
                "storage": true
            }
        ],
        "conversion": {
            "strategy": "None"
        }
    },
    "status": {
        "conditions": [
            {
                "type": "NamesAccepted",
                "status": "True",
                "lastTransitionTime": "2019-03-30T13:33:13Z",
                "reason": "NoConflicts",
                "message": "no conflicts found"
            },
            {
                "type": "Established",
                "status": "True",
                "lastTransitionTime": null,
                "reason": "InitialNamesAccepted",
                "message": "the initial names have been accepted"
            }
        ],
        "acceptedNames": {
            "plural": "students",
            "singular": "student",
            "shortNames": [
                "stu"
            ],
            "kind": "Student",
            "listKind": "StudentList"
        },
        "storedVersions": [
            "v1"
        ]
    }
}
```

### 建立Student物件
- 前面的步驟使得k8s能識別Student型別了，接下來建立個Student物件試試；
- 建立object-student.yaml檔案，內容如下：

```yaml
apiVersion: bolingcavalry.k8s.io/v1
kind: Student
metadata:
  name: object-student
spec:
  name: "張三"
  school: "深圳中學"
```

- 在object-student.yaml檔案所在目錄執行命令 **kubectl apply -f object-student.yaml** ，會看到提示建立成功：

```shell
[root@master custom_controller]# kubectl apply -f object-student.yaml
student.bolingcavalry.k8s.io/object-student created
```

- 執行命令**kubectl get stu**可見已建立成功的Student物件：

```shell
[root@master custom_controller]# kubectl get stu
NAME             AGE
object-student   15s
```

- 建立成功的Stutend物件儲存在etcd中是什麼樣的呢，如果您的etcdctl已經配置好，執行以下命令即可：

```shell
ETCDCTL_API=3 etcdctl --endpoints=https://127.0.0.1:2379 --cacert=/etc/kubernetes/pki/etcd/ca.crt --cert=/etc/kubernetes/pki/etcd/healthcheck-client.crt --key=/etc/kubernetes/pki/etcd/healthcheck-client.key get /registry/bolingcavalry.k8s.io/students/default/object-student --print-value-only
```

- 控制檯輸出的就是該Student物件儲存在etcd中的內容，如下：

```shell
{
    "apiVersion": "bolingcavalry.k8s.io/v1",
    "kind": "Student",
    "metadata": {
        "annotations": {
            "kubectl.kubernetes.io/last-applied-configuration": "{\"apiVersion\":\"bolingcavalry.k8s.io/v1\",\"kind\":\"Student\",\"metadata\":{\"annotations\":{},\"name\":\"object-student\",\"namespace\":\"default\"},\"spec\":{\"name\":\"張三\",\"school\":\"深圳中學\"}}\n"
        },
        "creationTimestamp": "2019-03-31T02:56:25Z",
        "generation": 1,
        "name": "object-student",
        "namespace": "default",
        "uid": "92927d0d-5360-11e9-9d2a-000c29f1f9c9"
    },
    "spec": {
        "name": "張三",
        "school": "深圳中學"
    }
}
```

- 至此，自定義API物件（也就是CRD）就建立成功了，此刻我們只是讓k8s能識別到Student這個物件的身份，但是當我們建立Student物件的時候，還沒有觸發任何業務（相對於建立Pod物件的時候，會觸發kubelet在node節點建立docker容器），這也是後面的章節要完成的任務，點選連結進入下一段實戰： 《k8s自定義controller三部曲之二:自動生成程式碼》

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

k8s自定義controller三部曲之一:建立CRD（Custom Resource Definition）

相關文章