自定義資源CRD使用介紹

Posted on by

介紹

Custom Resource Define簡稱 CRD，是 Kubernetes（v1.7+）為提高可擴展性，讓開發者去自定義資源的一種方式。

CRD 資源可以動態註冊到集群中，註冊完畢後，用戶可以通過 kubectl 來創建訪問這個自定義的資源對象，類似於操作 Pod 一樣。

不過需要註意的是 CRD 僅僅是資源的定義而已，需要一個對應的控制器去監聽 CRD 的各種事件來添加自定義的業務邏輯。

定義

如果說隻是對 CRD 資源本身進行 CRUD 操作的話，不需要 Controller 也是可以實現的，相當於就是隻有數據存入瞭 etcd 中，而沒有對這個數據的相關操作而已。

比如我們可以定義一個如下所示的 CRD 資源清單文件：

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  # name 必須匹配下面的spec字段：<plural>.<group>  
  name: foos.crd.example.com
  # for more information on the below annotation, please see
  # https://github.com/kubernetes/enhancements/blob/master/keps/sig-api-machinery/2337-k8s.io-group-protection/README.md
  annotations:
    "api-approved.kubernetes.io": "unapproved, experimental-only; please get an approval from Kubernetes API reviewers if you're trying to develop a CRD in the *.k8s.io or *.kubernetes.io groups"
spec:
  # group 名用於 REST API 中的定義： /apis/<group>/<version>
  group: crd.example.com
  # 列出自定義資源的所有 API 版本
  versions:
    - name: v1  # 版本名稱，比如v1，v1beta1
      served: true  # 是否開啟通過 REST APIs訪問 `/apis/<group>/<version>/...`
      storage: true # 必須將一個且隻有一個版本標記為存儲版本
      schema: # 定義自定義對象的聲明規范
        # schema used for validation
        openAPIV3Schema:
          type: object
          properties:
            spec:
              type: object
              properties:
                deploymentName:
                  type: string
                replicas:
                  type: integer
                  minimum: 1
                  maximum: 10
            status:
              type: object
              properties:
                availableReplicas:
                  type: integer
  names:
    # kind 是 sigular 的一個駝峰形式的定義，在資源清單中會使用
    kind: Foo
    # plural 名字用於 REST API 中的定義：/apis/<group>/<version>/<plural>    
    plural: foos
    # singular 名稱用於 CLI 操作或顯示的一個別名    
    singular: foo
    # shortNames 相當於縮寫形式    
    shortNames:
    - fo
  scope: Namespaced

這個地方的定義和我們定義普通的資源對象比較類似，我們可以隨意定義一個自定義的資源對象，但是在創建資源的時候，肯定不是任由我們隨意去編寫 YAML 文件的，當我們把上面的 CRD 文件提交給 Kubernetes 之後，Kubernetes 會對我們提交的聲明文件進行校驗，從定義可以看出 CRD 是基於OpenAPI v3 schem進行規范的。

當然這種校驗隻是對於字段的類型進行校驗，比較初級，如果想要更加復雜的校驗，這個時候就需要通過 Kubernetes 的 admission webhook 來實現瞭。關於校驗的更多用法，可以前往官方文檔查看。

現在我們可以直接使用kubectl來創建這個CRD資源清單：

$  kubectl apply -f crd.example.com_foos.yaml 
customresourcedefinition.apiextensions.k8s.io/foos.crd.example.com created

這個時候我們可以查看到集群中已經有我們定義的這個CRD資源對象瞭：

$ kubectl get crd | grep example
foos.crd.example.com                                  2022-05-11T05:28:51Z

這個時候一個新的 namespace 級別的 RESTful API 就會被創建：

/apis/crd/example.com/v1/namespaces/*/foos/...

接著我們就可以使用這個 API 端點來創建和管理自定義的對象，這些對象的類型就是上面創建的 CRD 對象規范中的foo。

現在在 Kubernetes 集群中我們就多瞭一種新的資源叫做foos.crd.example.com，我們就可以使用它來定義一個Foo資源對象瞭，這個自定義資源對象裡面可以包含的字段我們在定義的時候通過schema進行瞭規范，比如現在我們來創建一個如下所示的資源清單：

apiVersion: crd.example.com/v1
kind: Foo
metadata:
  name: example-foo
spec:
  deploymentName: example-foo
  replicas: 1

創建完成後我們就可以用kubectl來管理我們這裡創建的Foo對象瞭，比如：

kubectl get foo
NAME          AGE
example-foo   20m

在使用 kubectl 的時候，資源名稱是不區分大小寫的，我們可以使用 CRD 中定義的單數或者復數形式以及任何簡寫。

kubectl get foo example-foo -o yaml
apiVersion: crd.example.com/v1
kind: Foo
metadata:
  annotations:
    kubectl.kubernetes.io/last-applied-configuration: |
      {"apiVersion":"crd.example.com/v1","kind":"Foo","metadata":{"annotations":{},"name":"example-foo","namespace":"default"},"spec":{"deploymentName":"example-foo","replicas":1}}
  creationTimestamp: "2022-05-11T05:40:38Z"
  generation: 1
  name: example-foo
  namespace: default
  resourceVersion: "37605212"
  uid: 56d5b1d3-f6f9-4106-90c4-a0e3c7d130c0
spec:
  deploymentName: example-foo
  replicas: 1

就如上面我們說的，現在我們自定義的資源創建完成瞭，但是也隻是單純的把資源清單數據存入到瞭 etcd 中而已，並沒有什麼其他用處，因為我們沒有定義一個對應的控制器來處理相關的業務邏輯。

以上就是自定義資源CRD使用介紹的詳細內容，更多關於自定義資源CRD的資料請關註WalkonNet其它相關文章！

推薦閱讀：