使用 CustomResourceDefinitions 扩展 Kubernetes API

此页面展示如何通过创建 CustomResourceDefinition 在 Kubernetes API 中安装自定义资源。

开始之前

你需要有一个 Kubernetes 集群，并且必须配置 kubectl 命令行工具以与你的集群通信。建议在至少有两个不充当控制平面主机的节点集群上运行本教程。如果你还没有集群，可以使用 minikube 创建一个，也可以使用这些 Kubernetes 游乐场之一

• Killercoda
• Play with Kubernetes

创建 CustomResourceDefinition

当你创建新的 CustomResourceDefinition (CRD) 时，Kubernetes API 服务器会为你指定的每个版本创建一个新的 RESTful 资源路径。 从 CRD 对象创建的自定义资源可以是命名空间的，也可以是集群范围的，如 CRD 的 spec.scope 字段中所指定的那样。 与现有的内置对象一样，删除命名空间会删除该命名空间中的所有自定义对象。 CustomResourceDefinition 本身是非命名空间的，对所有命名空间都可用。

例如，如果你将以下 CustomResourceDefinition 保存到 resourcedefinition.yaml

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  # name must match the spec fields below, and be in the form: <plural>.<group>
  name: crontabs.stable.example.com
spec:
  # group name to use for REST API: /apis/<group>/<version>
  group: stable.example.com
  # list of versions supported by this CustomResourceDefinition
  versions:
    - name: v1
      # Each version can be enabled/disabled by Served flag.
      served: true
      # One and only one version must be marked as the storage version.
      storage: true
      schema:
        openAPIV3Schema:
          type: object
          properties:
            spec:
              type: object
              properties:
                cronSpec:
                  type: string
                image:
                  type: string
                replicas:
                  type: integer
  # either Namespaced or Cluster
  scope: Namespaced
  names:
    # plural name to be used in the URL: /apis/<group>/<version>/<plural>
    plural: crontabs
    # singular name to be used as an alias on the CLI and for display
    singular: crontab
    # kind is normally the CamelCased singular type. Your resource manifests use this.
    kind: CronTab
    # shortNames allow shorter string to match your resource on the CLI
    shortNames:
    - ct

并创建它

kubectl apply -f resourcedefinition.yaml

那么将会在以下位置创建一个新的命名空间 RESTful API 端点

/apis/stable.example.com/v1/namespaces/*/crontabs/...

然后可以使用此端点 URL 来创建和管理自定义对象。这些对象的 kind 将是你上面创建的 CustomResourceDefinition 对象的规范中的 CronTab。

创建端点可能需要几秒钟。你可以观察你的 CustomResourceDefinition 的 Established 条件是否为 true，或者观察 API 服务器的发现信息中你的资源是否出现。

创建自定义对象

创建 CustomResourceDefinition 对象后，你可以创建自定义对象。 自定义对象可以包含自定义字段。这些字段可以包含任意 JSON。 在以下示例中，在 CronTab 类型的自定义对象中设置了自定义字段 cronSpec 和 image。 CronTab 类型来自你上面创建的 CustomResourceDefinition 对象的规范。

如果你将以下 YAML 保存到 my-crontab.yaml

apiVersion: "stable.example.com/v1"
kind: CronTab
metadata:
  name: my-new-cron-object
spec:
  cronSpec: "* * * * */5"
  image: my-awesome-cron-image

并创建它

kubectl apply -f my-crontab.yaml

然后，你可以使用 kubectl 管理你的 CronTab 对象。 例如

kubectl get crontab

应该打印如下列表

NAME                 AGE
my-new-cron-object   6s

使用 kubectl 时，资源名称不区分大小写，你可以使用 CRD 中定义的单数或复数形式，以及任何短名称。

你还可以查看原始 YAML 数据

kubectl get ct -o yaml

你应该看到它包含你用于创建它的 YAML 中的自定义 cronSpec 和 image 字段

apiVersion: v1
items:
- apiVersion: stable.example.com/v1
  kind: CronTab
  metadata:
    annotations:
      kubectl.kubernetes.io/last-applied-configuration: |
        {"apiVersion":"stable.example.com/v1","kind":"CronTab","metadata":{"annotations":{},"name":"my-new-cron-object","namespace":"default"},"spec":{"cronSpec":"* * * * */5","image":"my-awesome-cron-image"}}        
    creationTimestamp: "2021-06-20T07:35:27Z"
    generation: 1
    name: my-new-cron-object
    namespace: default
    resourceVersion: "1326"
    uid: 9aab1d66-628e-41bb-a422-57b8b3b1f5a9
  spec:
    cronSpec: '* * * * */5'
    image: my-awesome-cron-image
kind: List
metadata:
  resourceVersion: ""
  selfLink: ""

删除 CustomResourceDefinition

当你删除 CustomResourceDefinition 时，服务器将卸载 RESTful API 端点并删除其中存储的所有自定义对象。

kubectl delete -f resourcedefinition.yaml
kubectl get crontabs

Error from server (NotFound): Unable to list {"stable.example.com" "v1" "crontabs"}: the server could not
find the requested resource (get crontabs.stable.example.com)

如果你稍后重新创建相同的 CustomResourceDefinition，它将从空开始。

指定结构化模式

CustomResources 在自定义字段中存储结构化数据（以及 API 服务器隐式验证的内置字段 apiVersion、kind 和 metadata）。使用 OpenAPI v3.0 验证可以指定一个在创建和更新期间验证的模式，请比较下面的详细信息和此类模式的限制。

使用 apiextensions.k8s.io/v1，CustomResourceDefinition 必须定义结构化模式。在 CustomResourceDefinition 的 beta 版本中，结构化模式是可选的。

结构化模式是 OpenAPI v3.0 验证模式，它

1. 为根指定一个非空类型（通过 OpenAPI 中的 type），为对象节点的每个指定字段（通过 OpenAPI 中的 properties 或 additionalProperties）以及数组节点中的每个项目（通过 OpenAPI 中的 items）指定一个非空类型，以下情况除外
   • 具有 x-kubernetes-int-or-string: true 的节点
   • 具有 x-kubernetes-preserve-unknown-fields: true 的节点
2. 对于对象中的每个字段和在 allOf、anyOf、oneOf 或 not 中的任何一个中指定的数组中的每个项目，模式还在这些逻辑连接符之外指定字段/项目（比较示例 1 和 2）。
3. 不在 allOf、anyOf、oneOf 或 not 内设置 description、type、default、additionalProperties、nullable，以下两种 x-kubernetes-int-or-string: true 模式除外（见下文）。
4. 如果指定了 metadata，则只允许对 metadata.name 和 metadata.generateName 进行限制。

非结构化示例 1

allOf:
- properties:
    foo:
      ...

与规则 2 冲突。以下是正确的

properties:
  foo:
    ...
allOf:
- properties:
    foo:
      ...

非结构化示例 2

allOf:
- items:
    properties:
      foo:
        ...

与规则 2 冲突。以下是正确的

items:
  properties:
    foo:
      ...
allOf:
- items:
    properties:
      foo:
        ...

非结构化示例 3

properties:
  foo:
    pattern: "abc"
  metadata:
    type: object
    properties:
      name:
        type: string
        pattern: "^a"
      finalizers:
        type: array
        items:
          type: string
          pattern: "my-finalizer"
anyOf:
- properties:
    bar:
      type: integer
      minimum: 42
  required: ["bar"]
  description: "foo bar object"

由于以下违规，不是结构化模式

• 缺少根处的类型（规则 1）。
• 缺少 foo 的类型（规则 1）。
• anyOf 内的 bar 没有在外部指定（规则 2）。
• bar 的 type 在 anyOf 内（规则 3）。
• 在 anyOf 内设置了描述（规则 3）。
• metadata.finalizers 可能不受限制（规则 4）。

相反，以下对应的模式是结构化的

type: object
description: "foo bar object"
properties:
  foo:
    type: string
    pattern: "abc"
  bar:
    type: integer
  metadata:
    type: object
    properties:
      name:
        type: string
        pattern: "^a"
anyOf:
- properties:
    bar:
      minimum: 42
  required: ["bar"]

结构化模式规则的违反情况会在 CustomResourceDefinition 的 NonStructural 条件中报告。

字段修剪

CustomResourceDefinitions（自定义资源定义）将经过验证的资源数据存储在集群的持久化存储 etcd 中。与 Kubernetes 原生资源（如 ConfigMap）一样，如果您指定了 API 服务器无法识别的字段，则该未知字段会在持久化之前被修剪（删除）。

从 apiextensions.k8s.io/v1beta1 转换为 apiextensions.k8s.io/v1 的 CRD 可能缺少结构化模式，并且 spec.preserveUnknownFields 可能为 true。

对于创建为 apiextensions.k8s.io/v1beta1 且 spec.preserveUnknownFields 设置为 true 的旧版 CustomResourceDefinition 对象，以下情况也适用：

• 未启用修剪。
• 您可以存储任意数据。

为了与 apiextensions.k8s.io/v1 兼容，请更新您的自定义资源定义以：

1. 使用结构化的 OpenAPI 模式。
2. 将 spec.preserveUnknownFields 设置为 false。

如果你将以下 YAML 保存到 my-crontab.yaml

apiVersion: "stable.example.com/v1"
kind: CronTab
metadata:
  name: my-new-cron-object
spec:
  cronSpec: "* * * * */5"
  image: my-awesome-cron-image
  someRandomField: 42

并创建它

kubectl create --validate=false -f my-crontab.yaml -o yaml

您的输出类似于：

apiVersion: stable.example.com/v1
kind: CronTab
metadata:
  creationTimestamp: 2017-05-31T12:56:35Z
  generation: 1
  name: my-new-cron-object
  namespace: default
  resourceVersion: "285"
  uid: 9423255b-4600-11e7-af6a-28d2447dc82b
spec:
  cronSpec: '* * * * */5'
  image: my-awesome-cron-image

请注意，字段 someRandomField 已被修剪。

此示例通过添加 --validate=false 命令行选项关闭了客户端验证，以演示 API 服务器的行为。由于 OpenAPI 验证模式也发布到客户端，kubectl 也会检查未知字段，并在它们被发送到 API 服务器之前就拒绝这些对象。

控制修剪

默认情况下，自定义资源的所有未指定字段（跨所有版本）都会被修剪。但是，可以通过在 结构化 OpenAPI v3 验证模式中添加 x-kubernetes-preserve-unknown-fields: true 来选择退出特定字段子树的修剪。

例如：

type: object
properties:
  json:
    x-kubernetes-preserve-unknown-fields: true

字段 json 可以存储任何 JSON 值，而不会被修剪。

您也可以部分指定允许的 JSON；例如：

type: object
properties:
  json:
    x-kubernetes-preserve-unknown-fields: true
    type: object
    description: this is arbitrary JSON

这样，只允许 object 类型的值。

对于每个指定的属性（或 additionalProperties），将再次启用修剪：

type: object
properties:
  json:
    x-kubernetes-preserve-unknown-fields: true
    type: object
    properties:
      spec:
        type: object
        properties:
          foo:
            type: string
          bar:
            type: string

这样，值：

json:
  spec:
    foo: abc
    bar: def
    something: x
  status:
    something: x

将被修剪为：

json:
  spec:
    foo: abc
    bar: def
  status:
    something: x

这意味着指定 spec 对象中的 something 字段被修剪，但外部的所有内容都不会被修剪。

IntOrString

模式中具有 x-kubernetes-int-or-string: true 的节点不包括在规则 1 中，因此以下内容是结构化的：

type: object
properties:
  foo:
    x-kubernetes-int-or-string: true

这些节点也部分地不包括在规则 3 中，因为允许以下两种模式（恰好是这两种，没有其他字段顺序的变化）：

x-kubernetes-int-or-string: true
anyOf:
  - type: integer
  - type: string
...

和

x-kubernetes-int-or-string: true
allOf:
  - anyOf:
      - type: integer
      - type: string
  - ... # zero or more
...

使用其中一种规范，整数和字符串都可以验证。

在验证模式发布中，x-kubernetes-int-or-string: true 会展开为上面显示的两种模式之一。

RawExtension

RawExtensions（如 runtime.RawExtension 中所示）保存完整的 Kubernetes 对象，即包含 apiVersion 和 kind 字段的对象。

可以通过设置 x-kubernetes-embedded-resource: true 来指定这些嵌入的对象（完全没有约束或部分指定）。例如：

type: object
properties:
  foo:
    x-kubernetes-embedded-resource: true
    x-kubernetes-preserve-unknown-fields: true

在这里，字段 foo 保存一个完整的对象，例如：

foo:
  apiVersion: v1
  kind: Pod
  spec:
    ...

由于同时指定了 x-kubernetes-preserve-unknown-fields: true，因此不会修剪任何内容。但是，x-kubernetes-preserve-unknown-fields: true 的使用是可选的。

使用 x-kubernetes-embedded-resource: true，apiVersion、kind 和 metadata 将被隐式指定和验证。

提供 CRD 的多个版本

有关提供 CustomResourceDefinition 的多个版本以及将对象从一个版本迁移到另一个版本的更多信息，请参阅自定义资源定义版本控制。

高级主题

终结器

Finalizers 允许控制器实现异步的预删除钩子。自定义对象支持类似于内置对象的 finalizer。

您可以像这样向自定义对象添加 finalizer：

apiVersion: "stable.example.com/v1"
kind: CronTab
metadata:
  finalizers:
  - stable.example.com/finalizer

自定义 finalizer 的标识符由域名、斜杠和 finalizer 的名称组成。任何控制器都可以向任何对象的 finalizer 列表添加 finalizer。

对带有 finalizer 的对象执行的第一个删除请求会为 metadata.deletionTimestamp 字段设置一个值，但不会删除它。一旦设置了此值，就只能删除 finalizers 列表中的条目。在任何 finalizer 存在的情况下，也无法强制删除对象。

当 metadata.deletionTimestamp 字段被设置后，监视该对象的控制器会执行它们处理的任何 finalizer，并在完成后从列表中删除该 finalizer。每个控制器都有责任从列表中删除其 finalizer。

metadata.deletionGracePeriodSeconds 的值控制轮询更新之间的时间间隔。

一旦 finalizer 列表为空，表示所有 finalizer 都已执行完毕，则该资源会被 Kubernetes 删除。

验证

自定义资源通过 OpenAPI v3.0 模式，在启用验证规则特性时通过 x-kubernetes-validations 进行验证，并且您可以使用准入 Webhook 添加额外的验证。

此外，以下限制适用于模式：

• 不能设置这些字段：

  • definitions,
  • dependencies,
  • deprecated,
  • discriminator,
  • id,
  • patternProperties,
  • readOnly,
  • writeOnly,
  • xml,
  • $ref.

• 字段 uniqueItems 不能设置为 true。

• 字段 additionalProperties 不能设置为 false。

• 字段 additionalProperties 与 properties 互斥。

当验证规则特性启用且 CustomResourceDefinition 模式为结构化模式时，可以使用 x-kubernetes-validations 扩展，使用 通用表达式语言 (CEL) 表达式来验证自定义资源。

有关其他限制和 CustomResourceDefinition 功能，请参阅结构化模式部分。

模式在 CustomResourceDefinition 中定义。在以下示例中，CustomResourceDefinition 对自定义对象应用以下验证：

• spec.cronSpec 必须是字符串，并且必须符合正则表达式所描述的形式。
• spec.replicas 必须是整数，并且最小值必须为 1，最大值必须为 10。

将 CustomResourceDefinition 保存到 resourcedefinition.yaml

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: crontabs.stable.example.com
spec:
  group: stable.example.com
  versions:
    - name: v1
      served: true
      storage: true
      schema:
        # openAPIV3Schema is the schema for validating custom objects.
        openAPIV3Schema:
          type: object
          properties:
            spec:
              type: object
              properties:
                cronSpec:
                  type: string
                  pattern: '^(\d+|\*)(/\d+)?(\s+(\d+|\*)(/\d+)?){4}$'
                image:
                  type: string
                replicas:
                  type: integer
                  minimum: 1
                  maximum: 10
  scope: Namespaced
  names:
    plural: crontabs
    singular: crontab
    kind: CronTab
    shortNames:
    - ct

并创建它

kubectl apply -f resourcedefinition.yaml

如果 CronTab 类型的自定义对象在其字段中包含无效值，则会拒绝创建该对象的请求。在以下示例中，自定义对象包含具有无效值的字段：

• spec.cronSpec 与正则表达式不匹配。
• spec.replicas 大于 10。

如果你将以下 YAML 保存到 my-crontab.yaml

apiVersion: "stable.example.com/v1"
kind: CronTab
metadata:
  name: my-new-cron-object
spec:
  cronSpec: "* * * *"
  image: my-awesome-cron-image
  replicas: 15

并尝试创建它：

kubectl apply -f my-crontab.yaml

然后您会收到一个错误：

The CronTab "my-new-cron-object" is invalid: []: Invalid value: map[string]interface {}{"apiVersion":"stable.example.com/v1", "kind":"CronTab", "metadata":map[string]interface {}{"name":"my-new-cron-object", "namespace":"default", "deletionTimestamp":interface {}(nil), "deletionGracePeriodSeconds":(*int64)(nil), "creationTimestamp":"2017-09-05T05:20:07Z", "uid":"e14d79e7-91f9-11e7-a598-f0761cb232d1", "clusterName":""}, "spec":map[string]interface {}{"cronSpec":"* * * *", "image":"my-awesome-cron-image", "replicas":15}}:
validation failure list:
spec.cronSpec in body should match '^(\d+|\*)(/\d+)?(\s+(\d+|\*)(/\d+)?){4}$'
spec.replicas in body should be less than or equal to 10

如果字段包含有效值，则对象创建请求将被接受。

将以下 YAML 保存到 my-crontab.yaml：

apiVersion: "stable.example.com/v1"
kind: CronTab
metadata:
  name: my-new-cron-object
spec:
  cronSpec: "* * * * */5"
  image: my-awesome-cron-image
  replicas: 5

并创建它：

kubectl apply -f my-crontab.yaml
crontab "my-new-cron-object" created

验证棘轮 (Validation Ratcheting)

如果您使用的 Kubernetes 版本低于 v1.30，则需要显式启用 CRDValidationRatcheting 特性门控以使用此行为，然后该行为将应用于集群中的所有 CustomResourceDefinitions。

如果您启用了特性门控，Kubernetes 将为 CustomResourceDefinitions 实现验证棘轮。API 服务器愿意接受更新后无效的资源更新，前提是资源中未能通过验证的每个部分都未被更新操作更改。换句话说，资源的任何无效部分必须已经错误。您不能使用此机制来更新有效的资源，使其变为无效。

此特性允许 CRD 的作者在某些条件下自信地向 OpenAPIV3 模式添加新的验证。用户可以安全地更新到新模式，而无需升级对象的版本或破坏工作流程。

尽管 CRD 的 OpenAPIV3 模式中的大多数验证都支持棘轮，但也有一些例外。在 Kubernetes 1.32 中的实现下，以下 OpenAPIV3 模式验证不受棘轮支持，如果违反这些验证，将继续像往常一样抛出错误：

• 量词

  • allOf
  • oneOf
  • anyOf
  • not
  • 这些字段的后代中的任何验证

• x-kubernetes-validations 对于 Kubernetes 1.28，棘轮会忽略 CRD 验证规则。从 Kubernetes 1.29 的 Alpha 2 开始，仅当 x-kubernetes-validations 不引用 oldSelf 时，才会进行棘轮。

  转换规则永远不会进行棘轮：只有不使用 oldSelf 的规则引发的错误，如果其值未更改，才会被自动棘轮。

  要为 CEL 表达式编写自定义棘轮逻辑，请查看optionalOldSelf。

• x-kubernetes-list-type 更改子模式的列表类型所产生的错误不会被棘轮。例如，将 set 添加到包含重复项的列表将始终导致错误。

• x-kubernetes-map-keys 更改列表模式的映射键所产生的错误不会被棘轮。

• required 更改必需字段列表所产生的错误不会被棘轮。

• properties 添加/删除/修改属性的名称不会进行棘轮，但是如果属性的名称保持不变，则可以棘轮化每个属性的模式和子模式中的验证更改。

• additionalProperties 删除先前指定的 additionalProperties 验证将不会被棘轮。

• metadata 来自 Kubernetes 对对象 metadata 的内置验证的错误（例如对象名称或标签值中的字符）不会进行棘轮。如果您为自定义资源的元数据指定了自己的附加规则，则该附加验证将被棘轮。

验证规则

验证规则使用 通用表达式语言 (CEL) 来验证自定义资源值。验证规则使用 x-kubernetes-validations 扩展包含在 CustomResourceDefinition 模式中。

规则的作用域限定为模式中 x-kubernetes-validations 扩展的位置。并且 CEL 表达式中的 self 变量绑定到限定范围的值。

所有验证规则的作用域都限定于当前对象：不支持跨对象或有状态的验证规则。

例如：

  ...
  openAPIV3Schema:
    type: object
    properties:
      spec:
        type: object
        x-kubernetes-validations:
          - rule: "self.minReplicas <= self.replicas"
            message: "replicas should be greater than or equal to minReplicas."
          - rule: "self.replicas <= self.maxReplicas"
            message: "replicas should be smaller than or equal to maxReplicas."
        properties:
          ...
          minReplicas:
            type: integer
          replicas:
            type: integer
          maxReplicas:
            type: integer
        required:
          - minReplicas
          - replicas
          - maxReplicas

将拒绝创建此自定义资源的请求

apiVersion: "stable.example.com/v1"
kind: CronTab
metadata:
  name: my-new-cron-object
spec:
  minReplicas: 0
  replicas: 20
  maxReplicas: 10

并返回以下响应

The CronTab "my-new-cron-object" is invalid:
* spec: Invalid value: map[string]interface {}{"maxReplicas":10, "minReplicas":0, "replicas":20}: replicas should be smaller than or equal to maxReplicas.

x-kubernetes-validations 可以包含多个规则。x-kubernetes-validations 下的 rule 代表将由 CEL 计算的表达式。message 代表验证失败时显示的消息。如果未设置 message，则上述响应将为：

The CronTab "my-new-cron-object" is invalid:
* spec: Invalid value: map[string]interface {}{"maxReplicas":10, "minReplicas":0, "replicas":20}: failed rule: self.replicas <= self.maxReplicas

验证规则在创建/更新 CRD 时进行编译。如果验证规则编译失败，则 CRD 的创建/更新请求将失败。编译过程还包括类型检查。

编译失败的情况包括：

• no_matching_overload：此函数没有与参数类型匹配的重载。

  例如，针对整数类型的字段使用类似 self == true 的规则会报错

  Invalid value: apiextensions.ValidationRule{Rule:"self == true", Message:""}: compilation failed: ERROR: \<input>:1:6: found no matching overload for '_==_' applied to '(int, bool)'
  

• no_such_field：不包含所需的字段。

  例如，针对不存在的字段使用类似 self.nonExistingField > 0 的规则将返回以下错误

  Invalid value: apiextensions.ValidationRule{Rule:"self.nonExistingField > 0", Message:""}: compilation failed: ERROR: \<input>:1:5: undefined field 'nonExistingField'
  

• invalid argument：宏的参数无效。

  例如，类似 has(self) 的规则将返回错误

  Invalid value: apiextensions.ValidationRule{Rule:"has(self)", Message:""}: compilation failed: ERROR: <input>:1:4: invalid argument to has() macro
  

验证规则示例

参考：CEL 上支持的评估

• 如果规则的作用域限定于资源的根目录，它可以选择 CRD 的 OpenAPIv3 模式中声明的任何字段，以及 apiVersion、kind、metadata.name 和 metadata.generateName。这包括在同一表达式中选择 spec 和 status 中的字段

    ...
    openAPIV3Schema:
      type: object
      x-kubernetes-validations:
        - rule: "self.status.availableReplicas >= self.spec.minReplicas"
      properties:
          spec:
            type: object
            properties:
              minReplicas:
                type: integer
              ...
          status:
            type: object
            properties:
              availableReplicas:
                type: integer
  

• 如果规则的作用域限定于具有属性的对象，则可以通过 self.field 选择对象的可用属性，并且可以通过 has(self.field) 检查字段是否存在。在 CEL 表达式中，值为 null 的字段被视为不存在的字段。

    ...
    openAPIV3Schema:
      type: object
      properties:
        spec:
          type: object
          x-kubernetes-validations:
            - rule: "has(self.foo)"
          properties:
            ...
            foo:
              type: integer
  

• 如果规则的作用域限定于具有 additionalProperties 的对象（即映射），则可以通过 self[mapKey] 访问映射的值，可以通过 mapKey in self 检查映射是否包含，并且可以通过 CEL 宏和函数（如 self.all(...)）访问映射的所有条目。

    ...
    openAPIV3Schema:
      type: object
      properties:
        spec:
          type: object
          x-kubernetes-validations:
            - rule: "self['xyz'].foo > 0"
          additionalProperties:
            ...
            type: object
            properties:
              foo:
                type: integer
  

• 如果规则的作用域限定于数组，则可以通过 self[i] 以及宏和函数访问数组的元素。

    ...
    openAPIV3Schema:
      type: object
      properties:
        ...
        foo:
          type: array
          x-kubernetes-validations:
            - rule: "size(self) == 1"
          items:
            type: string
  

• 如果规则的作用域限定于标量，则 self 将绑定到标量值。

    ...
    openAPIV3Schema:
      type: object
      properties:
        spec:
          type: object
          properties:
            ...
            foo:
              type: integer
              x-kubernetes-validations:
              - rule: "self > 0"
  

示例

始终可以从对象的根以及任何带有 x-kubernetes-embedded-resource 注释的对象访问 apiVersion、kind、metadata.name 和 metadata.generateName。无法访问其他元数据属性。

通过 x-kubernetes-preserve-unknown-fields 保留在自定义资源中的未知数据在 CEL 表达式中不可访问。这包括：

• 通过带有 x-kubernetes-preserve-unknown-fields 的对象模式保留的未知字段值。

• 属性模式为“未知类型”的对象属性。“未知类型”的递归定义为：

  • 没有类型且 x-kubernetes-preserve-unknown-fields 设置为 true 的模式
  • 项目模式为“未知类型”的数组
  • additionalProperties 模式为“未知类型”的对象

只有 [a-zA-Z_.-/][a-zA-Z0-9_.-/]* 形式的属性名称是可访问的。在表达式中访问时，可访问的属性名称会根据以下规则进行转义：

__slash__

/

x-prop

• self.x__dash__prop > 0

• redact__d

self.redact__underscores__d > 0

timestamp (google.protobuf.Timestamp)

'string' with format=datetime

'string' with format=duration

x-kubernetes-validations:
- rule: "self.x <= self.maxLimit"
  messageExpression: '"x exceeded max limit of " + string(self.maxLimit)'

duration (google.protobuf.Duration)

参考：CEL 类型、OpenAPI 类型、Kubernetes 结构模式。

messageExpression 字段

与定义验证规则失败时报告的字符串的 message 字段类似，messageExpression 允许您使用 CEL 表达式构造消息字符串。这允许您在验证失败消息中插入更具描述性的信息。messageExpression 必须评估一个字符串，并且可以使用与 rule 字段相同的变量。例如：

请记住，CEL 字符串连接（+ 运算符）不会自动转换为字符串。如果您有非字符串标量，请使用 string(<value>) 函数将标量转换为字符串，如上面的示例所示。

messageExpression 必须评估为字符串，并且在写入 CRD 时会进行检查。请注意，可以在同一规则上设置 message 和 messageExpression，如果两者都存在，将使用 messageExpression。但是，如果 messageExpression 评估为错误，则将使用 message 中定义的字符串，并且会记录 messageExpression 错误。如果 messageExpression 中定义的 CEL 表达式生成空字符串或包含换行符的字符串，也会发生此回退。

如果满足上述条件之一并且未设置 message，则将使用默认验证失败消息。

messageExpression 是一个 CEL 表达式，因此 验证函数使用的资源 中列出的限制适用。如果由于 messageExpression 执行期间的资源限制而导致评估停止，则不会执行进一步的验证规则。

设置 messageExpression 是可选的。

message 字段

例如：

x-kubernetes-validations:
- rule: "self.x <= self.maxLimit"
  reason: "FieldValueInvalid"

如果要设置静态消息，可以提供 message 而不是 messageExpression。如果验证失败，则 message 的值将用作不透明的错误字符串。

设置 message 是可选的。

reason 字段

您可以在 validation 中添加机器可读的验证失败原因，以便在请求未能通过此验证规则时返回。

例如：

x-kubernetes-validations:
- rule: "self.foo.test.x <= self.maxLimit"
  fieldPath: ".foo.test.x"

返回给调用者的 HTTP 状态代码将与第一个失败的验证规则的原因匹配。当前支持的原因包括："FieldValueInvalid"、"FieldValueForbidden"、"FieldValueRequired"、"FieldValueDuplicate"。如果未设置或未知原因，则默认为使用 "FieldValueInvalid"。

fieldPath 值必须是一个相对于此 x-kubernetes-validations 扩展在 schema 中的位置的相对 JSON 路径。此外，它应该指向 schema 中已存在的字段。例如，当验证检查 map testMap 下的特定属性 foo 时，您可以将 fieldPath 设置为 ".testMap.foo" 或 .testMap['foo']'。如果验证需要检查两个列表中的唯一属性，则可以将 fieldPath 设置为其中一个列表。例如，它可以设置为 .testList1 或 .testList2。它支持子操作来引用当前已存在的字段。有关更多信息，请参阅 Kubernetes 中的 JSONPath 支持。fieldPath 字段不支持以数字方式索引数组。

设置 fieldPath 是可选的。

optionalOldSelf 字段

如果您的集群未启用 CRD 验证棘轮机制，则 CustomResourceDefinition API 不包含此字段，并且尝试设置它可能会导致错误。

optionalOldSelf 字段是一个布尔字段，它会改变下面描述的 转换规则 的行为。通常，如果无法确定 oldSelf，则转换规则将不会评估：在对象创建期间或在更新中引入新值时。

如果 optionalOldSelf 设置为 true，则转换规则将始终被评估，并且 oldSelf 的类型将更改为 CEL Optional 类型。

optionalOldSelf 在以下情况下很有用：schema 作者希望使用比默认的基于相等性的行为更强大的控制工具，以便在新值上引入更新、通常更严格的约束，同时仍然允许使用较旧的验证“grandfathered”或棘轮化旧值。

用法示例

验证函数

可用的函数包括

• 标准定义列表中定义的 CEL 标准函数
• CEL 标准 宏
• CEL 扩展字符串函数库
• Kubernetes CEL 扩展库

转换规则

包含引用标识符 oldSelf 的表达式的规则被隐式视为转换规则。转换规则允许 schema 作者防止两个原本有效的状态之间的某些转换。例如

type: string
enum: ["low", "medium", "high"]
x-kubernetes-validations:
- rule: "!(self == 'high' && oldSelf == 'low') && !(self == 'low' && oldSelf == 'high')"
  message: cannot transition directly between 'low' and 'high'

与其他规则不同，转换规则仅适用于满足以下条件的操作

• 该操作更新现有对象。转换规则永远不适用于创建操作。

• 新旧值都存在。仍然可以通过在父节点上放置转换规则来检查是否已添加或删除值。转换规则永远不会应用于自定义资源创建。当放置在可选字段上时，转换规则将不适用于设置或取消设置字段的更新操作。

• 通过转换规则验证的 schema 节点的路径必须解析为可在旧对象和新对象之间进行比较的节点。例如，列表项及其后代 (spec.foo[10].bar) 不一定能在现有对象和稍后对同一对象的更新之间建立关联。

如果 schema 节点包含永远无法应用的转换规则（例如，“oldSelf 不能在 *path* 中 schema 的不可关联部分上使用”），则会在 CRD 写入时生成错误。

转换规则仅允许在 schema 的可关联部分上使用。如果所有 array 父 schema 的类型都是 x-kubernetes-list-type=map，则 schema 的一部分是可关联的；任何 set 或 atomic 数组父 schema 都会使 self 与 oldSelf 之间的明确关联变得不可能。

以下是一些转换规则的示例

验证函数对资源的使用

当您创建或更新使用验证规则的 CustomResourceDefinition 时，API 服务器会检查运行这些验证规则的可能影响。如果估计某个规则的执行成本过高，API 服务器将拒绝创建或更新操作，并返回错误消息。运行时使用类似的系统来观察解释器执行的操作。如果解释器执行的指令过多，则将停止规则的执行，并导致错误。还允许每个 CustomResourceDefinition 使用一定数量的资源来完成其所有验证规则的执行。如果在创建时估计其所有规则的总和超过该限制，则也会发生验证错误。

如果您只指定始终花费相同时间（无论其输入有多大）的规则，则不太可能遇到验证资源预算的问题。例如，断言 self.foo == 1 的规则本身没有任何因验证资源预算组而被拒绝的风险。但是，如果 foo 是一个字符串，并且您定义了一个验证规则 self.foo.contains("someString")，则该规则的执行时间会随着 foo 的长度而增加。另一个例子是，如果 foo 是一个数组，并且您指定了验证规则 self.foo.all(x, x > 5)。如果未给出 foo 长度的限制，则成本系统始终假设最坏情况，这对于任何可以迭代的东西（列表、map 等）都会发生。

因此，最好为将在验证规则中处理的任何内容通过 maxItems、maxProperties 和 maxLength 设置限制，以防止成本估算期间的验证错误。例如，给定具有一个规则的此 schema

openAPIV3Schema:
  type: object
  properties:
    foo:
      type: array
      items:
        type: string
      x-kubernetes-validations:
        - rule: "self.all(x, x.contains('a string'))"

则 API 服务器会以错误拒绝此基于验证预算的规则

spec.validation.openAPIV3Schema.properties[spec].properties[foo].x-kubernetes-validations[0].rule: Forbidden:
CEL rule exceeded budget by more than 100x (try simplifying the rule, or adding maxItems, maxProperties, and
maxLength where arrays, maps, and strings are used)

拒绝发生的原因是 self.all 意味着对 foo 中的每个字符串调用 contains()，这反过来将检查给定的字符串以查看它是否包含 'a string'。如果没有限制，这是一个非常昂贵的规则。

如果您不指定任何验证限制，则此规则的估计成本将超过每个规则的成本限制。但是，如果您在适当的位置添加限制，则将允许该规则

openAPIV3Schema:
  type: object
  properties:
    foo:
      type: array
      maxItems: 25
      items:
        type: string
        maxLength: 10
      x-kubernetes-validations:
        - rule: "self.all(x, x.contains('a string'))"

成本估算系统会考虑规则执行的次数以及规则本身的估计成本。例如，以下规则将具有与上一个示例相同的估计成本（尽管该规则现在是在单个数组项上定义的）

openAPIV3Schema:
  type: object
  properties:
    foo:
      type: array
      maxItems: 25
      items:
        type: string
        x-kubernetes-validations:
          - rule: "self.contains('a string'))"
        maxLength: 10

如果列表内的列表具有使用 self.all 的验证规则，则其成本将比具有相同规则的非嵌套列表高得多。在非嵌套列表上允许的规则可能需要降低两个嵌套列表的限制才能被允许。例如，即使没有设置限制，也允许以下规则

openAPIV3Schema:
  type: object
  properties:
    foo:
      type: array
      items:
        type: integer
    x-kubernetes-validations:
      - rule: "self.all(x, x == 5)"

但是在以下 schema 上（添加了嵌套数组）使用相同的规则会产生验证错误

openAPIV3Schema:
  type: object
  properties:
    foo:
      type: array
      items:
        type: array
        items:
          type: integer
        x-kubernetes-validations:
          - rule: "self.all(x, x == 5)"

这是因为 foo 的每个项目本身都是一个数组，而每个子数组又会调用 self.all。如果使用验证规则，请尽可能避免使用嵌套列表和 map。

默认值

默认值允许在 OpenAPI v3 验证 schema 中指定默认值

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: crontabs.stable.example.com
spec:
  group: stable.example.com
  versions:
    - name: v1
      served: true
      storage: true
      schema:
        # openAPIV3Schema is the schema for validating custom objects.
        openAPIV3Schema:
          type: object
          properties:
            spec:
              type: object
              properties:
                cronSpec:
                  type: string
                  pattern: '^(\d+|\*)(/\d+)?(\s+(\d+|\*)(/\d+)?){4}$'
                  default: "5 0 * * *"
                image:
                  type: string
                replicas:
                  type: integer
                  minimum: 1
                  maximum: 10
                  default: 1
  scope: Namespaced
  names:
    plural: crontabs
    singular: crontab
    kind: CronTab
    shortNames:
    - ct

这样，cronSpec 和 replicas 都会被设置为默认值

apiVersion: "stable.example.com/v1"
kind: CronTab
metadata:
  name: my-new-cron-object
spec:
  image: my-awesome-cron-image

导致

apiVersion: "stable.example.com/v1"
kind: CronTab
metadata:
  name: my-new-cron-object
spec:
  cronSpec: "5 0 * * *"
  image: my-awesome-cron-image
  replicas: 1

默认值在对象上发生

• 在使用请求版本默认值的 API 服务器的请求中，
• 从 etcd 读取时使用存储版本默认值，
• 在使用 admission webhook 对象版本默认值的具有非空补丁的 mutating admission 插件之后。

从 etcd 读取数据时应用的默认值不会自动写回到 etcd。需要通过 API 发出更新请求才能将这些默认值持久化回 etcd。

默认值必须被修剪（metadata 字段的默认值除外），并且必须根据提供的 schema 进行验证。

x-kubernetes-embedded-resources: true 节点的 metadata 字段的默认值（或覆盖 metadata 的默认值的一部分）在 CustomResourceDefinition 创建期间不会被修剪，而是通过处理请求期间的修剪步骤进行修剪。

默认值和可空性

对于未指定可空标志或将其设置为 false 的字段，其 null 值将在发生默认值设置之前被修剪。如果存在默认值，则会应用它。当 nullable 为 true 时，将保留 null 值，并且不会默认值设置。

例如，给定以下 OpenAPI schema

type: object
properties:
  spec:
    type: object
    properties:
      foo:
        type: string
        nullable: false
        default: "default"
      bar:
        type: string
        nullable: true
      baz:
        type: string

创建一个具有 foo、bar 和 baz 的 null 值的对象

spec:
  foo: null
  bar: null
  baz: null

导致

spec:
  foo: "default"
  bar: null

由于该字段不可为空，foo 被修剪并设置为默认值，bar 由于 nullable: true 而保留 null 值，并且 baz 由于该字段不可为空且没有默认值而被修剪。

在 OpenAPI 中发布验证 Schema

CustomResourceDefinition OpenAPI v3 验证 schema（结构化 和 启用修剪）将以 Kubernetes API 服务器的 OpenAPI v3 和 OpenAPI v2 格式发布。建议使用 OpenAPI v3 文档，因为它提供了 CustomResourceDefinition OpenAPI v3 验证 schema 的无损表示，而 OpenAPI v2 表示有损转换。

kubectl 命令行工具使用已发布的 schema 来执行客户端验证（kubectl create 和 kubectl apply）、自定义资源的 schema 说明 (kubectl explain)。已发布的 schema 也可以用于其他目的，例如客户端生成或文档编制。

与 OpenAPI V2 的兼容性

为了与 OpenAPI V2 兼容，OpenAPI v3 验证 schema 会执行到 OpenAPI v2 schema 的有损转换。该 schema 显示在 OpenAPI v2 规范中的 definitions 和 paths 字段中。

在转换为与先前 1.13 版本的 kubectl 保持向后兼容性的过程中，会应用以下修改。 这些修改可防止 kubectl 过度严格并拒绝其不理解的有效 OpenAPI 模式。转换不会修改 CRD 中定义的验证模式，因此不会影响 API 服务器中的验证。

1. 以下字段将被删除，因为 OpenAPI v2 不支持它们。

   • 字段 allOf、anyOf、oneOf 和 not 将被删除

2. 如果设置了 nullable: true，我们将删除 type、nullable、items 和 properties，因为 OpenAPI v2 无法表达可为空的特性。为了避免 kubectl 拒绝有效的对象，这是必要的。

额外的打印列

kubectl 工具依赖于服务器端的输出格式化。集群的 API 服务器决定 kubectl get 命令显示的列。您可以为 CustomResourceDefinition 自定义这些列。以下示例添加了 Spec、Replicas 和 Age 列。

将 CustomResourceDefinition 保存到 resourcedefinition.yaml

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: crontabs.stable.example.com
spec:
  group: stable.example.com
  scope: Namespaced
  names:
    plural: crontabs
    singular: crontab
    kind: CronTab
    shortNames:
    - ct
  versions:
  - name: v1
    served: true
    storage: true
    schema:
      openAPIV3Schema:
        type: object
        properties:
          spec:
            type: object
            properties:
              cronSpec:
                type: string
              image:
                type: string
              replicas:
                type: integer
    additionalPrinterColumns:
    - name: Spec
      type: string
      description: The cron spec defining the interval a CronJob is run
      jsonPath: .spec.cronSpec
    - name: Replicas
      type: integer
      description: The number of jobs launched by the CronJob
      jsonPath: .spec.replicas
    - name: Age
      type: date
      jsonPath: .metadata.creationTimestamp

创建 CustomResourceDefinition

kubectl apply -f resourcedefinition.yaml

使用上一节中的 my-crontab.yaml 创建一个实例。

调用服务器端打印

kubectl get crontab my-new-cron-object

请注意输出中的 NAME、SPEC、REPLICAS 和 AGE 列

NAME                 SPEC        REPLICAS   AGE
my-new-cron-object   * * * * *   1          7s

优先级

每列都包含一个 priority 字段。目前，优先级区分在标准视图或宽视图（使用 -o wide 标志）中显示的列。

• 优先级为 0 的列显示在标准视图中。
• 优先级大于 0 的列仅在宽视图中显示。

类型

列的 type 字段可以是以下任何一种（比较 OpenAPI v3 数据类型）

• integer – 非浮点数
• number – 浮点数
• string – 字符串
• boolean – true 或 false
• date – 以自此时间戳以来的时间差呈现。

如果 CustomResource 中的值与为列指定的类型不匹配，则该值将被省略。 使用 CustomResource 验证以确保值类型正确。

格式

列的 format 字段可以是以下任何一种

• int32
• int64
• float
• 具有基于集合的相等性和唯一条目保证的列表
• byte
• date
• date-time
• password

列的 format 控制 kubectl 打印值时使用的样式。

字段选择器

字段选择器 允许客户端基于一个或多个资源字段的值选择自定义资源。

所有自定义资源都支持 metadata.name 和 metadata.namespace 字段选择器。

当 CustomResourceDefinition 中声明的字段包含在 CustomResourceDefinition 的 spec.versions[*].selectableFields 字段中时，也可以与字段选择器一起使用。

自定义资源的可选字段

CustomResourceDefinition 的 spec.versions[*].selectableFields 字段可用于声明自定义资源中的哪些其他字段可以与 CustomResourceFieldSelectors 特性门控 的特性一起用于字段选择器中（自 Kubernetes v1.31 起，此特性门控默认启用）。以下示例添加了 .spec.color 和 .spec.size 字段作为可选字段。

将 CustomResourceDefinition 保存到 shirt-resource-definition.yaml

customresourcedefinition/shirt-resource-definition.yaml

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: shirts.stable.example.com
spec:
  group: stable.example.com
  scope: Namespaced
  names:
    plural: shirts
    singular: shirt
    kind: Shirt
  versions:
  - name: v1
    served: true
    storage: true
    schema:
      openAPIV3Schema:
        type: object
        properties:
          spec:
            type: object
            properties:
              color:
                type: string
              size:
                type: string
    selectableFields:
    - jsonPath: .spec.color
    - jsonPath: .spec.size
    additionalPrinterColumns:
    - jsonPath: .spec.color
      name: Color
      type: string
    - jsonPath: .spec.size
      name: Size
      type: string

创建 CustomResourceDefinition

kubectl apply -f https://k8s.io/examples/customresourcedefinition/shirt-resource-definition.yaml

通过编辑 shirt-resources.yaml 定义一些衬衫； 例如

customresourcedefinition/shirt-resources.yaml

---
apiVersion: stable.example.com/v1
kind: Shirt
metadata:
  name: example1
spec:
  color: blue
  size: S
---
apiVersion: stable.example.com/v1
kind: Shirt
metadata:
  name: example2
spec:
  color: blue
  size: M
---
apiVersion: stable.example.com/v1
kind: Shirt
metadata:
  name: example3
spec:
  color: green
  size: M

创建自定义资源

kubectl apply -f https://k8s.io/examples/customresourcedefinition/shirt-resources.yaml

获取所有资源

kubectl get shirts.stable.example.com

输出结果为

NAME       COLOR  SIZE
example1   blue   S
example2   blue   M
example3   green  M

获取蓝色衬衫（检索 color 为 blue 的衬衫）

kubectl get shirts.stable.example.com --field-selector spec.color=blue

应该输出

NAME       COLOR  SIZE
example1   blue   S
example2   blue   M

仅获取 color 为 green 且 size 为 M 的资源

kubectl get shirts.stable.example.com --field-selector spec.color=green,spec.size=M

应该输出

NAME       COLOR  SIZE
example2   blue   M

子资源

自定义资源支持 /status 和 /scale 子资源。

可以通过在 CustomResourceDefinition 中定义它们来选择性地启用状态和缩放子资源。

状态子资源

启用状态子资源后，将公开自定义资源的 /status 子资源。

• 状态和规范节分别由自定义资源内的 .status 和 .spec JSONPath 表示。

• 对 /status 子资源的 PUT 请求将采用自定义资源对象，并忽略除状态节之外的任何更改。

• 对 /status 子资源的 PUT 请求仅验证自定义资源的状态节。

• 对自定义资源的 PUT/POST/PATCH 请求将忽略对状态节的更改。

• .metadata.generation 值会针对所有更改而递增，但对 .metadata 或 .status 的更改除外。

• 仅允许以下结构在 CRD OpenAPI 验证模式的根部：

  • description
  • example
  • exclusiveMaximum
  • exclusiveMinimum
  • externalDocs
  • format
  • items
  • maximum
  • maxItems
  • maxLength
  • minimum
  • minItems
  • minLength
  • multipleOf
  • pattern
  • properties
  • required
  • title
  • type
  • uniqueItems

缩放子资源

启用缩放子资源后，将公开自定义资源的 /scale 子资源。autoscaling/v1.Scale 对象将作为 /scale 的有效负载发送。

要启用缩放子资源，请在 CustomResourceDefinition 中定义以下字段。

• specReplicasPath 定义自定义资源内与 scale.spec.replicas 相对应的 JSONPath。

  • 它是一个必需的值。
  • 仅允许在 .spec 下且使用点符号的 JSONPath。
  • 如果自定义资源的 specReplicasPath 下没有值，则 /scale 子资源将在 GET 时返回错误。

• statusReplicasPath 定义自定义资源内与 scale.status.replicas 相对应的 JSONPath。

  • 它是一个必需的值。
  • 仅允许在 .status 下且使用点符号的 JSONPath。
  • 如果自定义资源的 statusReplicasPath 下没有值，则 /scale 子资源中的状态副本值将默认为 0。

• labelSelectorPath 定义自定义资源内与 Scale.Status.Selector 相对应的 JSONPath。

  • 这是一个可选值。
  • 它必须设置为与 HPA 和 VPA 一起使用。
  • 仅允许在 .status 或 .spec 下且使用点符号的 JSONPath。
  • 如果自定义资源的 labelSelectorPath 下没有值，则 /scale 子资源中的状态选择器值将默认为空字符串。
  • 此 JSON 路径指向的字段必须是字符串字段（不是复杂的选择器结构），其中包含字符串形式的序列化标签选择器。

在以下示例中，同时启用了状态和缩放子资源。

将 CustomResourceDefinition 保存到 resourcedefinition.yaml

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: crontabs.stable.example.com
spec:
  group: stable.example.com
  versions:
    - name: v1
      served: true
      storage: true
      schema:
        openAPIV3Schema:
          type: object
          properties:
            spec:
              type: object
              properties:
                cronSpec:
                  type: string
                image:
                  type: string
                replicas:
                  type: integer
            status:
              type: object
              properties:
                replicas:
                  type: integer
                labelSelector:
                  type: string
      # subresources describes the subresources for custom resources.
      subresources:
        # status enables the status subresource.
        status: {}
        # scale enables the scale subresource.
        scale:
          # specReplicasPath defines the JSONPath inside of a custom resource that corresponds to Scale.Spec.Replicas.
          specReplicasPath: .spec.replicas
          # statusReplicasPath defines the JSONPath inside of a custom resource that corresponds to Scale.Status.Replicas.
          statusReplicasPath: .status.replicas
          # labelSelectorPath defines the JSONPath inside of a custom resource that corresponds to Scale.Status.Selector.
          labelSelectorPath: .status.labelSelector
  scope: Namespaced
  names:
    plural: crontabs
    singular: crontab
    kind: CronTab
    shortNames:
    - ct

并创建它：

kubectl apply -f resourcedefinition.yaml

创建 CustomResourceDefinition 对象后，您可以创建自定义对象。

如果你将以下 YAML 保存到 my-crontab.yaml

apiVersion: "stable.example.com/v1"
kind: CronTab
metadata:
  name: my-new-cron-object
spec:
  cronSpec: "* * * * */5"
  image: my-awesome-cron-image
  replicas: 3

并创建它

kubectl apply -f my-crontab.yaml

然后在以下位置创建新的命名空间 RESTful API 端点

/apis/stable.example.com/v1/namespaces/*/crontabs/status

和

/apis/stable.example.com/v1/namespaces/*/crontabs/scale

可以使用 kubectl scale 命令缩放自定义资源。例如，以下命令将上面创建的自定义资源的 .spec.replicas 设置为 5

kubectl scale --replicas=5 crontabs/my-new-cron-object
crontabs "my-new-cron-object" scaled

kubectl get crontabs my-new-cron-object -o jsonpath='{.spec.replicas}'
5

您可以使用 PodDisruptionBudget 来保护启用了缩放子资源的自定义资源。

类别

类别是自定义资源所属的分组资源列表（例如 all）。您可以使用 kubectl get <category-name> 列出属于该类别的资源。

以下示例在 CustomResourceDefinition 的类别列表中添加了 all，并说明了如何使用 kubectl get all 输出自定义资源。

将以下 CustomResourceDefinition 保存到 resourcedefinition.yaml

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: crontabs.stable.example.com
spec:
  group: stable.example.com
  versions:
    - name: v1
      served: true
      storage: true
      schema:
        openAPIV3Schema:
          type: object
          properties:
            spec:
              type: object
              properties:
                cronSpec:
                  type: string
                image:
                  type: string
                replicas:
                  type: integer
  scope: Namespaced
  names:
    plural: crontabs
    singular: crontab
    kind: CronTab
    shortNames:
    - ct
    # categories is a list of grouped resources the custom resource belongs to.
    categories:
    - all

并创建它

kubectl apply -f resourcedefinition.yaml

创建 CustomResourceDefinition 对象后，您可以创建自定义对象。

将以下 YAML 保存到 my-crontab.yaml：

apiVersion: "stable.example.com/v1"
kind: CronTab
metadata:
  name: my-new-cron-object
spec:
  cronSpec: "* * * * */5"
  image: my-awesome-cron-image

并创建它

kubectl apply -f my-crontab.yaml

您可以在使用 kubectl get 时指定类别

kubectl get all

它将包含 CronTab 类型的自定义资源

NAME                          AGE
crontabs/my-new-cron-object   3s

下一步

• 阅读有关自定义资源的信息。

• 请参阅 CustomResourceDefinition。

• 提供 CustomResourceDefinition 的多个版本。