Promote composition functions to v1 #799
Conversation
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
|
||
| ### Include the composite resource | ||
|
|
||
| Composition functions can only change the `status` field of a composite |
There was a problem hiding this comment.
I'll do another full pass through but I think this limitation needs to be called out more specifically at a higher level. It was common to use XR metadata.annotations and labels to store information, and there were examples in the docs showing this pattern, so breaking that pattern needs to be more clearly documented. This also has impacts on the migration from legacy P&T to functions, since the existing compositions that patch into metadata need to be rewritten to use status instead.
There was a problem hiding this comment.
I definitely agree, but I'd rather raise a tracking issue for that and follow up ASAP rather than tackle it in this PR.
To get this PR finished as quickly as possible I'd like to keep it focused on the promotion to GA. I'm only adding new content where it pertains to the fact that functions are now GA, and native P&T is deprecated.
| to a | ||
| [Composition pipeline function]({{< ref "../concepts/compositions#use-composition-functions" >}}). | ||
| or a legacy Composition using `mode: Resources` to a | ||
| [Composition pipeline function]({{< ref "../concepts/compositions" >}}). |
There was a problem hiding this comment.
This should probably make clear that legacy Compositions that patch information into the XR metadata will not work properly after conversion and will need to be updated to use status instead.
|
Tagging crossplane/crossplane#5434 here as a bread crumb - the resolution of that issue will determine what the documentation updates need to be. |
negz
force-pushed
the
its-happening-dot-gif
branch
3 times, most recently
from
b3d34f0
to
01794b1
Compare
I don't think any of the maintainers are passionate about keeping these. We already didn't do them for the v1.16 release. They have a bunch of brittle links from /v1.XX dirs to /master, which right now are blocking my PR. I don't want to go update all the links so I'm just deleting them. Signed-off-by: Nic Cope <[email protected]>
Signed-off-by: Nic Cope <[email protected]>
negz
force-pushed
the
its-happening-dot-gif
branch
from
ad6a1cd
to
a90a055
Compare
| 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 | ||
| composite resource as ready when the bucket becomes ready. |
There was a problem hiding this comment.
nit: function-auto-ready could be confusing for someone learning Crossplane / compositions, e.g. why do I need to mark it to ready again with a separate function, if it is already ready :) It would demonstrate the idea better if the second function adds a common label/annotation etc.
There was a problem hiding this comment.
This content is pre-existing so I'm going to leave it as is.
Signed-off-by: Nic Cope <[email protected]>
Signed-off-by: Nic Cope <[email protected]>
Signed-off-by: Nic Cope <[email protected]>
Signed-off-by: Nic Cope <[email protected]>
This is related to #791 and crossplane/crossplane#5885.
I don't intend to truly make our docs "functions first" with this PR. Instead the plan is to take the first baby steps. Those will be:
Compositionexamples to use function-patch-and-transformI'd also like to add a brief guide on migrating a function from v1beta1 to v1 (it's basically
s/v1beta1/v1on the imports), but I think I'll do that in a separate PR in the interest of getting this merged and unblocking the Crossplane release.Reviewer notes
This also removes the release notes from the docs. They're still available at https://github.com/crossplane/crossplane/releases. See the relevant commit message for details.
Vale is failing, but only for content I didn't touch in this PR. I'm guessing the problem is that I touched pages with pre-existing content that doesn't pass the linter.