CompositeResourceDefinition

apiextensions.crossplane.io / v2

apiVersion: apiextensions.crossplane.io/v2 kind: CompositeResourceDefinition metadata: name: example

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

CompositeResourceDefinitionSpec specifies the desired state of the definition.

claimNames object

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. Deprecated: Claims aren't supported in apiextensions.crossplane.io/v2.

categories []string

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

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.

listKind string

listKind is the serialized kind of the list for this resource. Defaults to "`kind`List".

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.

shortNames []string

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.

singular string

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

connectionSecretKeys []string

ConnectionSecretKeys is the list of connection secret keys the defined XR can publish. If the list is empty, all keys will be published. If the list isn't empty, any connection secret keys that don't appear in the list will be filtered out. Only LegacyCluster XRs support connection secrets. Deprecated: XR connection secrets aren't supported in apiextensions.crossplane.io/v2. Compose a secret instead.

conversion object

Conversion defines all conversion settings for the defined Composite resource.

strategy string required

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.

webhook object

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

clientConfig object

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

caBundle string

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.

format: byte

service object

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

name string required

name is the name of the service. Required

namespace string required

namespace is the namespace of the service. Required

path string

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

port integer

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.

format: int32

url string

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.

conversionReviewVersions []string required

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.

defaultCompositeDeletePolicy string

DefaultCompositeDeletePolicy is the policy used when deleting the Composite that is associated with the Claim if no policy has been specified. Deprecated: Claims aren't supported in apiextensions.crossplane.io/v2.

enum: Background, Foreground

defaultCompositionRef object

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

name string required

Name of the Composition.

defaultCompositionRevisionSelector object

DefaultCompositionRevisionSelector refers to the CompositionRevision that will be used in case no compositionRevision selector is given.

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

matchLabels object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

defaultCompositionUpdatePolicy string

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.

enum: Automatic, Manual

enforcedCompositionRef object

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

name string required

Name of the Composition.

group string required

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

metadata object

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

annotations object

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

labels object

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

names object required

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

categories []string

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.

listKind string

listKind is the serialized kind of the list for this resource. Defaults to "`kind`List".

plural string required

shortNames []string

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.

singular string

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

scope string

Scope of the defined composite resource. Namespaced composite resources are scoped to a single namespace. Cluster scoped composite resource exist outside the scope of any namespace.

enum: Namespaced, Cluster

versions []object required

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.

additionalPrinterColumns []object

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

description string

description is a human readable description of this column.

format string

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.

jsonPath string required

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.

name string required

name is a human readable name for the column.

priority integer

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.

format: int32

type string required

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.

deprecated boolean

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

deprecationWarning string

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

maxLength: 256

name string required

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

referenceable boolean required

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.

schema object

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.

openAPIV3Schema object

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

served boolean required

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

subresources object

Subresources specifies what subresources this version of the defined Composite resource has. The composition authors have responsibility to implement the logic fulfilling the subresources.

scale object

Scale indicates the CRD should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object.

labelSelectorPath string

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.

specReplicasPath string required

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.

statusReplicasPath string required

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.

status object

CompositeResourceDefinitionStatus shows the observed state of the definition.

conditions []object

Conditions of the resource.

lastTransitionTime string required

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

format: date-time

message string

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

observedGeneration integer

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.

format: int64

reason string required

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

status string required

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

type string required

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

controllers object

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

compositeResourceClaimType object

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.

apiVersion string required

APIVersion of the type.

kind string required

Kind of the type.

compositeResourceType object

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.

apiVersion string required

APIVersion of the type.

kind string required

Kind of the type.

No matches. Try .spec.claimNames for an exact path