crossplane
/
docs
mirror of https://github.com/crossplane/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Copy edits from composition functions code review 

Signed-off-by: Nic Cope <nicc@rk0n.org>

Co-authored-by: Pete Lumbis <pete@upbound.io>
This commit is contained in:
Nic Cope 2023-10-30 13:30:02 -07:00
parent a32fbb7b05
commit f427bb1bce
2 changed files with 55 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
content/master/concepts/composition-functions.md
View File

@ -96,26 +96,38 @@ Crossplane has four core components that users commonly mix up:
namespace scoping.
{{</expand >}}
You must set the Composition {{<hover label="single" line="6">}}mode{{</hover>}}
to `Pipeline` to use a Function. To use a Function, add a {{<hover
label="single" line="7">}}pipeline{{</hover>}} of steps inside your Composition
{{<hover label="single" line="4">}}spec{{</hover>}}.
To use composition functions set the Composition
{{<hover label="single" line="6">}}mode{{</hover>}} to
{{<hover label="single" line="6">}}Pipeline{{</hover>}}.
The pipeline must have a step {{<hover label="single"
line="8">}}step{{</hover>}} that calls the Function. The {{<hover label="single"
line="8">}}step{{</hover>}} must specify the {{<hover label="single"
line="10">}}name{{</hover>}} of the Function to call. Here the step references
the name {{<hover label="single"
line="10">}}function-patch-and-transform{{</hover>}}.
Define a {{<hover label="single" line="7">}}pipeline{{</hover>}} of
{{<hover label="single" line="8">}}steps{{</hover>}}. Each
{{<hover label="single" line="8">}}step{{</hover>}} calls a Function.
Some Functions allow you to specify an {{<hover label="single"
line="11">}}input{{</hover>}}. Different Functions each have a different
{{<hover label="single" line="13">}}kind{{</hover>}} of input. This example uses
[Function Patch and Transform](https://github.com/crossplane-contrib/function-patch-and-transform).
Function Patch and Transform is a function that implements Crossplane resource
templates. Its input kind is `Resources`, and it accepts
[Patch and Transform]({{<ref "./patch-and-transform">}}) {{<hover label="single"
line="14">}}resources{{</hover>}} as input.
Each {{<hover label="single" line="8">}}step{{</hover>}} uses a
{{<hover label="single" line="9">}}functionRef{{</hover>}} to reference the
{{<hover label="single" line="10">}}name{{</hover>}} of the Function to call.
{{<hint "important" >}}
Compositions using {{<hover label="single" line="6">}}mode: Pipeline{{</hover>}}
can't specify resource templates with a `resources` field.
Use function "Patch and Transform" to create resource templates.
{{< /hint >}}
Some Functions also allow you to specify an
{{<hover label="single" line="11">}}input{{</hover>}}.
The function defines the
{{<hover label="single" line="13">}}kind{{</hover>}} of input.
This example uses
[Function Patch and Transform](https://github.com/crossplane-contrib/function-patch-and-transform).
Function Patch and Transform implements Crossplane resource
templates.
The input kind is {{<hover label="single" line="13">}}Resources{{</hover>}},
and it accepts [Patch and Transform]({{<ref "./patch-and-transform">}})
{{<hover label="single" line="14">}}resources{{</hover>}} as input.
```yaml {label="single",copy-lines="none"}
apiVersion: apiextensions.crossplane.io/v1
@ -141,11 +153,6 @@ spec:
region: "us-east-2"
```
{{<hint "important">}}
You can't specify resource templates using the Composition's `spec.resources`
field when you use composition functions. When a Composition's `spec.mode` is
`Pipeline` you can only specify `spec.pipeline`.
{{< /hint >}}
## Use a pipeline of functions in a composition
@ -153,18 +160,12 @@ Crossplane can ask more than one Function what to do when a composite resource
changes. When a Composition has a pipeline of two or more steps, Crossplane
calls them all. It calls them in the order they appear in the pipeline.
<!-- vale Microsoft.Auto = NO -->
<!--
This linter does not allow "auto-ready", which is part of the name of the
function.
-->
Crossplane passes each Function in the pipeline the result of the previous
Function. This enables powerful combinations of Functions. In this example,
Crossplane calls {{<hover label="double" line="10">}}function-cue{{</hover>}} to
create an S3 bucket. Crossplane then passes the bucket to {{<hover
label="double" line="23">}}function-auto-ready{{</hover>}}, which marks the
create an S3 bucket. Crossplane then passes the bucket to
{{<hover label="double" line="23">}}function-auto-ready{{</hover>}}, which marks the
composite resource as ready when the bucket becomes ready.
<!-- vale Microsoft.Auto = YES -->
```yaml {label="double",copy-lines="none"}
apiVersion: apiextensions.crossplane.io/v1
@ -315,7 +316,7 @@ run.
`crossplane beta render` supports two `render.crossplane.io/runtime` values:
* `Docker` (the default) connects to Docker Engine. It uses Docker to pull and
run function runtimes.
run a function runtime.
* `Development` connects to a function runtime you have run manually.
When you use the {{<hover label="development" line="6">}}Development{{</hover>}}

34
content/master/concepts/compositions.md
View File

@ -679,19 +679,29 @@ default. The
page explains how to disable composition functions.
{{< /hint >}}
To use composition functions define a {{<hover label="xfn"
line="7">}}pipeline{{</hover>}} of steps inside the Composition {{<hover
label="xfn" line="4">}}spec{{</hover>}}. Each {{<hover label="xfn"
line="8">}}step{{</hover>}} calls a Function. You can't specify resource
templates using the `resources` field when you specify a pipeline of functions.
You must set the Composition {{<hover label="xfn" line="6">}}mode{{</hover>}} to
`Pipeline` to use Functions.
To use composition functions set the Composition
{{<hover label="xfn" line="6">}}mode{{</hover>}} to
{{<hover label="xfn" line="6">}}Pipeline{{</hover>}}.
Each {{<hover label="xfn" line="8">}}step{{</hover>}} must specify the {{<hover
label="xfn" line="10">}}name{{</hover>}} of the Function to call. Some Functions
also allow you to specify an {{<hover label="xfn" line="11">}}input{{</hover>}}.
Different Functions each have a different {{<hover label="xfn"
line="13">}}kind{{</hover>}} of input.
Define a {{<hover label="xfn" line="7">}}pipeline{{</hover>}} of
{{<hover label="xfn" line="8">}}steps{{</hover>}}. Each
{{<hover label="xfn" line="8">}}step{{</hover>}} calls a Function.
Each {{<hover label="xfn" line="8">}}step{{</hover>}} uses a
{{<hover label="xfn" line="9">}}functionRef{{</hover>}} to reference the
{{<hover label="xfn" line="10">}}name{{</hover>}} of the Function to call.
Some Functions also allow you to specify an
{{<hover label="xfn" line="11">}}input{{</hover>}}.
The function defines the
{{<hover label="xfn" line="13">}}kind{{</hover>}} of input.
{{<hint "important" >}}
Compositions using {{<hover label="xfn" line="6">}}mode: Pipeline{{</hover>}}
can't specify resource templates with a `resources` field.
Use function "Patch and Transform" to create resource templates.
{{< /hint >}}
This example uses Function Patch and Transform. Function Patch and Transform is
a function that implements Crossplane resource templates. You can use Function