Add Crossplane v2 migration documentation #1045
Conversation
Integrates comprehensive Crossplane v2 migration guides. Two new migration guides in `docs/getstarted/upgrade-to-upbound/`: 1. **migrate-configurations-v2.md** - Technical guide for migrating XRDs, compositions, and KCL functions from v1 to v2 - Covers all breaking changes (namespaced resources, deletionPolicy → managementPolicies, connection secrets redesign) - Includes migration checklist, common errors, and solutions 2. **migrate-live-clusters-v2.md** - Operational guide for migrating live clusters without recreating resources - Step-by-step zero-downtime migration using function-external-name-backup-restore - E2E-validated procedures Signed-off-by: Yury Tsarev <yury@upbound.io>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
docs/getstarted/upgrade-to-upbound/migrate-configurations-v2.md
Outdated
Show resolved
Hide resolved
docs/getstarted/upgrade-to-upbound/migrate-configurations-v2.md
Outdated
Show resolved
Hide resolved
docs/getstarted/upgrade-to-upbound/migrate-configurations-v2.md
Outdated
Show resolved
Hide resolved
docs/getstarted/upgrade-to-upbound/migrate-configurations-v2.md
Outdated
Show resolved
Hide resolved
docs/getstarted/upgrade-to-upbound/migrate-configurations-v2.md
Outdated
Show resolved
Hide resolved
| - Though not strongly required, this guide assumes you are using Crossplane | ||
| configuration packages to manage your XRDs and compositions | ||
| - v1 and v2 version of configuration package | ||
| - Both versions need to have `function-external-name-backup-restore` deployed |
There was a problem hiding this comment.
can we link a marketplace url ?
| ```yaml | ||
| - apiVersion: pkg.crossplane.io/v1 | ||
| kind: Function | ||
| package: xpkg.upbound.io/solutions/function-external-name-backup-restore |
| ``` | ||
|
|
||
| :::warning | ||
| A current limitation exists where function-credentials can't be optional. |
There was a problem hiding this comment.
nit: with an Input which store you want to use, its possible to have a CEL Rule and relax required ?
jbw976
left a comment
jbw976
left a comment
There was a problem hiding this comment.
I took a closer look at the connection details section today since I just finished the upstream guide today and it was top of mind for me. Added a few comments to consider, thank you!
|
|
||
| #### Migration path: Manually compose secrets | ||
|
|
||
| The official guidance from the Crossplane maintainers: |
There was a problem hiding this comment.
we have more official guidance than this now in https://docs.crossplane.io/latest/guides/connection-details-composition, feel free to reference that instead of a offhand quote from an issue 🤓
There was a problem hiding this comment.
Awesome, great to see the guide emerged upstream!
| applications can reference. | ||
| ::: | ||
|
|
||
| #### Architecture comparison |
There was a problem hiding this comment.
this section doesn't feel like it adds a lot of value that hasn't already been said, and it feels a bit too LLM-y IMHO :)
| - endpoint | ||
| - port | ||
|
|
||
| # In openAPIV3Schema |
There was a problem hiding this comment.
I don't think spec.writeConnectionSecretToRef would have ever been in the XRD schema, users would never have added it there. Crossplane would have automatically added it to the CRD that it generates from the XRD, but I don't think they'd actually ever be in the XRD schema. Are you sure about this one?
Signed-off-by: Yury Tsarev <yury@upbound.io>
Signed-off-by: Yury Tsarev <yury@upbound.io>
3 participants
Integrates comprehensive Crossplane v2 migration guides.
Two new migration guides in
docs/getstarted/upgrade-to-upbound/:migrate-configurations-v2.md - Technical guide for migrating XRDs, compositions, and KCL functions from v1 to v2
migrate-live-clusters-v2.md - Operational guide for migrating live clusters without recreating resources
Description
Type of change
Checklist
make lintlocally (or will fix Vale suggestions in review)Additional notes