add warning to v2 upgrade guide to not migrate live compositions

Signed-off-by: Jared Watts <jbw976@gmail.com>
This commit is contained in:
Jared Watts 2025-09-03 14:16:45 -07:00
parent b63d34e6a0
commit 0248bb39c6
No known key found for this signature in database
GPG Key ID: 0467EEAE3B6EC0D2
2 changed files with 68 additions and 50 deletions

View File

@ -232,6 +232,15 @@ Existing Compositions work with Crossplane v2 with minimal changes. v2 managed
resources are schematically identical to v1 managed resources - they're just
namespaced.
{{<hint "important">}}
**Don't update existing compositions that are actively used by composite
resources in your control plane.**
Updating a live composition that's in use by existing XRs could disrupt or
replace your resources. Use the below migration approach only when creating new
compositions for new resources.
{{</hint>}}
To use v2 namespaced managed resources in compositions:
1. **Update the API group** from `.crossplane.io` to `.m.crossplane.io`

View File

@ -232,6 +232,15 @@ Existing Compositions work with Crossplane v2 with minimal changes. v2 managed
resources are schematically identical to v1 managed resources - they're just
namespaced.
{{<hint "important">}}
**Don't update existing compositions that are actively used by composite
resources in your control plane.**
Updating a live composition that's in use by existing XRs could disrupt or
replace your resources. Use the below migration approach only when creating new
compositions for new resources.
{{</hint>}}
To use v2 namespaced managed resources in compositions:
1. **Update the API group** from `.crossplane.io` to `.m.crossplane.io`