crossplane-contrib / crossplane-contrib/function-patch-and-transform

Patch existing resources by matching labels, not resource template name

Open
#20 7 comments 1 reaction 0 assignees View on GitHub
Dominant language
Go
Stars
46
Forks
41
Avg merge
1d 10h
Merged PRs (30d)
3

Description

One neat thing about `function-patch-and-transform` is that you can patch composed resources that are produced by another Function, earlier in the pipeline. For example here we P&T some resources produced by `function-go-templates`:

```yaml
apiVersion: apiextensions.crossplane.io/v1
kind: Composition
metadata:
name: dynamo-with-bucket
spec:
compositeTypeRef:
apiVersion: database.example.com/v1alpha1
kind: NoSQL
# This pipeliene renders some Go templates, then passes them to P&T
pipeline:
- step: render-go-templates
functionRef:
name: function-go-templates
input: {} # Omitted for brevity :)
- step: patch-and-transform
functionRef:
name: function-patch-and-transform
input:
apiVersion: pt.fn.crossplane.io/v1beta1
kind: Resources
resources:
# Notice that my-cool-bucket doesn't have a base template. As long as
# the render-go-templates step above rendered a composed resource with
# this name, this Function will patch it.
- name: my-cool-bucket
patches:
- type: FromCompositeFieldPath
fromFieldPath: "location"
toFieldPath: "spec.forProvider.region"
transforms:
- type: map
map:
EU: "eu-north-1"
US: "us-east-2"
```

One shortcoming with this is that you have to know the names (as in composition template names, not object metadata names) of the composed resources some other function produced in order to patch them.

@vfarcic noted that it would be useful to be able to patch resources without knowing their name in advance. Consider for example a Function that produced an arbitrary number of resources, where the number of resources was derived from an XR field. It wouldn't be possible to know what (or more specifically how many) names that Function would produce.

I think this would be pretty easy to implement if we can find a good API to describe it.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.