K8s Custom Resource Definitions (CRD) 开发与实践：扩展 Kubernetes 能力

好的，各位观众老爷们，各位未来的K8s架构师们，欢迎来到今天的“K8s CRD开发与实践：扩展 Kubernetes 能力”大型脱口秀…哦不，技术讲座！🎉

今天，咱们不聊八卦，不谈情怀，就聊聊Kubernetes里一个超级酷炫、功能强大的扩展机制：Custom Resource Definitions (CRD)。简单来说，有了CRD，你的K8s集群就像拥有了无限可能的乐高积木，想拼什么就拼什么！

开场白：K8s，你还能更强大吗？

大家应该都知道，Kubernetes（简称K8s）已经很牛逼了。它能帮你管理容器、自动伸缩、负载均衡，简直是云原生时代的瑞士军刀。但问题来了：世界上的应用千奇百怪，K8s自带的那些资源类型（Pod、Service、Deployment等等）并不能满足所有需求。

想象一下：你想在K8s里管理你的数据库集群，希望能够像管理Pod一样，通过YAML文件定义数据库的配置、备份策略、监控指标。K8s原生支持吗？肯定不支持啊！这就好像你用锤子想拧螺丝，力气再大也搞不定。🔨

这时候，CRD就闪亮登场了！它就像一个魔术棒，让你可以自定义资源类型，扩展K8s的能力，让它能管理任何你想管理的东西。

第一幕：CRD是什么？（揭开神秘面纱）

CRD全称是Custom Resource Definition，翻译过来就是“自定义资源定义”。它本质上是K8s的一个扩展机制，允许你定义自己的API对象。

资源（Resource）： 简单理解为K8s里可以管理的“东西”，比如Pod、Service都属于资源。
API对象（API Object）： 用来描述资源状态、配置信息的数据结构，通常以YAML或JSON格式存在。

CRD的作用就是告诉K8s：嘿，以后我要管理一种新的资源，它的名字叫啥，长啥样，都有哪些属性，你都要听我的！

你可以把CRD想象成一个类（Class），而Custom Resource (CR) 则是这个类的实例（Instance）。例如，你定义一个名为Database的CRD，那么你就可以创建多个Database的CR，每个CR代表一个具体的数据库实例。

第二幕：为什么要用CRD？（好处多多）

扩展性： 这是CRD最核心的价值。它可以让你根据自己的业务需求，定制K8s的行为，让它更好地服务于你的应用。
声明式API： CRD也遵循K8s的声明式API风格。你只需要定义期望的状态，K8s会自动帮你达成目标。这比手动编写脚本、配置工具要方便得多。
与K8s生态集成： 通过CRD定义的资源，可以像原生资源一样，使用kubectl等工具进行管理。你还可以利用K8s的各种特性，比如RBAC权限控制、监控告警等等。
可重用性： 如果你开发了一个通用的CRD，可以分享给其他人使用，让更多人受益。

举个栗子： 假设你想管理一个叫做MyApp的自定义应用，你需要定义它的配置、版本、部署策略等等。有了CRD，你就可以定义一个MyApp的资源类型，然后用YAML文件描述每个MyApp实例的配置，最后交给K8s去管理。

第三幕：如何开发一个CRD？（手把手教学）

开发CRD主要分为两步：

定义CRD YAML文件： 这是最关键的一步，你需要告诉K8s你的CRD的各种属性。
安装CRD到K8s集群： 将YAML文件应用到集群，让K8s知道你的CRD的存在。

3.1 定义CRD YAML文件

CRD的YAML文件有很多字段，但最重要的是以下几个：

apiVersion: apiextensions.k8s.io/v1 (或v1beta1，但推荐使用v1)
kind: CustomResourceDefinition
metadata:
- name: CRD的名称，通常是plural.group的形式。
spec:
- group: API组，例如example.com
- versions: API版本列表，每个版本定义了资源的不同结构。
  - name: 版本名称，例如v1
  - schema: 定义资源结构的JSON Schema。
  - served: 是否启用此版本。
  - storage: 是否将此版本作为存储版本。
- scope: 资源的作用域，可以是Namespaced（命名空间级别）或Cluster（集群级别）。
- names:
  - plural: 资源的复数名称，例如myapps
  - singular: 资源的单数名称，例如myapp
  - kind: 资源的Kind，例如MyApp
  - shortNames: 资源的短名称，例如app

一个典型的CRD YAML文件如下所示：

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: myapps.example.com
spec:
  group: example.com
  versions:
  - name: v1
    schema:
      openAPIV3Schema:
        type: object
        properties:
          spec:
            type: object
            properties:
              size:
                type: integer
                minimum: 1
              image:
                type: string
              config:
                type: object
    served: true
    storage: true
  scope: Namespaced
  names:
    plural: myapps
    singular: myapp
    kind: MyApp
    shortNames:
    - app

字段解释：

metadata.name: 定义了CRD的名称，这里是myapps.example.com，表示我们要定义一个名为MyApp的资源，它属于example.com这个API组。
spec.group: 定义了API组，这里是example.com。
spec.versions: 定义了API版本，这里只有一个版本v1。每个版本可以有不同的Schema，方便你进行API的演进。
spec.versions[0].schema.openAPIV3Schema: 这是最重要的部分，定义了资源的结构。这里使用JSON Schema来描述MyApp的属性。
- spec.size: 表示MyApp的实例数量，类型是整数，最小值是1。
- spec.image: 表示MyApp使用的镜像，类型是字符串。
- spec.config: 表示MyApp的配置，类型是对象，可以包含更复杂的配置信息。
spec.scope: 定义了资源的作用域，这里是Namespaced，表示MyApp资源只能在特定的命名空间中使用。
spec.names: 定义了资源的各种名称，方便你使用kubectl等工具进行管理。

重点：JSON Schema

JSON Schema是定义CRD资源结构的关键。它可以让你精确地描述资源的属性类型、约束条件等等。

例如，你可以使用type来指定属性的类型（string, integer, boolean, object, array等等），使用minimum, maximum来限制数值的范围，使用pattern来定义字符串的格式，使用enum来定义枚举值等等。

3.2 安装CRD到K8s集群

有了CRD的YAML文件，就可以把它应用到K8s集群了：

kubectl apply -f myapp-crd.yaml

安装成功后，你就可以使用kubectl get crds命令来查看你定义的CRD：

kubectl get crds myapps.example.com

第四幕：创建Custom Resource（让资源活起来）

有了CRD，你就可以创建Custom Resource (CR) 了。CR就是CRD定义的资源的实例。

创建一个MyApp资源的YAML文件：

apiVersion: example.com/v1
kind: MyApp
metadata:
  name: my-app-instance
spec:
  size: 3
  image: nginx:latest
  config:
    port: 8080
    env:
      - name: MY_VAR
        value: "my_value"

字段解释：

apiVersion: 必须与CRD中定义的group和version一致。
kind: 必须与CRD中定义的kind一致。
metadata.name: CR的名称。
spec: CR的属性，必须符合CRD中定义的JSON Schema。

将CR应用到K8s集群：

kubectl apply -f my-app-instance.yaml

现在，你可以使用kubectl get myapps命令来查看你创建的MyApp资源：

kubectl get myapps

第五幕：Operator（让资源更智能）

仅仅定义CRD和CR是不够的。你还需要一个Controller来监听CR的变化，并根据CR的配置来执行相应的操作。这个Controller通常被称为Operator。

Operator是什么？

Operator是一种特殊的Controller，它专门用来管理CRD定义的资源。Operator的核心思想是将运维知识编码到软件中，实现自动化运维。

Operator的工作原理：

监听CR： Operator会持续监听K8s集群中CR的变化，例如创建、更新、删除。
协调（Reconcile）： 当CR发生变化时，Operator会执行协调逻辑，根据CR的配置来创建、更新、删除其他的K8s资源，例如Pod、Service、Deployment等等，最终使集群状态与CR的期望状态一致。

开发Operator：

开发Operator有很多种方式，例如：

使用Kubebuilder： Kubebuilder是一个用于快速构建K8s Operator的框架。它可以帮你生成Operator的代码框架，并提供一些常用的工具和库。
使用Operator Framework： Operator Framework是Red Hat推出的一个Operator开发框架，它提供了一些高级特性，例如OLM（Operator Lifecycle Manager），可以简化Operator的部署和升级。
手动编写Controller： 你也可以手动编写Controller，但这种方式比较复杂，需要处理很多底层细节。

一个简单的Operator示例（伪代码）：

# 监听MyApp资源的变化
def watch_my_app():
    while True:
        # 获取所有MyApp资源
        my_apps = get_my_apps()

        # 遍历每个MyApp资源
        for my_app in my_apps:
            # 协调MyApp资源
            reconcile_my_app(my_app)

        # 休眠一段时间
        time.sleep(10)

# 协调MyApp资源
def reconcile_my_app(my_app):
    # 获取MyApp的期望状态
    desired_state = my_app.spec

    # 获取MyApp的当前状态
    current_state = get_current_state(my_app)

    # 比较期望状态和当前状态
    diff = compare_states(desired_state, current_state)

    # 根据差异执行相应的操作
    if diff.needs_create():
        create_resources(my_app)
    elif diff.needs_update():
        update_resources(my_app)
    elif diff.needs_delete():
        delete_resources(my_app)

第六幕：进阶技巧（更上一层楼）

Validating Webhook： 在CR创建或更新时，可以使用Validating Webhook来验证CR的合法性。这可以防止用户提交错误的配置。
Mutating Webhook： 在CR创建或更新时，可以使用Mutating Webhook来修改CR的配置。这可以用来添加默认值、自动生成一些属性等等。
CRD转换Webhook： 当CRD的版本升级时，可以使用CRD转换Webhook来自动转换CR的格式。这可以保证CR的兼容性。
代码生成： 可以使用代码生成工具，例如controller-gen，从Go代码生成CRD的YAML文件。这可以减少手动编写YAML文件的错误。

第七幕：最佳实践（避免踩坑）

选择合适的API组和版本： API组应该与你的组织或项目相关，版本号应该遵循语义化版本规范。
设计清晰的资源结构： 资源的属性应该尽量简洁、易懂，避免过度设计。
编写完善的JSON Schema： JSON Schema应该尽可能地覆盖所有可能的配置情况，并添加必要的约束条件。
测试你的CRD和Operator： 在发布之前，一定要进行充分的测试，确保CRD和Operator的稳定性和可靠性。
考虑安全性： CRD可能会暴露一些敏感信息，要注意保护CRD的安全性，例如使用RBAC进行权限控制。

总结陈词：CRD，K8s的无限可能

CRD是K8s一个非常强大的扩展机制，它可以让你根据自己的业务需求，定制K8s的行为，让它更好地服务于你的应用。

虽然CRD的学习曲线比较陡峭，但只要你掌握了基本概念和开发流程，就能充分利用CRD的优势，打造出属于你自己的K8s生态。

希望今天的讲座对大家有所帮助！下次再见！ 👋

发表回复 取消回复

发表回复取消回复