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

Conversation

tenstad
Copy link
Contributor

@tenstad tenstad commented Jul 28, 2023

Resolves #502

Clarifies content of desired.resources and when resources produced by function pipeline may be present. It is now less likely that someone thinks resources produced by a function pipeline is also copied from observed to desired during bootstrapping of initial desired state.

  • I think it is good actually use the word composite, as it refers to the composite field within desired
  • Clarifies that existing composed resources are produced from the resources array (same origin as new and modified)
  • Explicitly states that initial desired state does not contain resources produced by the function pipeline
  • And that the desired resources output of a function is passed as input to the next pipeline function

@netlify
Copy link

netlify bot commented Jul 28, 2023

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit b75c222
🔍 Latest deploy log https://app.netlify.com/sites/crossplane/deploys/64c371cf7532870008164aae
😎 Deploy Preview https://deploy-preview-506--crossplane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Signed-off-by: Amund Tenstad <github@amund.io>
@tenstad tenstad force-pushed the composition-functions-desired-resources branch from 47d0677 to b75c222 Compare July 28, 2023 07:44
Copy link
Collaborator

@plumbis plumbis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution!!

@plumbis plumbis merged commit 872d68e into crossplane:master Jul 28, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

More elaborate description of composition function's desired resources
2 participants