Updates to access, maintenance, and support policy for official packages:On January 31, 2025 Upbound is updating the access policy for Official Providers
Learn More
You are viewing an outdated version of function-patch-and-transform.Go to Latest
crossplane-contrib/function-patch-and-transform@v0.4.0
Resources
pt.fn.crossplane.io
Resources
crossplane-contrib/function-patch-and-transform@v0.4.0pt.fn.crossplane.io

Resources specifies Patch & Transform resource templates.

Type

CRD

Group

pt.fn.crossplane.io

Version

v1beta1

apiVersion: pt.fn.crossplane.io/v1beta1

kind: Resources

API Documentation
apiVersion
string
environment
object
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
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
object

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

strategy
requiredstring
string
object
object

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

fmt
requiredstring
variables
requiredarray
requiredarray

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

fromFieldPath
requiredstring
policy
object
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
object

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

format
string
toType
requiredstring
map
object
match
object
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
requiredstring
math
object
object

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

clampMax
integer
clampMin
integer
multiply
integer
type
string
string
object
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
regexp
object
object

Extract a match from the input using a regular expression.

group
integer
match
requiredstring
trim
string
type
string
type
requiredstring
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
requiredstring
patches
requiredarray
requiredarray

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

combine
object
object

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

strategy
requiredstring
string
object
object

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

fmt
requiredstring
variables
requiredarray
requiredarray

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

fromFieldPath
requiredstring
policy
object
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
object

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

format
string
toType
requiredstring
map
object
match
object
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
requiredstring
math
object
object

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

clampMax
integer
clampMin
integer
multiply
integer
type
string
string
object
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
regexp
object
object

Extract a match from the input using a regular expression.

group
integer
match
requiredstring
trim
string
type
string
type
requiredstring
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
requiredstring
type
requiredstring
value
string
name
requiredstring
patches
array
array

Patches to and from the composed resource.

combine
object
object

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

strategy
requiredstring
string
object
object

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

fmt
requiredstring
variables
requiredarray
requiredarray

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

fromFieldPath
requiredstring
policy
object
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
object

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

format
string
toType
requiredstring
map
object
match
object
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
requiredstring
math
object
object

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

clampMax
integer
clampMin
integer
multiply
integer
type
string
string
object
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
regexp
object
object

Extract a match from the input using a regular expression.

group
integer
match
requiredstring
trim
string
type
string
type
requiredstring
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
requiredstring
type
requiredstring
type
requiredstring
Discover the building blocks for your internal cloud platform.
© 2024 Upbound, Inc.
Solutions