# CustomResourceDefinition

CustomResourceDefinitionCustomResourceDefinition represents a resource that should be exposed on the API server.apiVersion: apiextensions.k8s.io/v1import "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"CustomResourceDefinitionCustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.apiVersion: apiextensions.k8s.io/v1kind: CustomResourceDefinitionmetadata (ObjectMeta)Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataspec (CustomResourceDefinitionSpec), requiredspec describes how the user wants the resources to appearstatus (CustomResourceDefinitionStatus)status indicates the actual state of the CustomResourceDefinitionCustomResourceDefinitionSpecCustomResourceDefinitionSpec describes how a user wants their resource to appeargroup (string), requiredgroup is the API group of the defined custom resource. The custom resources are served under /apis/\<group>/.... Must match the name of the CustomResourceDefinition (in the form \<names.plural>.\<group>).names (CustomResourceDefinitionNames), requirednames specify the resource and kind names for the custom resource.CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinitionnames.kind (string), requiredkind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the kind attribute in API calls.names.plural (string), requiredplural is the plural name of the resource to serve. The custom resources are served under /apis/\<group>/\<version>/.../\<plural>. Must match the name of the CustomResourceDefinition (in the form \<names.plural>.\<group>). Must be all lowercase.names.categories ([]string)Atomic: will be replaced during a mergecategories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like kubectl get all.names.listKind (string)listKind is the serialized kind of the list for this resource. Defaults to "kindList".names.shortNames ([]string)Atomic: will be replaced during a mergeshortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like kubectl get \<shortname>. It must be all lowercase.names.singular (string)singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased kind.scope (string), requiredscope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are Cluster and Namespaced.versions ([]CustomResourceDefinitionVersion), requiredAtomic: will be replaced during a mergeversions is the list of all API versions of the defined custom resource. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.CustomResourceDefinitionVersion describes a version for CRD.versions.name (string), requiredname is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at /apis/\<group>/\<version>/... if served is true.versions.served (boolean), requiredserved is a flag enabling/disabling this version from being served via REST APIsversions.storage (boolean), requiredstorage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.versions.additionalPrinterColumns ([]CustomResourceColumnDefinition)Atomic: will be replaced during a mergeadditionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If no columns are specified, a single column displaying the age of the custom resource is used.CustomResourceColumnDefinition specifies a column for server side printing.versions.additionalPrinterColumns.jsonPath (string), requiredjsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column.versions.additionalPrinterColumns.name (string), requiredname is a human readable name for the column.versions.additionalPrinterColumns.type (string), requiredtype is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.versions.additionalPrinterColumns.description (string)description is a human readable description of this column.versions.additionalPrinterColumns.format (string)format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.versions.additionalPrinterColumns.priority (int32)priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0.versions.deprecated (boolean)deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false.versions.deprecationWarning (string)deprecationWarning overrides the default warning returned to API clients. May only be set when deprecated is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists.versions.schema (CustomResourceValidation)schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.CustomResourceValidation is a list of validation methods for CustomResources.versions.schema.openAPIV3Schema (JSONSchemaProps)openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.versions.selectableFields ([]SelectableField)Atomic: will be replaced during a mergeselectableFields specifies paths to fields that may be used as field selectors. A maximum of 8 selectable fields are allowed. See https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectorsSelectableField specifies the JSON path of a field that may be used with field selectors.versions.selectableFields.jsonPath (string), requiredjsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type string, boolean or integer. Types with enum values and strings with formats are allowed. If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string. Must not point to metadata fields. Required.versions.subresources (CustomResourceSubresources)subresources specify what subresources this version of the defined custom resource have.CustomResourceSubresources defines the status and scale subresources for CustomResources.versions.subresources.scale (CustomResourceSubresourceScale)scale indicates the custom resource should serve a /scale subresource that returns an autoscaling/v1 Scale object.CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.versions.subresources.scale.specReplicasPath (string), requiredspecReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale spec.replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .spec. If there is no value under the given path in the custom resource, the /scale subresource will return an error on GET.versions.subresources.scale.statusReplicasPath (string), requiredstatusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale status.replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status. If there is no value under the given path in the custom resource, the status.replicas value in the /scale subresource will default to 0.versions.subresources.scale.labelSelectorPath (string)labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale status.selector. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status or .spec. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the status.selector value in the /scale subresource will default to the empty string.versions.subresources.status (CustomResourceSubresourceStatus)status indicates the custom resource should serve a /status subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the status stanza of the object. 2. requests to the custom resource /status subresource ignore changes to anything other than the status stanza of the object.CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the .status JSON path inside of a CustomResource. When set, * exposes a /status subresource for the custom resource * PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanzaconversion (CustomResourceConversion)conversion defines conversion settings for the CRD.CustomResourceConversion describes how to convert different versions of a CR.conversion.strategy (string), requiredstrategy specifies how custom resources are converted between versions. Allowed values are: - "None": The converter only change the apiVersion and would not touch any other field in the custom resource. - "Webhook": API Server will call to an external webhook to do the conversion. Additional information is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhook to be set.conversion.webhook (WebhookConversion)webhook describes how to call the conversion webhook. Required when strategy is set to "Webhook".WebhookConversion describes how to call a conversion webhookconversion.webhook.conversionReviewVersions ([]string), requiredAtomic: will be replaced during a mergeconversionReviewVersions is an ordered list of preferred ConversionReview versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail.conversion.webhook.clientConfig (WebhookClientConfig)clientConfig is the instructions for how to call the webhook if strategy is Webhook.WebhookClientConfig contains the information to make a TLS connection with the webhook.conversion.webhook.clientConfig.caBundle ([]byte)caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.conversion.webhook.clientConfig.service (ServiceReference)service is a reference to the service for this webhook. Either service or url must be specified.If the webhook is running within the cluster, then you should use service.ServiceReference holds a reference to Service.legacy.k8s.ioconversion.webhook.clientConfig.service.name (string), requiredname is the name of the service. Requiredconversion.webhook.clientConfig.service.namespace (string), requirednamespace is the namespace of the service. Requiredconversion.webhook.clientConfig.service.path (string)path is an optional URL path at which the webhook will be contacted.conversion.webhook.clientConfig.service.port (int32)port is an optional service port at which the webhook will be contacted. port should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.conversion.webhook.clientConfig.url (string)url gives the location of the webhook, in standard URL form (scheme://host:port/path). Exactly one of url or service must be specified.The host should not refer to a service running in the cluster; use the service field instead. The host might be resolved via external DNS in some apiservers (e.g., kube-apiserver cannot resolve in-cluster DNS as that would be a layering violation). host may also be an IP address.Please note that using localhost or 127.0.0.1 as a host is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.The scheme must be "https"; the URL must begin with "https://".A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.preserveUnknownFields (boolean)preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting x-preserve-unknown-fields to true in spec.versions[*].schema.openAPIV3Schema. See https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#field-pruning for details.JSONSchemaPropsJSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).$ref (string)$schema (string)additionalItems (JSONSchemaPropsOrBool)JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.additionalProperties (JSONSchemaPropsOrBool)JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.allOf ([]JSONSchemaProps)Atomic: will be replaced during a mergeanyOf ([]JSONSchemaProps)Atomic: will be replaced during a mergedefault (JSON)default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false.JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.definitions (map[string]JSONSchemaProps)dependencies (map[string]JSONSchemaPropsOrStringArray)JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array.description (string)enum ([]JSON)Atomic: will be replaced during a mergeJSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.example (JSON)JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.exclusiveMaximum (boolean)exclusiveMinimum (boolean)externalDocs (ExternalDocumentation)ExternalDocumentation allows referencing an external resource for extended documentation.externalDocs.description (string)externalDocs.url (string)format (string)format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.id (string)items (JSONSchemaPropsOrArray)JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.maxItems (int64)maxLength (int64)maxProperties (int64)maximum (double)minItems (int64)minLength (int64)minProperties (int64)minimum (double)multipleOf (double)not (JSONSchemaProps)nullable (boolean)oneOf ([]JSONSchemaProps)Atomic: will be replaced during a mergepattern (string)patternProperties (map[string]JSONSchemaProps)properties (map[string]JSONSchemaProps)required ([]string)Atomic: will be replaced during a mergetitle (string)type (string)uniqueItems (boolean)x-kubernetes-embedded-resource (boolean)x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata).x-kubernetes-int-or-string (boolean)x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns:anyOf:type: integertype: stringallOf:anyOf:type: integertype: string... zero or morex-kubernetes-list-map-keys ([]string)Atomic: will be replaced during a mergex-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type map by specifying the keys used as the index of the map.This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported).The properties specified must either be required or have a default value, to ensure those properties are present for all list items.x-kubernetes-list-type (string)x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values:atomic: the list is treated as a single entity, like a scalar. Atomic lists will be entirely replaced when updated. This extension may be used on any type of list (struct, scalar, ...).set: Sets are lists that must not have multiple items with the same value. Each value must be a scalar, an object with x-kubernetes-map-type atomic or an array with x-kubernetes-list-type atomic.map: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays.x-kubernetes-map-type (string)x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values:granular: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps.atomic: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated.x-kubernetes-preserve-unknown-fields (boolean)x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden.x-kubernetes-validations ([]ValidationRule)Patch strategy: merge on key ruleMap: unique values on key rule will be kept during a mergex-kubernetes-validations describes a list of validation rules written in the CEL expression language.ValidationRule describes a validation rule written in the CEL expression language.x-kubernetes-validations.rule (string), requiredRule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The self variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: {"rule": "self.status.actual <= self.spec.maxDesired"}If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via self.field and field presence can be checked via has(self.field). Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible via self[mapKey], map containment can be checked via mapKey in self and all entries of the map are accessible via CEL macros and functions such as self.all(...). If the Rule is scoped to an array, the elements of the array are accessible via self[i] and also by macros and functions. If the Rule is scoped to a scalar, self is bound to the scalar value. Examples: - Rule scoped to a map of objects: {"rule": "self.components['Widget'].priority < 10"} - Rule scoped to a list of integers: {"rule": "self.values.all(value, value >= 0 && value < 100)"} - Rule scoped to a string value: {"rule": "self.startsWith('kube')"}The apiVersion, kind, metadata.name and metadata.generateName are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible.Unknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an "unknown type". An "unknown type" is recursively defined as:A schema with no type and x-kubernetes-preserve-unknown-fields set to trueAn array where the items schema is of an "unknown type"An object where the additionalProperties schema is of an "unknown type"Only property names of the form [a-zA-Z_.-/][a-zA-Z0-9_.-/]* are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '' escapes to 'underscores' - '.' escapes to 'dot' - '-' escapes to 'dash' - '/' escapes to 'slash' - Property names that exactly match a CEL RESERVED keyword escape to '{keyword}__'. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". Examples:Rule accessing a property named "namespace": {"rule": "self.namespace > 0"}Rule accessing a property named "x-prop": {"rule": "self.x__dash__prop > 0"}Rule accessing a property named "redact__d": {"rule": "self.redact__underscores__d > 0"}Equality on arrays with x-kubernetes-list-type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:'set': X + Y performs a union where the array positions of all elements in X are preserved and non-intersecting elements in Y are appended, retaining their partial order.'map': X + Y performs a merge where the array positions of all keys in X are preserved but the values are overwritten by values in Y when the key sets of X and Y intersect. Elements in Y with non-intersecting keys are appended, retaining their partial order.If rule makes use of the oldSelf variable it is implicitly a transition rule.By default, the oldSelf variable is the same type as self. When optionalOldSelf is true, the oldSelf variable is a CEL optional variable whose value() is the same type as self. See the documentation for the optionalOldSelf field for details.Transition rules by default are applied only on UPDATE requests and are skipped if an old value could not be found. You can opt a transition rule into unconditional evaluation by setting optionalOldSelf to true.x-kubernetes-validations.fieldPath (string)fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute foo under a map testMap, the fieldPath could be set to .testMap.foo If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g. .testList It does not support list numeric index. It supports child operation to refer to an existing field currently. Refer to JSONPath support in Kubernetes for more info. Numeric index of array is not supported. For field name which contains special characters, use ['specialName'] to refer the field name. e.g. for attribute foo.34$ appears in a list testList, the fieldPath could be set to .testList['foo.34$']x-kubernetes-validations.message (string)Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host"x-kubernetes-validations.messageExpression (string)MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: "x must be less than max ("+string(self.max)+")"x-kubernetes-validations.optionalOldSelf (boolean)optionalOldSelf is used to opt a transition rule into evaluation even when the object is first created, or if the old object is missing the value.When enabled oldSelf will be a CEL optional whose value will be None if there is no old value, or when the object is initially created.You may check for presence of oldSelf using oldSelf.hasValue() and unwrap it after checking using oldSelf.value(). Check the CEL documentation for Optional types for more information: https://pkg.go.dev/github.com/google/cel-go/cel#OptionalTypesMay not be set unless oldSelf is used in rule.x-kubernetes-validations.reason (string)reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The HTTP status code returned to the caller will match the reason of the reason of the first failed validation rule. The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". If not set, default to use "FieldValueInvalid". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid.CustomResourceDefinitionStatusCustomResourceDefinitionStatus indicates the state of the CustomResourceDefinitionacceptedNames (CustomResourceDefinitionNames)acceptedNames are the names that are actually being used to serve discovery. They may be different than the names in spec.CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinitionacceptedNames.kind (string), requiredkind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the kind attribute in API calls.acceptedNames.plural (string), requiredplural is the plural name of the resource to serve. The custom resources are served under /apis/\<group>/\<version>/.../\<plural>. Must match the name of the CustomResourceDefinition (in the form \<names.plural>.\<group>). Must be all lowercase.acceptedNames.categories ([]string)Atomic: will be replaced during a mergecategories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like kubectl get all.acceptedNames.listKind (string)listKind is the serialized kind of the list for this resource. Defaults to "kindList".acceptedNames.shortNames ([]string)Atomic: will be replaced during a mergeshortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like kubectl get \<shortname>. It must be all lowercase.acceptedNames.singular (string)singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased kind.conditions ([]CustomResourceDefinitionCondition)Map: unique values on key type will be kept during a mergeconditions indicate state for particular aspects of a CustomResourceDefinitionCustomResourceDefinitionCondition contains details for the current condition of this pod.conditions.status (string), requiredstatus is the status of the condition. Can be True, False, Unknown.conditions.type (string), requiredtype is the type of the condition. Types include Established, NamesAccepted and Terminating.conditions.lastTransitionTime (Time)lastTransitionTime last time the condition transitioned from one status to another.Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.conditions.message (string)message is a human-readable message indicating details about last transition.conditions.reason (string)reason is a unique, one-word, CamelCase reason for the condition's last transition.storedVersions ([]string)Atomic: will be replaced during a mergestoredVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from spec.versions while they exist in this list.CustomResourceDefinitionListCustomResourceDefinitionList is a list of CustomResourceDefinition objects.items ([]CustomResourceDefinition), requireditems list individual CustomResourceDefinition objectsapiVersion (string)APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resourceskind (string)Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kindsmetadata (ListMeta)Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataOperationsget read the specified CustomResourceDefinitionHTTP RequestGET /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}Parametersname (in path): string, requiredname of the CustomResourceDefinitionpretty (in query): stringprettyResponse200 (CustomResourceDefinition): OK401: Unauthorizedget read status of the specified CustomResourceDefinitionHTTP RequestGET /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/statusParametersname (in path): string, requiredname of the CustomResourceDefinitionpretty (in query): stringprettyResponse200 (CustomResourceDefinition): OK401: Unauthorizedlist list or watch objects of kind CustomResourceDefinitionHTTP RequestGET /apis/apiextensions.k8s.io/v1/customresourcedefinitionsParametersallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (CustomResourceDefinitionList): OK401: Unauthorizedcreate create a CustomResourceDefinitionHTTP RequestPOST /apis/apiextensions.k8s.io/v1/customresourcedefinitionsParametersbody: CustomResourceDefinition, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (CustomResourceDefinition): OK201 (CustomResourceDefinition): Created202 (CustomResourceDefinition): Accepted401: Unauthorizedupdate replace the specified CustomResourceDefinitionHTTP RequestPUT /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}Parametersname (in path): string, requiredname of the CustomResourceDefinitionbody: CustomResourceDefinition, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (CustomResourceDefinition): OK201 (CustomResourceDefinition): Created401: Unauthorizedupdate replace status of the specified CustomResourceDefinitionHTTP RequestPUT /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/statusParametersname (in path): string, requiredname of the CustomResourceDefinitionbody: CustomResourceDefinition, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (CustomResourceDefinition): OK201 (CustomResourceDefinition): Created401: Unauthorizedpatch partially update the specified CustomResourceDefinitionHTTP RequestPATCH /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}Parametersname (in path): string, requiredname of the CustomResourceDefinitionbody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (CustomResourceDefinition): OK201 (CustomResourceDefinition): Created401: Unauthorizedpatch partially update status of the specified CustomResourceDefinitionHTTP RequestPATCH /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/statusParametersname (in path): string, requiredname of the CustomResourceDefinitionbody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (CustomResourceDefinition): OK201 (CustomResourceDefinition): Created401: Unauthorizeddelete delete a CustomResourceDefinitionHTTP RequestDELETE /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}Parametersname (in path): string, requiredname of the CustomResourceDefinitionbody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (Status): OK202 (Status): Accepted401: Unauthorizeddeletecollection delete collection of CustomResourceDefinitionHTTP RequestDELETE /apis/apiextensions.k8s.io/v1/customresourcedefinitionsParametersbody: DeleteOptionscontinue (in query): stringcontinuedryRun (in query): stringdryRunfieldSelector (in query): stringfieldSelectorgracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentiallabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondsResponse200 (Status): OK401: UnauthorizedThis page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.