Link to common functions

We might want to update these to marketplace links once they're
available.

Signed-off-by: Nic Cope <nicc@rk0n.org>
This commit is contained in:
Nic Cope 2023-10-28 14:11:14 -07:00
parent 023893b78d
commit 1d1e21a52d
1 changed files with 11 additions and 7 deletions

View File

@ -34,7 +34,7 @@ Install a Function with a Crossplane
location of the function package. location of the function package.
For example, to install Function Patch and Transform, For example, to install [Function Patch and Transform](https://github.com/crossplane-contrib/function-patch-and-transform),
```yaml {label="install"} ```yaml {label="install"}
apiVersion: pkg.crossplane.io/v1beta1 apiVersion: pkg.crossplane.io/v1beta1
@ -111,10 +111,11 @@ line="10">}}function-patch-and-transform{{</hover>}}.
Some Functions allow you to specify an {{<hover label="single" Some Functions allow you to specify an {{<hover label="single"
line="11">}}input{{</hover>}}. Different Functions each have a different line="11">}}input{{</hover>}}. Different Functions each have a different
{{<hover label="single" line="13">}}kind{{</hover>}} of input. This example uses {{<hover label="single" line="13">}}kind{{</hover>}} of input. This example uses
Function Patch and Transform. Function Patch and Transform is a function that [Function Patch and Transform](https://github.com/crossplane-contrib/function-patch-and-transform).
implements Crossplane resource templates. Its input kind is `Resources`, and it Function Patch and Transform is a function that implements Crossplane resource
accepts [Patch and Transform]({{<ref "./patch-and-transform">}}) {{<hover templates. Its input kind is `Resources`, and it accepts
label="single" line="14">}}resources{{</hover>}} as input. [Patch and Transform]({{<ref "./patch-and-transform">}}) {{<hover label="single"
line="14">}}resources{{</hover>}} as input.
```yaml {label="single",copy-lines="none"} ```yaml {label="single",copy-lines="none"}
apiVersion: apiextensions.crossplane.io/v1 apiVersion: apiextensions.crossplane.io/v1
@ -324,8 +325,11 @@ func (f *Function) RunFunction(_ context.Context, req *fnv1beta1.RunFunctionRequ
``` ```
Some people design composition functions for you to use them with any kind of Some people design composition functions for you to use them with any kind of
composite resource. Function Patch and Transform and Function Auto Ready work composite resource.
with any kind of composite resource. [Function Patch and Transform](https://github.com/crossplane-contrib/function-patch-and-transform)
and
[Function Auto Ready](https://github.com/crossplane-contrib/function-auto-ready)
work with any kind of composite resource.
Another common pattern is to write a composition function specific to one kind Another common pattern is to write a composition function specific to one kind
of composite resource. The function contains all the logic needed to tell of composite resource. The function contains all the logic needed to tell