CustomResourceDefinitionSpec describes how a user wants their resource to appear
CustomResourceDefinitionSpec describes how a user wants their resource to appear
- Value Params
- group
group 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>
).- preserveUnknownFields
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 inspec.versions[*].schema.openAPIV3Schema
. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.- scope
scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are
Cluster
andNamespaced
.- versions
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.
- Companion
- object
Value members
Concrete methods
Gets conversion.
Gets conversion.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
group 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>
).
group 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>
).
This effect always succeeds, it is safe to use the field group directly.
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/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
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/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are Cluster
and Namespaced
.
scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are Cluster
and Namespaced
.
This effect always succeeds, it is safe to use the field scope directly.
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.
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.
This effect always succeeds, it is safe to use the field versions directly.