APIResourceSchema
APIResourceSchema CRD schema reference (group apis.kcp.io)
Version v1alpha1
Properties
.apiVersion
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
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
.metadata
.spec
Spec holds the desired state.
.spec.conversion
conversion defines conversion settings for the defined custom resource.
.spec.conversion.strategy
strategy 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.
.spec.conversion.webhook
webhook describes how to call the conversion webhook. Required when strategy is set to "Webhook".
.spec.conversion.webhook.clientConfig
clientConfig is the instructions for how to call the webhook if strategy is Webhook.
.spec.conversion.webhook.clientConfig.caBundle
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.
.spec.conversion.webhook.clientConfig.url
url gives the location of the webhook, in standard URL form
(scheme://host:port/path).
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.
Note: kcp does not support provided service names like Kubernetes does.
.spec.conversion.webhook.conversionReviewVersions
conversionReviewVersions 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.
.spec.conversion.webhook.conversionReviewVersions[*]
.spec.group
group is the API group of the defined custom resource. Empty string means the
core API group. The resources are served under /apis/<group>/... or /api for the core group.
.spec.nameValidation
nameValidation can be used to configure name validation for bound APIs.
Allowed values are DNS1123Subdomain and PathSegmentName.
- DNS1123Subdomain: a lowercase RFC 1123 subdomain must consist of lower case
alphanumeric characters, ‘-’ or ‘.’, and must start and end with an alphanumeric character.
Regex used is ‘a-z0-9?(\.a-z0-9?)*’
- PathSegmentName: validates the name can be safely encoded as a path segment.
The name may not be ‘.’ or ‘..’ and the name may not contain ‘/’ or ‘%’.
Defaults to DNS1123Subdomain, matching the behaviour of CRDs.
.spec.names
names specify the resource and kind names for the custom resource.
.spec.names.categories
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
kubectl get all.
.spec.names.categories[*]
.spec.names.kind
kind 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.
.spec.names.listKind
listKind is the serialized kind of the list for this resource. Defaults to “kindList”.
.spec.names.plural
plural 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.
.spec.names.shortNames
shortNames 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.
.spec.names.shortNames[*]
.spec.names.singular
singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased kind.
.spec.scope
scope indicates whether the defined custom resource is cluster- or namespace-scoped.
Allowed values are Cluster and Namespaced.
.spec.versions
versions is the API version of the defined custom resource.
Note: the OpenAPI v3 schemas must be equal for all versions until CEL version migration is supported.
.spec.versions[*]
APIResourceVersion describes one API version of a resource.
.spec.versions[*].additionalPrinterColumns
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.
.spec.versions[*].additionalPrinterColumns[*]
CustomResourceColumnDefinition specifies a column for server side printing.
.spec.versions[*].additionalPrinterColumns[*].description
description is a human readable description of this column.
.spec.versions[*].additionalPrinterColumns[*].format
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.
.spec.versions[*].additionalPrinterColumns[*].jsonPath
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.
.spec.versions[*].additionalPrinterColumns[*].name
name is a human readable name for the column.
.spec.versions[*].additionalPrinterColumns[*].priority
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.
.spec.versions[*].additionalPrinterColumns[*].type
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[*].deprecated
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.
.spec.versions[*].deprecationWarning
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.
.spec.versions[*].name
name 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.
.spec.versions[*].schema
schema describes the structural schema used for validation, pruning, and defaulting of this version of the custom resource.
.spec.versions[*].served
served is a flag enabling/disabling this version from being served via REST APIs
.spec.versions[*].storage
storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.
.spec.versions[*].subresources
subresources specify what subresources this version of the defined custom resource have.
.spec.versions[*].subresources.scale
scale indicates the custom resource should serve a /scale subresource that returns an autoscaling/v1 Scale object.
.spec.versions[*].subresources.scale.labelSelectorPath
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.
.spec.versions[*].subresources.scale.specReplicasPath
specReplicasPath 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.
.spec.versions[*].subresources.scale.statusReplicasPath
statusReplicasPath 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.
.spec.versions[*].subresources.status
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.