Repository navigation
Conversation
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Add docs for the progressive function rollout feature added in v2.5. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
adamwg
force-pushed
the
awg/function-rollout
branch
from
October 28, 2026 18:52
a254027 to
15a41de
Compare
jbw976
reviewed
Oct 29, 2026
jbw976
left a comment
jbw976
left a comment
Member
There was a problem hiding this comment.
Thanks for adding these docs as a quick follow up to the now merged feature @adamwg!
The docs tracking issue #1157 mentions a few caveats that we should document, but I'm not sure they all made it into this PR. Is there more to do to make sure those are documented, did they end up not being important enough to include, etc.?
| for `v0.13.2`. Both versions of the function are now running: | ||
|
|
||
| ```shell {copy-lines="1"} | ||
| kubectl get functionrevisions -o="custom-columns=NAME:.metadata.name,PACKAGE:.spec.package,STATE:.spec.desiredState" |
Member
There was a problem hiding this comment.
i think this should actually be .spec.image - apparently that's the right field on FunctionRevisions. I set up this scenario to verify:
.spec.package finds nothing:
❯ kubectl get functionrevisions -o="custom-columns=NAME:.metadata.name,PACKAGE:.spec.package,STATE:.spec.desiredState"
NAME PACKAGE STATE
crossplane-contrib-function-go-templating-91622b9260e8 <none> Active
crossplane-contrib-function-go-templating-d66b8d13aa14 <none> Active
# .spec.image does work
❯ kubectl get functionrevisions -o="custom-columns=NAME:.metadata.name,IMAGE:.spec.image,STATE:.spec.desiredState"
NAME IMAGE STATE
crossplane-contrib-function-go-templating-91622b9260e8 xpkg.crossplane.io/crossplane-contrib/function-go-templating@sha256:20198cb6ea5b4b8a48042343410ec9031e5ec43431d874364ecd3eac8e861290 Active
crossplane-contrib-function-go-templating-d66b8d13aa14 xpkg.crossplane.io/crossplane-contrib/function-go-templating@sha256:2edec9149ed78cfc109fdda53fef847055e4789f1d5984ffc2f9ce2b54241abc Active
| {{</hint>}} | ||
|
|
||
| Instead of a `functionRef`, a step can use the | ||
| {{<hover label="ociref" line="9">}}function{{</hover>}} field to name a function |
Member
There was a problem hiding this comment.
i think tihs label needs to be op-ociref to match the yaml below and work
| different. Controllers outside the package manager manage these "external" | ||
| revisions. The package manager pulls the package, runs a function pod for each | ||
| one, and records their names in the parent `Function`'s | ||
| `status.externalFunctionRefs` field. Multiple external revisions of the same |
Member
There was a problem hiding this comment.
is this supposed to be status.externalRevisionRefs to match the other mentions in this section?
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add docs for the progressive function rollout feature added in v2.5.
Design, for reference: https://github.com/crossplane/crossplane/blob/main/design/one-pager-controlled-rollout-of-composition-functions-v2.md