ResourcesResources specifies Patch & Transform resource templates.
TypeMR
Providerfunction-patch-and-transform
Grouppt.fn.crossplane.io
Scopenamespaced
Versionv1beta1

1apiVersion: pt.fn.crossplane.io/v1beta1

2kind: Resources

object

Environment represents the Composition environment.

THIS IS AN ALPHA FIELD. Do not use it in production. It may be changed or removed without notice.

patches
array

Patches is a list of environment patches that are executed before a composition's resources are composed. These patches are between the XR and the Environment. Either from the Environment to the XR, or vice versa.

combine
object

Combine is the patch configuration for a CombineFromComposite, CombineToComposite patch.

strategy
required
string
string
object

String declares that input variables should be combined into a single string, using the relevant settings for formatting purposes.

fmt
required
string
variables
required
array

Variables are the list of variables whose values will be retrieved and combined.

fromFieldPath
required
string
policy
object

Policy configures the specifics of patching behaviour.

array

Transforms are the list of functions that are used as a FIFO pipe for the input to be transformed.

convert
object

Convert is used to cast the input into the given output type.

format
string
toType
required
string
map
object
match
object

Match is a more complex version of Map that matches a list of patterns.

array

The patterns that should be tested against the input string. Patterns are tested in order. The value of the first match is used as result of this transform.

literal
string
regexp
string
result
required
type
required
string
math
object

Math is used to transform the input via mathematical operations such as multiplication.

clampMax
integer
clampMin
integer
multiply
integer
type
string
string
object

String is used to transform the input into a string or a different kind of string. Note that the input does not necessarily need to be a string.

convert
string
fmt
string
join
object

Join the input strings.

separator
required
string
regexp
object

Extract a match from the input using a regular expression.

group
integer
match
required
string
replace
object

Search/Replace applied to the input string.

replace
required
string
search
required
string
trim
string
type
required
string
type
required
string
type
string
kind
string
metadata
object
array

PatchSets define a named set of patches that may be included by any resource. PatchSets cannot themselves refer to other PatchSets.

name
required
string
patches
required
array

Patches will be applied as an overlay to the base resource.

combine
object

Combine is the patch configuration for a CombineFromComposite, CombineToComposite patch.

strategy
required
string
string
object

String declares that input variables should be combined into a single string, using the relevant settings for formatting purposes.

fmt
required
string
variables
required
array

Variables are the list of variables whose values will be retrieved and combined.

fromFieldPath
required
string
policy
object

Policy configures the specifics of patching behaviour.

array

Transforms are the list of functions that are used as a FIFO pipe for the input to be transformed.

convert
object

Convert is used to cast the input into the given output type.

format
string
toType
required
string
map
object
match
object

Match is a more complex version of Map that matches a list of patterns.

array

The patterns that should be tested against the input string. Patterns are tested in order. The value of the first match is used as result of this transform.

literal
string
regexp
string
result
required
type
required
string
math
object

Math is used to transform the input via mathematical operations such as multiplication.

clampMax
integer
clampMin
integer
multiply
integer
type
string
string
object

String is used to transform the input into a string or a different kind of string. Note that the input does not necessarily need to be a string.

convert
string
fmt
string
join
object

Join the input strings.

separator
required
string
regexp
object

Extract a match from the input using a regular expression.

group
integer
match
required
string
replace
object

Search/Replace applied to the input string.

replace
required
string
search
required
string
trim
string
type
required
string
type
required
string
type
string
array

Resources is a list of resource templates that will be used when a composite resource is created.

base
object
array

ConnectionDetails lists the propagation secret keys from this composed resource to the composition instance connection secret.

name
required
string
type
required
string
value
string
name
required
string
patches
array

Patches to and from the composed resource.

combine
object

Combine is the patch configuration for a CombineFromComposite, CombineToComposite patch.

strategy
required
string
string
object

String declares that input variables should be combined into a single string, using the relevant settings for formatting purposes.

fmt
required
string
variables
required
array

Variables are the list of variables whose values will be retrieved and combined.

fromFieldPath
required
string
policy
object

Policy configures the specifics of patching behaviour.

array

Transforms are the list of functions that are used as a FIFO pipe for the input to be transformed.

convert
object

Convert is used to cast the input into the given output type.

format
string
toType
required
string
map
object
match
object

Match is a more complex version of Map that matches a list of patterns.

array

The patterns that should be tested against the input string. Patterns are tested in order. The value of the first match is used as result of this transform.

literal
string
regexp
string
result
required
type
required
string
math
object

Math is used to transform the input via mathematical operations such as multiplication.

clampMax
integer
clampMin
integer
multiply
integer
type
string
string
object

String is used to transform the input into a string or a different kind of string. Note that the input does not necessarily need to be a string.

convert
string
fmt
string
join
object

Join the input strings.

separator
required
string
regexp
object

Extract a match from the input using a regular expression.

group
integer
match
required
string
replace
object

Search/Replace applied to the input string.

replace
required
string
search
required
string
trim
string
type
required
string
type
required
string
type
string
array

ReadinessChecks allows users to define custom readiness checks. All checks have to return true in order for resource to be considered ready. The default readiness check is to have the "Ready" condition to be "True".

fieldPath
string
object

MatchCondition specifies the condition you'd like to match if you're using "MatchCondition" type.

status
required
string
type
required
string
type
required
string
object

WriteConnectionSecretToRef specifies the name and namespace of a Secret to which any connection details for this composite resource should be written. This field is only used for Crossplane v2 composite resources. For v1 composite resources, connection details are returned via the RunFunctionResponse and handled by Crossplane core.

name
string
namespace
string
patches
array

Patches define transformations to apply to the connection secret reference. Patches are only applied from the composite resource to the secret reference. Supported patch types: FromCompositeFieldPath, CombineFromComposite. ToFieldPath must be either "name" or "namespace".

combine
object

Combine is the patch configuration for a CombineFromComposite, CombineToComposite patch.

strategy
required
string
string
object

String declares that input variables should be combined into a single string, using the relevant settings for formatting purposes.

fmt
required
string
variables
required
array

Variables are the list of variables whose values will be retrieved and combined.

fromFieldPath
required
string
policy
object

Policy configures the specifics of patching behaviour.

array

Transforms are the list of functions that are used as a FIFO pipe for the input to be transformed.

convert
object

Convert is used to cast the input into the given output type.

format
string
toType
required
string
map
object
match
object

Match is a more complex version of Map that matches a list of patterns.

array

The patterns that should be tested against the input string. Patterns are tested in order. The value of the first match is used as result of this transform.

literal
string
regexp
string
result
required
type
required
string
math
object

Math is used to transform the input via mathematical operations such as multiplication.

clampMax
integer
clampMin
integer
multiply
integer
type
string
string
object

String is used to transform the input into a string or a different kind of string. Note that the input does not necessarily need to be a string.

convert
string
fmt
string
join
object

Join the input strings.

separator
required
string
regexp
object

Extract a match from the input using a regular expression.

group
integer
match
required
string
replace
object

Search/Replace applied to the input string.

replace
required
string
search
required
string
trim
string
type
required
string
type
required
string
type
string