如何在k8s中使用自定义资源（1）概念

2022-08-04

文本是系列文章第一篇，讲述如何在k8s中使用自定义资源

资源是什么

我们应该先明确一个概念，在 k8s 中资源是什么？尽管有很多人曾经编写过自定义资源，但是对于什么是资源并没有很清楚的认知。在官网中的定义

A resource is an endpoint in the Kubernetes API that stores a collection of API objects of a certain kind; for example, the built-in pods resource contains a collection of Pod objects.

资源（Resource）是 Kubernetes API 中的一个端点，其中存储的是某个类别的 API 对象的一个集合。例如内置的 pods 资源包含一组 Pod 对象。

k8s 中的所有内容都被抽象为资源，如 Pod、Service、Node 等都是资源。对象是资源的实例，是持久化的实体。如某个具体的 Pod、某个具体的 Node。k8s 使用这些实体去表示整个集群的状态。对象的创建、删除、修改都是通过 Kubernetes API ，也就是 Api Server 组件提供的 API 接口，这些是 RESTful 风格的 Api，与 k8s 的万物皆对象理念相符。命令行工具 kubectl，实际上也是调用 kubernetes api。K8s 中的资源类别有很多种，kubectl 可以通过 apply命令通过配置文件来创建这些对象，配置文件更像是描述对象属性的文件，配置文件格式可以是 JSON 或 YAML。

自定义资源是什么

A custom resource is an extension of the Kubernetes API that is not necessarily available in a default Kubernetes installation. It represents a customization of a particular Kubernetes installation. However, many core Kubernetes functions are now built using custom resources, making Kubernetes more modular.

自定义资源（Custom Resource）是对 Kubernetes API 的扩展，不一定在默认的 Kubernetes 安装中就可用。自定义资源所代表的是对特定 Kubernetes 安装的一种定制。不过，很多 Kubernetes 核心功能现在都用自定义资源来实现，这使得 Kubernetes 更加模块化。

创建自定义资源

创建CustomResourceDefinition（CRD）

首先我们需要编写一个 CRD 文件，顾名思义，CRD是 CustomResource`的定义文件，它规定了要创建的自定义资源的各种属性。

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  # 名字必需与下面的 spec 字段匹配，并且格式为 '<名称的复数形式>.<组名>'
  name: ufos.ufocontroller.chimission.io
spec:
  # 组名称，用于 REST API: /apis/<组>/<版本>
  group: ufocontroller.chimission.io
  # 列举此 CustomResourceDefinition 所支持的版本
  versions:
    - name: v1
      # 每个版本都可以通过 served 标志来独立启用或禁止
      served: true
      # 其中一个且只有一个版本必需被标记为存储版本
      storage: true
      schema:
        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
  # 可以是 Namespaced 或 Cluster
  scope: Namespaced
  names:
    # 名称的复数形式，用于 URL：/apis/<组>/<版本>/<名称的复数形式>
    plural: ufos
    # 名称的单数形式，作为命令行使用时和显示时的别名
    singular: ufo
    # kind 通常是单数形式的帕斯卡编码（PascalCased）形式。你的资源清单会使用这一形式。
    kind: Ufo
    # shortNames 允许你在命令行使用较短的字符串来匹配资源
    shortNames:
    - uu

这里我们定义了一个名字叫 Ufo 的资源类型 :-) ，它是一个类型名字，相当于 class name，它有两个属性字段 deploymentName 和 replicas。后面我会用这个自定义资源来控制和 deploymentName 同名的 deployment，将其下的 Pod 数量调整到 replicas 指定数量。

其他字段含义:

group：设置API所属的组，将其映射为API URL中的“/apis/”下一级目录。它是逻辑上相关的Kinds集合
scope：该API的生效范围，可选项为 Namespaced 和 Cluster。
version：每个Group可以存在多个版本。例如，v1alpha1，然后升为v1beta1，最后稳定为v1版本。
names：CRD的名称，包括单数、复数、kind、所属组等名称定义

在这个CRD中，我指定了group: ufocontroller.chimission.io，version: v1这样的API信息，也指定了这个CR的资源类型叫作Ufo，复数（plural）是 ufos。

之后创建它：

kubectl apply -f resourcedefinition.yaml

看下结果：

这样一个新的受 namespace 约束的资源类型会被创建，k8s 就可以认识 Ufo 这种类型的自定义资源了。

创建CustomResource（CR）

创建CRD之后我们就可以创建CR了

apiVersion: ufocontroller.chimission.io/v1
kind: Ufo
metadata:
  name: example-ufo
spec:
  deploymentName: example-ufo
  replicas: 3

deploymentName 和 replicas 就是上面我们在定义 CRD 时规定的字段，这个文件对应的 example-ufo 这个对象里有两个属性， deploymentName 和 replicas ，值分别是 example-ufo 和 3，后面我们会用到这两个属性。

然后我们运行:

k apply -f cr.yml

这里我们创建了一个 Ufo 对象，命名为 example-ufo，

看下结果：

一个完整的 CR 就被我们创建了出来。但是仅仅只有一个CR对象并没有什么用，它仅仅是安静的躺在 etcd 中。接下来我们要做一些写代码的工作，让这个 Ufo 动起来，做一些类似 deployment 这种对象的工作。

Tags for this post: k8s

Prev: 通过钉钉机器人自动化报警运维

Next: 如何在k8s中使用自定义资源（2）原理