自定義資源CRD使用介紹

更新時(shí)間：2022年05月13日 17:17:44 作者：李大鵝

這篇文章主要為大家介紹了自定義資源CRD的使用示例介紹，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

介紹

Custom Resource Define簡(jiǎn)稱 CRD，是 Kubernetes（v1.7+）為提高可擴(kuò)展性，讓開(kāi)發(fā)者去自定義資源的一種方式。

CRD 資源可以動(dòng)態(tài)注冊(cè)到集群中，注冊(cè)完畢后，用戶可以通過(guò) kubectl 來(lái)創(chuàng)建訪問(wèn)這個(gè)自定義的資源對(duì)象，類似于操作 Pod 一樣。

不過(guò)需要注意的是 CRD 僅僅是資源的定義而已，需要一個(gè)對(duì)應(yīng)的控制器去監(jiān)聽(tīng) CRD 的各種事件來(lái)添加自定義的業(yè)務(wù)邏輯。

定義

如果說(shuō)只是對(duì) CRD 資源本身進(jìn)行 CRUD 操作的話，不需要 Controller 也是可以實(shí)現(xiàn)的，相當(dāng)于就是只有數(shù)據(jù)存入了 etcd 中，而沒(méi)有對(duì)這個(gè)數(shù)據(jù)的相關(guān)操作而已。

比如我們可以定義一個(gè)如下所示的 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  # 是否開(kāi)啟通過(guò) REST APIs訪問(wèn) `/apis/<group>/<version>/...`
      storage: true # 必須將一個(gè)且只有一個(gè)版本標(biāo)記為存儲(chǔ)版本
      schema: # 定義自定義對(duì)象的聲明規(guī)范
        # 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 的一個(gè)駝峰形式的定義，在資源清單中會(huì)使用
    kind: Foo
    # plural 名字用于 REST API 中的定義：/apis/<group>/<version>/<plural>    
    plural: foos
    # singular 名稱用于 CLI 操作或顯示的一個(gè)別名    
    singular: foo
    # shortNames 相當(dāng)于縮寫(xiě)形式    
    shortNames:
    - fo
  scope: Namespaced

這個(gè)地方的定義和我們定義普通的資源對(duì)象比較類似，我們可以隨意定義一個(gè)自定義的資源對(duì)象，但是在創(chuàng)建資源的時(shí)候，肯定不是任由我們隨意去編寫(xiě) YAML 文件的，當(dāng)我們把上面的 CRD 文件提交給 Kubernetes 之后，Kubernetes 會(huì)對(duì)我們提交的聲明文件進(jìn)行校驗(yàn)，從定義可以看出 CRD 是基于OpenAPI v3 schem進(jìn)行規(guī)范的。

當(dāng)然這種校驗(yàn)只是對(duì)于字段的類型進(jìn)行校驗(yàn)，比較初級(jí)，如果想要更加復(fù)雜的校驗(yàn)，這個(gè)時(shí)候就需要通過(guò) Kubernetes 的 admission webhook 來(lái)實(shí)現(xiàn)了。關(guān)于校驗(yàn)的更多用法，可以前往官方文檔查看。

現(xiàn)在我們可以直接使用kubectl來(lái)創(chuàng)建這個(gè)CRD資源清單：

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

這個(gè)時(shí)候我們可以查看到集群中已經(jīng)有我們定義的這個(gè)CRD資源對(duì)象了：

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

這個(gè)時(shí)候一個(gè)新的 namespace 級(jí)別的 RESTful API 就會(huì)被創(chuàng)建：

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

接著我們就可以使用這個(gè) API 端點(diǎn)來(lái)創(chuàng)建和管理自定義的對(duì)象，這些對(duì)象的類型就是上面創(chuàng)建的 CRD 對(duì)象規(guī)范中的foo。

現(xiàn)在在 Kubernetes 集群中我們就多了一種新的資源叫做foos.crd.example.com，我們就可以使用它來(lái)定義一個(gè)Foo資源對(duì)象了，這個(gè)自定義資源對(duì)象里面可以包含的字段我們?cè)诙x的時(shí)候通過(guò)schema進(jìn)行了規(guī)范，比如現(xiàn)在我們來(lái)創(chuàng)建一個(gè)如下所示的資源清單：

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

創(chuàng)建完成后我們就可以用kubectl來(lái)管理我們這里創(chuàng)建的Foo對(duì)象了，比如：

kubectl get foo
NAME          AGE
example-foo   20m

在使用 kubectl 的時(shí)候，資源名稱是不區(qū)分大小寫(xiě)的，我們可以使用 CRD 中定義的單數(shù)或者復(fù)數(shù)形式以及任何簡(jiǎn)寫(xiě)。

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

就如上面我們說(shuō)的，現(xiàn)在我們自定義的資源創(chuàng)建完成了，但是也只是單純的把資源清單數(shù)據(jù)存入到了 etcd 中而已，并沒(méi)有什么其他用處，因?yàn)槲覀儧](méi)有定義一個(gè)對(duì)應(yīng)的控制器來(lái)處理相關(guān)的業(yè)務(wù)邏輯。

以上就是自定義資源CRD使用介紹的詳細(xì)內(nèi)容，更多關(guān)于自定義資源CRD的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: