Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify content of desired resources in composition functions #506

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions content/master/concepts/composition-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,11 +348,18 @@ The `desired` state of the XR and composed resources is how your Function tells
Crossplane what it should do. Crossplane 'bootstraps' the initial desired state
passed to a Function pipeline with:

* A copy of the observed state of the XR.
* A copy of the observed state of any existing composed resources.
* A copy of the observed state of the composite resource (XR).
* A copy of the observed state of any existing composed resources produced
from the `resources` array.
* Any new composed resources or modifications to observed resources produced
from the `resources` array.

{{< hint "note" >}}
The initial desired state doesn't include any copies of observed resources
produced by the function pipeline. When using multiple functions each function
passes their desired resources output as input to the next pipeline function.
{{< /hint >}}

When adding a new desired resource to the `desired.resources` array you don't
need to:

Expand Down