kubebuilder常用标签

kubebuilder 标签是用于注解 Kubernetes CRD（Custom Resource Definition） 的标签，主要用于在 Operator SDK 和 Kubebuilder 框架中生成代码、验证规则以及自定义 CRD 的生成。以下是常用的 kubebuilder 标签：

1. 字段验证标签

这些标签用于在 CRD 中生成字段的验证规则。

• +kubebuilder:validation:Required
  • 标记字段为必填项。
• +kubebuilder:validation:Optional
  • 标记字段为可选项（默认行为）。
• +kubebuilder:validation:Maximum=<value>
  • 指定数值字段的最大值。
• +kubebuilder:validation:Minimum=<value>
  • 指定数值字段的最小值。
• +kubebuilder:validation:MaxLength=<value>
  • 指定字符串字段的最大长度。
• +kubebuilder:validation:MinLength=<value>
  • 指定字符串字段的最小长度。
• +kubebuilder:validation:Enum=<value1>,<value2>,...
  • 指定枚举类型的可选值。
• +kubebuilder:validation:Pattern=<regex>
  • 指定字符串字段必须符合的正则表达式模式。
• +kubebuilder:validation:Format=<format>
  • 指定字段的格式（例如：email, date-time, hostname 等）。
• +kubebuilder:validation:ExclusiveMinimum=<bool>
  • 指定最小值是否为排他性。
• +kubebuilder:validation:ExclusiveMaximum=<bool>
  • 指定最大值是否为排他性。
• +kubebuilder:validation:MultipleOf=<value>
  • 指定数值字段必须是该值的倍数。

2. 默认值标签

• +kubebuilder:default=<value>
  • 指定字段的默认值。

3. 列表和映射类型标签

• +kubebuilder:validation:UniqueItems=true
  • 用于列表字段，指定列表中的项必须唯一。
• +kubebuilder:validation:MinItems=<value>
  • 用于列表字段，指定列表的最小项数。
• +kubebuilder:validation:MaxItems=<value>
  • 用于列表字段，指定列表的最大项数。
• +kubebuilder:validation:XMapType=atomic/granular
  • 用于映射类型，指定映射的处理方式（atomic 或 granular）。

4. 嵌套对象标签

• +kubebuilder:pruning:PreserveUnknownFields

  • 在更新 CR 时，保持未知字段不被删除。

• +kubebuilder:validation:EmbeddedResource

  • 指定嵌套对象的字段应被视为嵌套的Kubernetes资源对象。

5. CRD 元数据标签

• +kubebuilder:resource:path=<name>,scope=<Scope>,shortName=<shortName>

  • 自定义资源的元数据，例如 CRD 路径、范围（Namespaced 或 Cluster）和短名称。

• +kubebuilder:subresource:status

  • 启用状态子资源（.status 字段）。

• +kubebuilder:subresource:scale

  • 启用Scale子资源，通常用于HorizontalPodAutoscaler (HPA)。

6. 其他控制标签

• +kubebuilder:printcolumn:name=<name>,type=<type>,description=<desc>,JSONPath=<path>

  • 自定义 kubectl get 命令输出时显示的列。

• +kubebuilder:object:root=true

  • 指定一个结构体作为顶级Kubernetes对象。

• +kubebuilder:object:generate=true

  • 在代码生成时强制生成该对象的代码。

• +kubebuilder:skipversion

  • 跳过为该版本生成 CRD。

7. API 版本和服务标签

• +kubebuilder:storageversion

  • 指定该版本为存储版本。

• +kubebuilder:webhook:path=<path>,mutating=<true/false>,sideEffects=<sideEffects>,admissionReviewVersions=<v1,v1beta1>

  • 用于生成 Webhook 配置。

8. 管理注解和自定义生成行为标签

• +kubebuilder:generate=true/false

  • 控制是否生成某些特定的CRD或资源。

• +kubebuilder:marker:validation:XPreserveUnknownFields

  • 用于保留未定义字段。

这些标签可以帮助你为CRD字段添加详细的验证规则、描述和元数据，从而更好地控制CRD的行为和展示效果。