apiextensions.crossplane.io / v1 / CompositeResourceDefinition

• string

  .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

• string

  .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

• object

  .metadata

• object

  .spec

  CompositeResourceDefinitionSpec specifies the desired state of the definition.

• object

  .spec .claimNames

  ClaimNames specifies the names of an optional composite resource claim. When claim names are specified Crossplane will create a namespaced ‘composite resource claim’ CRD that corresponds to the defined composite resource. This composite resource claim acts as a namespaced proxy for the composite resource; creating, updating, or deleting the claim will create, update, or delete a corresponding composite resource. You may add claim names to an existing CompositeResourceDefinition, but they cannot be changed or removed once they have been set.

• array

  .spec .claimNames .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.

• string required

  .spec .claimNames .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.

• string

  .spec .claimNames .listKind

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

• string required

  .spec .claimNames .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.

• array

  .spec .claimNames .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.

• string

  .spec .claimNames .singular

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

• array

  .spec .connectionSecretKeys

  ConnectionSecretKeys is the list of keys that will be exposed to the end user of the defined kind. If the list is empty, all keys will be published.

• object

  .spec .conversion

  Conversion defines all conversion settings for the defined Composite resource.

• string required

  .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.
• object

  .spec .conversion .webhook

  webhook describes how to call the conversion webhook. Required when strategy is set to "Webhook".

• object

  .spec .conversion .webhook .clientConfig

  clientConfig is the instructions for how to call the webhook if strategy is Webhook.

• string

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

• object

  .spec .conversion .webhook .clientConfig .service

  service is a reference to the service for this webhook. Either service or url must be specified.

  If the webhook is running within the cluster, then you should use service.

• string required

  .spec .conversion .webhook .clientConfig .service .name

  name is the name of the service. Required

• string required

  .spec .conversion .webhook .clientConfig .service .namespace

  namespace is the namespace of the service. Required

• string

  .spec .conversion .webhook .clientConfig .service .path

  path is an optional URL path at which the webhook will be contacted.

• integer

  .spec .conversion .webhook .clientConfig .service .port

  port is an optional service port at which the webhook will be contacted. port should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.

• string

  .spec .conversion .webhook .clientConfig .url

  url gives the location of the webhook, in standard URL form (scheme://host:port/path). Exactly one of url or service must be specified.

  The host should not refer to a service running in the cluster; use the service field instead. The host might be resolved via external DNS in some apiservers (e.g., kube-apiserver cannot resolve in-cluster DNS as that would be a layering violation). host may also be an IP address.

  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.

• array required

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

• string

  .spec .defaultCompositeDeletePolicy

  DefaultCompositeDeletePolicy is the policy used when deleting the Composite that is associated with the Claim if no policy has been specified.

• object

  .spec .defaultCompositionRef

  DefaultCompositionRef refers to the Composition resource that will be used in case no composition selector is given.

• string required

  .spec .defaultCompositionRef .name

  Name of the Composition.

• string

  .spec .defaultCompositionUpdatePolicy

  DefaultCompositionUpdatePolicy is the policy used when updating composites after a new Composition Revision has been created if no policy has been specified on the composite.

• object

  .spec .enforcedCompositionRef

  EnforcedCompositionRef refers to the Composition resource that will be used by all composite instances whose schema is defined by this definition.

• string required

  .spec .enforcedCompositionRef .name

  Name of the Composition.

• string required

  .spec .group

  Group specifies the API group of the defined composite resource. Composite resources are served under /apis/<group>/.... Must match the name of the XRD (in the form <names.plural>.<group>).

• object

  .spec .metadata

  Metadata specifies the desired metadata for the defined composite resource and claim CRD’s.

• object

  .spec .metadata .annotations

  Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

• object

  .spec .metadata .labels

  Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels and services. These labels are added to the composite resource and claim CRD’s in addition to any labels defined by CompositionResourceDefinition metadata.labels.

• object required

  .spec .names

  Names specifies the resource and kind names of the defined composite resource.

• array

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

• string required

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

• string

  .spec .names .listKind

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

• string required

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

• array

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

• string

  .spec .names .singular

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

• array required

  .spec .versions

  Versions is the list of all API versions of the defined composite 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.

• array

  .spec .versions[] .additionalPrinterColumns

  AdditionalPrinterColumns specifies additional columns returned in Table output. If no columns are specified, a single column displaying the age of the custom resource is used. See the following link for details: https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables

• string

  .spec .versions[] .additionalPrinterColumns[] .description

  description is a human readable description of this column.

• string

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

• string required

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

• string required

  .spec .versions[] .additionalPrinterColumns[] .name

  name is a human readable name for the column.

• integer

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

• string required

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

• boolean

  .spec .versions[] .deprecated

  The deprecated field specifies that this version is deprecated and should not be used.

• string

  .spec .versions[] .deprecationWarning

  DeprecationWarning specifies the message that should be shown to the user when using this version.

• string required

  .spec .versions[] .name

  Name of this version, e.g. “v1”, “v2beta1”, etc. Composite resources are served under this version at /apis/<group>/<version>/... if served is true.

• boolean required

  .spec .versions[] .referenceable

  Referenceable specifies that this version may be referenced by a Composition in order to configure which resources an XR may be composed of. Exactly one version must be marked as referenceable; all Compositions must target only the referenceable version. The referenceable version must be served. It’s mapped to the CRD’s spec.versions[*].storage field.

• object

  .spec .versions[] .schema

  Schema describes the schema used for validation, pruning, and defaulting of this version of the defined composite resource. Fields required by all composite resources will be injected into this schema automatically, and will override equivalently named fields in this schema. Omitting this schema results in a schema that contains only the fields required by all composite resources.

• object

  .spec .versions[] .schema .openAPIV3Schema

  OpenAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.

• boolean required

  .spec .versions[] .served

  Served specifies that this version should be served via REST APIs.

• object

  .status

  CompositeResourceDefinitionStatus shows the observed state of the definition.

• array

  .status .conditions

  Conditions of the resource.

• string required

  .status .conditions[] .lastTransitionTime

  LastTransitionTime is the last time this condition transitioned from one status to another.

• string

  .status .conditions[] .message

  A Message containing details about this condition’s last transition from one status to another, if any.

• integer

  .status .conditions[] .observedGeneration

  ObservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

• string required

  .status .conditions[] .reason

  A Reason for this condition’s last transition from one status to another.

• string required

  .status .conditions[] .status

  Status of this condition; is it currently True, False, or Unknown?

• string required

  .status .conditions[] .type

  Type of this condition. At most one of each condition type may apply to a resource at any point in time.

• object

  .status .controllers

  Controllers represents the status of the controllers that power this composite resource definition.

• object

  .status .controllers .compositeResourceClaimType

  The CompositeResourceClaimTypeRef is the type of composite resource claim that Crossplane is currently reconciling for this definition. Its version will eventually become consistent with the definition’s referenceable version. Note that clients may interact with any served type; this is simply the type that Crossplane interacts with.

• string required

  .status .controllers .compositeResourceClaimType .apiVersion

  APIVersion of the type.

• string required

  .status .controllers .compositeResourceClaimType .kind

  Kind of the type.

• object

  .status .controllers .compositeResourceType

  The CompositeResourceTypeRef is the type of composite resource that Crossplane is currently reconciling for this definition. Its version will eventually become consistent with the definition’s referenceable version. Note that clients may interact with any served type; this is simply the type that Crossplane interacts with.

• string required

  .status .controllers .compositeResourceType .apiVersion

  APIVersion of the type.

• string required

  .status .controllers .compositeResourceType .kind

  Kind of the type.