APIResourceImport

APIResourceImport CRD schema reference (group apiresource.kcp.io)

APIResourceImport describes an API resource imported from external clusters (either physical or logical) for a given GVR.

Full name:

apiresourceimports.apiresource.kcp.io

Group:

apiresource.kcp.io

Singular name:

apiresourceimport

Plural name:

apiresourceimports

Scope:

Cluster

Versions:

v1alpha1

Version v1alpha1

Properties

.apiVersion

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#resources

.kind

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-kinds

.metadata

object

.spec

object

APIResourceImportSpec holds the desired state of the APIResourceImport (from the client).

.spec.categories

array

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.categories[*]

string

.spec.columnDefinitions

array

.spec.columnDefinitions[*]

object

.spec.columnDefinitions[*].description

string Required

description is a human readable description of this column.

.spec.columnDefinitions[*].format

string Required

format is an optional OpenAPI type modifier for this column. A format modifies the type and imposes additional rules, like date or time formatting for a string. The ‘name’ format is applied to the primary identifier column which has type ‘string’ 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 more.

.spec.columnDefinitions[*].jsonPath

string Required

.spec.columnDefinitions[*].name

string Required

name is a human readable name for the column.

.spec.columnDefinitions[*].priority

integer Required

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 higher priority.

.spec.columnDefinitions[*].type

string Required

type is an OpenAPI type definition for this column, such as number, integer, string, or array. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more.

.spec.groupVersion

object Required

.spec.groupVersion.group

string

.spec.groupVersion.version

string Required

.spec.kind

string Required

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.listKind

string

listKind is the serialized kind of the list for this resource. Defaults to “kindList”.

.spec.location

string Required

Locaton the API resource is imported from This field is required

.spec.openAPIV3Schema

object Required

.spec.plural

string Required

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.schemaUpdateStrategy

string

SchemaUpdateStrategy defines the schema update strategy for this API Resource import. Default value is UpdateUnpublished

.spec.scope

string Required

ResourceScope is an enum defining the different scopes available to a custom resource

.spec.shortNames

array

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.shortNames[*]

string

.spec.singular

string

singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased kind.

.spec.subResources

array

.spec.subResources[*]

object

.spec.subResources[*].name

string Required

.status

object

APIResourceImportStatus communicates the observed state of the APIResourceImport (from the controller).

.status.conditions

array

.status.conditions[*]

object

APIResourceImportCondition contains details for the current condition of this negotiated api resource.

.status.conditions[*].lastTransitionTime

string

Last time the condition transitioned from one status to another.

.status.conditions[*].message

string

Human-readable message indicating details about last transition.

.status.conditions[*].reason

string

Unique, one-word, CamelCase reason for the condition’s last transition.

.status.conditions[*].status

string Required

Status is the status of the condition. Can be True, False, Unknown.

.status.conditions[*].type

string Required

Type is the type of the condition. Types include Compatible.