golang如何定义Kubernetes CRD_golang Kubernetes CRD定义方法

秋浩姑娘_9199

秋浩姑娘_9199

2026-04-04

473人浏览

原创

crd的go结构体需json/yaml标签、validation注释、scheme注册三者严格对齐:字段须用指针+omitempty标签;嵌套结构需显式json标签;切片需json:"items,omitempty";validation注释类型名须匹配openapi v3(如integer非int);spec.versions必须为数组且仅一个storage: true;addtoscheme顺序不可错。

golang如何定义kubernetes crd_golang kubernetes crd定义方法

CRD 的 Go 结构体定义不是“写完 struct 就能用”,关键在 JSON/YAML 标签、validation 注释、scheme 注册三者必须对齐,缺一不可。

字段必须带 jsonyaml 标签,且指针 + omitempty 是默认安全写法

不加标签或漏掉 omitempty 会导致 kubectl apply 失败,错误是 OpenAPI schema 生成失败,不是运行时报错。K8s API Server 在加载 CRD 时就拒绝注册。

  • string 字段别直接写 Field string,要写成 Field *string `json:"field,omitempty" yaml:"field,omitempty"`
  • int32 同理:用 Replicas *int32 `json:"replicas,omitempty" yaml:"replicas,omitempty"`
  • 嵌套结构体字段必须显式加 json:"nested,omitempty" + struct{},不能用 map[string]interface{} —— controller-gen 不会生成合法 schema
  • 切片字段(如 []string)必须带 json:"items,omitempty",否则 kubectl describe 会报错

// +kubebuilder:validation 注释必须显式声明,且类型名严格匹配 OpenAPI v3

make manifests 生成的 CRD YAML 默认没有 validation,一旦字段有约束但没注释,kubectl apply -f crd.yaml 会报 spec.validation.openAPIV3Schema.type is required

Golang Samber Do
Golang Samber Do

使用 samber/do 在 Golang 中实现依赖注入 — 服务容器、生命周期管理、作用域、健康检查、优雅关闭和模块组织

下载
  • 必填字段加 // +kubebuilder:validation:Required(注意双斜杠+空格)
  • 字符串长度限制用 // +kubebuilder:validation:MinLength=1,数组长度用 MinItems=1(不是 MinLength
  • 数字范围写 // +kubebuilder:validation:Minimum=0,布尔值无需额外注释
  • 字段类型必须写 integerbooleanstring,不能写 intbool —— 否则 validation 静默失效

CRD YAML 的 spec.versions 必须是数组,且仅一个 storage: true

spec.version(单字段)会直接被 K8s 1.16+ 拒绝,报错信息明确指出 unknown field "version"

  • spec.versions 是数组,每个元素含 nameservedstorage
  • 仅一个版本可设 storage: true(推荐最新版,如 v1
  • 旧版(如 v1alpha1)可设 served: truestorage: false,方便后续迁移
  • 生成后务必检查 YAML 中 openAPIV3Schema.properties.spec.type 是否存在,这是 validation 生效的前提

AddToScheme 调用顺序错乱会导致 panic:「no kind is registered for the type」

controller-runtime 启动时找不到你的 CR 类型,90% 是因为 scheme 注册顺序错了 —— 不是没注册,是注册得太晚。

  • 必须先调 clientgoscheme.AddToScheme(scheme),再调你自己的 myappv1alpha1.AddToScheme(scheme)
  • 如果用了多版本(v1alpha1v1),两个都要注册,漏一个,watch 对应版本对象就会失败
  • Builder.For(&myappv1alpha1.MyApp{}) 中的类型必须和 CRD 的 spec.group/spec.names.kind 完全一致(大小写、复数、包路径都不能错)
  • 不要在 SetupWithManager 里重复调 AddToScheme —— Scheme 是全局单例,重复注册会 panic

最容易被忽略的是:validation 注释生成的 schema 字段类型必须和 OpenAPI v3 规范字面量完全一致,哪怕只是大小写差异(比如 Integerinteger),K8s 就会静默跳过整段 validation。这问题没法靠编译发现,只能靠检查生成的 YAML。

golang免费学习笔记(深入):立即使用
在学习笔记中,你将探索golang的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2549

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2088

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1060

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

998

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1236

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

1878

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

2840

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

12195

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

509

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Fiber框架快速入门指南
Fiber框架快速入门指南

共0课时 | 0人学习

Fiber框架两小时速通教程
Fiber框架两小时速通教程

共0课时 | 0人学习