- CustomResourceDefinition [apiextensions.k8s.io/v1]
- Specification
- .spec
- .spec.conversion
- .spec.conversion.webhook
- .spec.conversion.webhook.clientConfig
- .spec.conversion.webhook.clientConfig.service
- .spec.names
- .spec.versions
- .spec.versions[]
- .spec.versions[].additionalPrinterColumns
- .spec.versions[].additionalPrinterColumns[]
- .spec.versions[].schema
- .spec.versions[].subresources
- .spec.versions[].subresources.scale
- .spec.versions[].subresources.status
- .status
- .status.acceptedNames
- .status.conditions
- .status.conditions[]
- API endpoints
- /apis/apiextensions.k8s.io/v1/customresourcedefinitions
- /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions
- /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
- /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}
- /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
- Specification
CustomResourceDefinition [apiextensions.k8s.io/v1]
Description
CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.
Type
object
Required
spec
Specification
Property | Type | Description |
---|---|---|
|
| 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#resources |
|
| 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-kinds |
| Standard object’s metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| CustomResourceDefinitionSpec describes how a user wants their resource to appear |
|
| CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition |
.spec
Description
CustomResourceDefinitionSpec describes how a user wants their resource to appear
Type
object
Required
group
names
scope
versions
Property | Type | Description |
---|---|---|
|
| CustomResourceConversion describes how to convert different versions of a CR. |
|
| group is the API group of the defined custom resource. The custom resources are served under |
|
| CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition |
|
| 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 |
|
| scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are |
|
| versions 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. |
.spec.conversion
Description
CustomResourceConversion describes how to convert different versions of a CR.
Type
object
Required
strategy
Property | Type | Description |
---|---|---|
|
| strategy specifies how custom resources are converted between versions. Allowed values are: - |
|
| WebhookConversion describes how to call a conversion webhook |
.spec.conversion.webhook
Description
WebhookConversion describes how to call a conversion webhook
Type
object
Required
conversionReviewVersions
Property | Type | Description |
---|---|---|
|
| WebhookClientConfig contains the information to make a TLS connection with the webhook. |
|
| conversionReviewVersions is an ordered list of preferred |
.spec.conversion.webhook.clientConfig
Description
WebhookClientConfig contains the information to make a TLS connection with the webhook.
Type
object
Property | Type | Description |
---|---|---|
|
| 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. |
|
| ServiceReference holds a reference to Service.legacy.k8s.io |
|
| url gives the location of the webhook, in standard URL form ( The Please note that using 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. |
.spec.conversion.webhook.clientConfig.service
Description
ServiceReference holds a reference to Service.legacy.k8s.io
Type
object
Required
namespace
name
Property | Type | Description |
---|---|---|
|
| name is the name of the service. Required |
|
| namespace is the namespace of the service. Required |
|
| path is an optional URL path at which the webhook will be contacted. |
|
| port is an optional service port at which the webhook will be contacted. |
.spec.names
Description
CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition
Type
object
Required
plural
kind
Property | Type | Description |
---|---|---|
|
| categories 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 |
|
| kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the |
|
| listKind is the serialized kind of the list for this resource. Defaults to “ |
|
| plural is the plural name of the resource to serve. The custom resources are served under |
|
| shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like |
|
| singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased |
.spec.versions
Description
versions 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.
Type
array
.spec.versions[]
Description
CustomResourceDefinitionVersion describes a version for CRD.
Type
object
Required
name
served
storage
Property | Type | Description |
---|---|---|
|
| additionalPrinterColumns 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. |
|
| 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. |
|
| deprecationWarning overrides the default warning returned to API clients. May only be set when |
|
| name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at |
|
| CustomResourceValidation is a list of validation methods for CustomResources. |
|
| served is a flag enabling/disabling this version from being served via REST APIs |
|
| storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true. |
|
| CustomResourceSubresources defines the status and scale subresources for CustomResources. |
.spec.versions[].additionalPrinterColumns
Description
additionalPrinterColumns 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.
Type
array
.spec.versions[].additionalPrinterColumns[]
Description
CustomResourceColumnDefinition specifies a column for server side printing.
Type
object
Required
name
type
jsonPath
Property | Type | Description |
---|---|---|
|
| description is a human readable description of this column. |
|
| 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. |
|
| jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column. |
|
| name is a human readable name for the column. |
|
| 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. |
|
| type 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. |
.spec.versions[].schema
Description
CustomResourceValidation is a list of validation methods for CustomResources.
Type
object
Property | Type | Description |
---|---|---|
| openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning. |
.spec.versions[].subresources
Description
CustomResourceSubresources defines the status and scale subresources for CustomResources.
Type
object
Property | Type | Description |
---|---|---|
|
| CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources. |
|
| CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the |
.spec.versions[].subresources.scale
Description
CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.
Type
object
Required
specReplicasPath
statusReplicasPath
Property | Type | Description |
---|---|---|
|
| labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale |
|
| specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale |
|
| statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale |
.spec.versions[].subresources.status
Description
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 stanza
Type
object
.status
Description
CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition
Type
object
Property | Type | Description |
---|---|---|
|
| CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition |
|
| conditions indicate state for particular aspects of a CustomResourceDefinition |
|
| CustomResourceDefinitionCondition contains details for the current condition of this pod. |
|
| storedVersions 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 |
.status.acceptedNames
Description
CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition
Type
object
Required
plural
kind
Property | Type | Description |
---|---|---|
|
| categories 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 |
|
| kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the |
|
| listKind is the serialized kind of the list for this resource. Defaults to “ |
|
| plural is the plural name of the resource to serve. The custom resources are served under |
|
| shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like |
|
| singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased |
.status.conditions
Description
conditions indicate state for particular aspects of a CustomResourceDefinition
Type
array
.status.conditions[]
Description
CustomResourceDefinitionCondition contains details for the current condition of this pod.
Type
object
Required
type
status
Property | Type | Description |
---|---|---|
| lastTransitionTime last time the condition transitioned from one status to another. | |
|
| message is a human-readable message indicating details about last transition. |
|
| reason is a unique, one-word, CamelCase reason for the condition’s last transition. |
|
| status is the status of the condition. Can be True, False, Unknown. |
|
| type is the type of the condition. Types include Established, NamesAccepted and Terminating. |
API endpoints
The following API endpoints are available:
/apis/apiextensions.k8s.io/v1/customresourcedefinitions
DELETE
: delete collection of CustomResourceDefinitionGET
: list or watch objects of kind CustomResourceDefinitionPOST
: create a CustomResourceDefinition
/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions
GET
: watch individual changes to a list of CustomResourceDefinition. deprecated: use the ‘watch’ parameter with a list operation instead.
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
DELETE
: delete a CustomResourceDefinitionGET
: read the specified CustomResourceDefinitionPATCH
: partially update the specified CustomResourceDefinitionPUT
: replace the specified CustomResourceDefinition
/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}
GET
: watch changes to an object of kind CustomResourceDefinition. deprecated: use the ‘watch’ parameter with a list operation instead, filtered to a single item with the ‘fieldSelector’ parameter.
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
GET
: read status of the specified CustomResourceDefinitionPATCH
: partially update status of the specified CustomResourceDefinitionPUT
: replace status of the specified CustomResourceDefinition
/apis/apiextensions.k8s.io/v1/customresourcedefinitions
HTTP method
DELETE
Description
delete collection of CustomResourceDefinition
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
list or watch objects of kind CustomResourceDefinition
HTTP code | Reponse body |
---|---|
200 - OK | CustomResourceDefinitionList schema |
401 - Unauthorized | Empty |
HTTP method
POST
Description
create a CustomResourceDefinition
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Parameter | Type | Description |
---|---|---|
| CustomResourceDefinition schema |
HTTP code | Reponse body |
---|---|
200 - OK | CustomResourceDefinition schema |
201 - Created | CustomResourceDefinition schema |
202 - Accepted | CustomResourceDefinition schema |
401 - Unauthorized | Empty |
/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions
HTTP method
GET
Description
watch individual changes to a list of CustomResourceDefinition. deprecated: use the ‘watch’ parameter with a list operation instead.
HTTP code | Reponse body |
---|---|
200 - OK | WatchEvent schema |
401 - Unauthorized | Empty |
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the CustomResourceDefinition |
HTTP method
DELETE
Description
delete a CustomResourceDefinition
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
202 - Accepted | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
read the specified CustomResourceDefinition
HTTP code | Reponse body |
---|---|
200 - OK | CustomResourceDefinition schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update the specified CustomResourceDefinition
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
HTTP code | Reponse body |
---|---|
200 - OK | CustomResourceDefinition schema |
201 - Created | CustomResourceDefinition schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace the specified CustomResourceDefinition
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Parameter | Type | Description |
---|---|---|
| CustomResourceDefinition schema |
HTTP code | Reponse body |
---|---|
200 - OK | CustomResourceDefinition schema |
201 - Created | CustomResourceDefinition schema |
401 - Unauthorized | Empty |
/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the CustomResourceDefinition |
HTTP method
GET
Description
watch changes to an object of kind CustomResourceDefinition. deprecated: use the ‘watch’ parameter with a list operation instead, filtered to a single item with the ‘fieldSelector’ parameter.
HTTP code | Reponse body |
---|---|
200 - OK | WatchEvent schema |
401 - Unauthorized | Empty |
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
Parameter | Type | Description |
---|---|---|
|
| name of the CustomResourceDefinition |
HTTP method
GET
Description
read status of the specified CustomResourceDefinition
HTTP code | Reponse body |
---|---|
200 - OK | CustomResourceDefinition schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update status of the specified CustomResourceDefinition
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
HTTP code | Reponse body |
---|---|
200 - OK | CustomResourceDefinition schema |
201 - Created | CustomResourceDefinition schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace status of the specified CustomResourceDefinition
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Parameter | Type | Description |
---|---|---|
| CustomResourceDefinition schema |
HTTP code | Reponse body |
---|---|
200 - OK | CustomResourceDefinition schema |
201 - Created | CustomResourceDefinition schema |
401 - Unauthorized | Empty |