Composition

apiextensions.crossplane.io / v1

apiVersion: apiextensions.crossplane.io/v1 kind: Composition 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

CompositionSpec specifies desired state of a composition.

compositeTypeRef object required

CompositeTypeRef specifies the type of composite resource that this composition is compatible with.

apiVersion string required

APIVersion of the type.

kind string required

Kind of the type.

mode string

Mode controls what type or "mode" of Composition will be used. "Pipeline" indicates that a Composition specifies a pipeline of functions, each of which is responsible for producing composed resources that Crossplane should create or update.

enum: Pipeline

pipeline []object

Pipeline is a list of composition function steps that will be used when a composite resource referring to this composition is created. One of resources and pipeline must be specified - you cannot specify both. The Pipeline is only used by the "Pipeline" mode of Composition. It is ignored by other modes.

minItems: 1

maxItems: 99

credentials []object

Credentials are optional credentials that the function needs.

name string required

Name of this set of credentials.

secretRef object

A SecretRef is a reference to a secret containing credentials that should be supplied to the function.

name string required

Name of the secret.

namespace string required

Namespace of the secret.

source string required

Source of the function credentials.

enum: None, Secret

functionRef object required

FunctionRef is a reference to the function this step should execute.

name string required

Name of the referenced Function.

input object

Input is an optional, arbitrary Kubernetes resource (i.e. a resource with an apiVersion and kind) that will be passed to the function as the 'input' of its RunFunctionRequest.

requirements object

Requirements are resource requirements that will be satisfied before this pipeline step is called for the first time. This allows pre-populating required resources without requiring a function to request them first.

requiredResources []object

RequiredResources is a list of resources that must be fetched before this function is called.

apiVersion string required

APIVersion of the required resource.

kind string required

Kind of the required resource.

matchLabels object

MatchLabels specifies the set of labels to match for finding the required resource. When specified, Name is ignored.

name string

Name of the required resource.

namespace string

Namespace of the required resource if it is namespaced.

requirementName string required

RequirementName is the unique name to identify this required resource in the Required Resources map in the function request.

requiredSchemas []object

RequiredSchemas is a list of OpenAPI schemas that must be fetched before this function is called.

apiVersion string required

APIVersion of the resource kind whose schema is required, e.g. "example.org/v1".

kind string required

Kind of resource whose schema is required, e.g. "MyResource".

requirementName string required

RequirementName is the unique name to identify this required schema in the Required Schemas map in the function request.

step string required

Step name. Must be unique within its Pipeline.

writeConnectionSecretsToNamespace string

WriteConnectionSecretsToNamespace specifies the namespace in which the connection secrets of composite resource dynamically provisioned using this composition will be created.

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