Repository navigation
Conversation
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
a254027 to
15a41de
Compare
jbw976
left a comment
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" |
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 |
There was a problem hiding this comment.
i think tihs label needs to be op-ociref to match the yaml below and work
There was a problem hiding this comment.
Yep, correct - copy and paste error from compositions.
| 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 |
There was a problem hiding this comment.
is this supposed to be status.externalRevisionRefs to match the other mentions in this section?
|
@jbw976 Thanks for the reminder on the caveats. The first one has gone away since we also implemented GC for composition revisions, and I think the last one is not worth calling out for now given that we don't document |
Add docs for the progressive function rollout feature added in v2.5. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
Add hints about a couple of gotchas when referencing functions by OCI ref, per Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
4fe445a to
3b211db
Compare

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