APIServiceExport
APIServiceExport CRD schema reference (group kube-bind.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 specifies the resource.
.spec.clusterScopedIsolation
ClusterScopedIsolation specifies how cluster scoped service objects are isolated between multiple consumers on the provider side. It can be “Prefixed”, “Namespaced”, or “None”.
.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.informerScope
informerScope is the scope of the APIServiceExport. It can be either Cluster or Namespace.
Cluster: The konnector has permission to watch all namespaces at once and cluster-scoped resources. This is more efficient than watching each namespace individually. Namespaced: The konnector has permission to watch only single namespaces. This is more resource intensive. And it means cluster-scoped resources cannot be exported.
.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[*]
APIServiceExportVersion 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[*].schema.openAPIV3Schema
openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.
.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.
.status
status contains reconciliation information for the resource.
.status.acceptedNames
acceptedNames are the names that are actually being used to serve discovery. They may be different than the names in spec.
.status.acceptedNames.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.
.status.acceptedNames.categories[*]
.status.acceptedNames.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.
.status.acceptedNames.listKind
listKind is the serialized kind of the list for this resource. Defaults to “kindList”.
.status.acceptedNames.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.
.status.acceptedNames.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.
.status.acceptedNames.shortNames[*]
.status.acceptedNames.singular
singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased kind.
.status.conditions
conditions is a list of conditions that apply to the APIServiceExport. It is updated by the konnector on the consumer cluster.
.status.conditions[*]
Condition defines an observation of a object operational state.
.status.conditions[*].lastTransitionTime
Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
.status.conditions[*].message
A human readable message indicating details about the transition. This field may be empty.
.status.conditions[*].reason
The reason for the condition’s last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.
.status.conditions[*].severity
Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.
.status.conditions[*].status
Status of the condition, one of True, False, Unknown.
.status.conditions[*].type
Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.
.status.storedVersions
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 spec.versions while they exist in this list.