17-Custom Resource 入门

Custom Resource 入门概念引入到目前为止你已经用过十几种 K8s 内置资源了——Pod、Deployment、Service、Ingress、NetworkPolicy……但你知道 K8s 还能自定义资源类型吗K8s 内置了 Deployment、Service、ConfigMap 等资源。但每个公司的业务需求千差万别——K8s 不可能内置所有资源类型。Custom Resource Definition (CRD) 让你自己定义新的资源类型然后像操作 Deployment 一样用 kubectl 管理它K8s 内置资源 你自定义的资源 ───────────── ────────────────── Deployment MySQLCluster Service TLSStore ConfigMap AlertRule Pod DataPipeline你定义的K8s 内置kubectl apply -fkubectl apply -fDeploymentServiceConfigMapMySQLCluster你的 CRDAlertRule你的 CRDetcd和其他资源一样存储学完本篇你将能够编写 CRD YAML定义一个全新的 K8s 资源类型含字段和验证规则创建、查询、删除 Custom Resource 实例像操作 Deployment 一样用 kubectl 管理理解 CRD 与 Operator 的关系为后续学习 Operator 打基础原理讲解CRD CR 自定义资源两个概念需要区分概念全称作用类比CRDCustom Resource Definition定义类型模板数据库建表CREATE TABLECRCustom Resource类型的实例数据插入数据INSERT INTO创建实例CR定义类型CRD定义结构定义结构kind: CustomResourceDefinition定义字段、验证规则kind: MySQLClustername: prod-dbreplicas: 3kind: MySQLClustername: staging-dbreplicas: 1创建一个简单的 CRDapiVersion:apiextensions.k8s.io/v1kind:CustomResourceDefinitionmetadata:name:websiteinfos.example.com# plural.groupspec:group:example.com# API 组versions:-name:v1served:truestorage:trueschema:openAPIV3Schema:type:objectproperties:spec:type:objectproperties:url:type:stringmaintainer:type:stringreplicas:type:integerminimum:1maximum:10required:[url]scope:Namespaced# 或 Clusternames:plural:websiteinfos# kubectl get websiteinfossingular:websiteinfo# kubectl get websiteinfo/xxxkind:WebsiteInfo# YAML 中 kind 的值shortNames:# kubectl get wi-wiCRD 关键配置字段含义示例groupAPI 组自定义的必须用非 k8s.io 域名example.comscopeNamespacedNamespace 隔离或Cluster集群级Namespacednames.plural复数名用于 URL 路径websiteinfosnames.kind资源类型名YAML 中的 kindWebsiteInfoversions支持的 API 版本列表v1,v1beta1schema用 OpenAPI v3 Schema 验证 CR 字段JSON Schema操作 CRCRD 创建后就可以像操作内置资源一样操作自定义资源apiVersion:example.com/v1kind:WebsiteInfometadata:name:my-blogspec:url:https://myblog.commaintainer:bgreplicas:3# 增删改查——和 Deployment 完全一样的命令kubectl apply-fwebsiteinfo.yaml kubectl get websiteinfos# 或简写 kubectl get wikubectl get wi my-blog-oyaml kubectl describe wi my-blog kubectl delete wi my-blogCRD 有什么用光有 CRD 只是把数据存到 etcd。要让 CR 真正驱动自动化操作——你需要Controller控制器CRD 只是数据模型 → 定义了数据库表结构 CRD Controller Operator → 你的自定义自动化平台kubectl apply CRCR 变更事件调和Reconcile创建 Pod/Service/等你etcdController你的自定义逻辑K8s APIOperator 框架如 kubebuilder, operator-sdk帮你生成 CRD 和 Controller 脚手架但本篇只讲 CRD——理解数据模型是后续 Operator 开发的基础。动手实验配套实验位于docs/labs/beginner/custom-resource/步骤 1部署实验环境cddocs/labs/beginner/custom-resourcebashsetup.sh步骤 2创建 CRDkubectl apply-fmanifests/websiteinfo-crd.yaml kubectl get crd# 输出中包含 websiteinfos.example.com# 查看 API 资源列表你的 CRD 已在其中kubectl api-resources|grepexample步骤 3创建自定义资源实例kubectl apply-fmanifests/my-website.yaml kubectl get websiteinfos kubectl get wi# 简写也可以步骤 4体验 CRD 的验证能力# 尝试创建一个无效的 CRreplicas: 100 超过了 maximum: 10kubectl apply-fmanifests/invalid-website.yaml# 预期错误信息指出 replicas 超过了最大值步骤 5查看和删除kubectl describe wi my-blog kubectl get wi my-blog-oyaml kubectl delete wi my-blog步骤 6清理bashteardown.sh自检问题[基础]CRD 和 CR 的区别是什么用数据库类比解释。[理解]如果只有一个 CRD 没有 Controller它能做什么不能做什么[应用]你公司想用 K8s 管理 MySQL 集群——创建一个MySQLClusterCR设置replicas: 3主从自动配置备份自动执行。哪些部分靠 CRD哪些部分靠 Controller查看答案CRD 建表语句DDL定义字段类型、约束、验证规则。CR 插入的数据行DML是符合 CRD 定义的实例。一个 CRD 可以有多个 CR 实例就像一张表可以有多行数据。有 CRD 没有 Controller你可以用kubectl apply/get/describe/delete操作 CR数据被存储在 etcd 中CRD 的 Schema 验证会生效字段类型、必填等。但它不会驱动任何实际操作——不会创建 Pod、不会配置网络、不会做任何自动化。就像一个数据库表你可以插入数据但没有程序来读取这些数据做事情。CRD 负责定义数据模型——MySQLCluster 的结构spec: replicas, version, storagesize; status: readyReplicas, primaryNode。Controller 负责所有自动化逻辑——创建 StatefulSet、配置主从复制、执行定时备份、更新 status、处理故障切换。CRD 你要什么Controller 怎么做到。两者结合就是 MySQL Operator。下一步你已经能扩展 K8s 的 API 了。接下来学习一种不同于 Helm 的配置管理方式→ 28. Kustomize 配置管理 本文来自 K8s Guide —— 开源免费的 Kubernetes 中文学习指南️ 初学者轨道 面试轨道从零基础到拿 Offer 一站式覆盖 每篇文章配套 Kind 实验脚本本地一键运行 本文源码docs/beginner/20-gateway-api.md⭐ 如果对你有帮助欢迎 Star github.com/callmebg/k8s-guide