docs: clarify writeConnectionSecretToRef removal is XR-only, not MR-level#1069
docs: clarify writeConnectionSecretToRef removal is XR-only, not MR-level#1069ytsarev wants to merge 1 commit intocrossplane:masterfrom
Conversation
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
ytsarev
force-pushed
the
xr-no-mr-connectionv2
branch
2 times, most recently
from
cf1f19f to
1f17e86
Compare
jbw976
left a comment
jbw976
left a comment
There was a problem hiding this comment.
Nice, thank you @ytsarev for taking the initiative to clarify this for Crossplane users @ytsarev! I have a couple wording suggestions here to keep the message very focused - let me know what you think 🙇
another place we should probably add a brief mention to as well is https://docs.crossplane.io/v2.2/whats-new/#backward-compatibility. e.g.:
Composite resources no longer have native connection details support. You can recreate this feature by composing your own connection details Secret as described in the connection details composition guide. Connection details for managed resources (MRs) aren't affected.
I'm hoping Vale is okay with "aren't affected" since I'm suggesting we use that in a few places 🙏
| for XRs. **Crossplane v2 removed native XR connection details**, but `writeConnectionSecretToRef` | ||
| on managed resources (MRs) still works as before. The function pipeline now controls | ||
| XR level aggregation; compose the `Secret` explicitly for full control. |
There was a problem hiding this comment.
I think we could make the wording a bit more focused on the core idea that MRs are not affected. what do you think of this wording?
| for XRs. **Crossplane v2 removed native XR connection details**, but `writeConnectionSecretToRef` | |
| on managed resources (MRs) still works as before. The function pipeline now controls | |
| XR level aggregation; compose the `Secret` explicitly for full control. | |
| for XRs. Crossplane v2 removes this feature **for XRs only**. Managed Resources (MRs) aren't affected by this change and still support connection details via their `writeConnectionSecretToRef` field. |
| **Removed**: composite resources no longer have native connection details support. | ||
|
|
||
| {{<hint "tip">}} | ||
| **This only affects XRs, not managed resources.** |
There was a problem hiding this comment.
| **This only affects XRs, not managed resources.** | |
| **This only affects XRs, managed resources aren't affected.** |
| `writeConnectionSecretToRef` on managed resources (MRs) still works as | ||
| before. Use it directly on `spec.writeConnectionSecretToRef` in any MR spec. |
There was a problem hiding this comment.
| `writeConnectionSecretToRef` on managed resources (MRs) still works as | |
| before. Use it directly on `spec.writeConnectionSecretToRef` in any MR spec. | |
| Managed resources (MRs) still support the `writeConnectionSecretToRef` field on any MR spec. |
| Only the _XR level_ built-in connection details aggregation changed. Crossplane | ||
| v2 gives your composition function full control instead: you decide what goes in | ||
| the secret, where it's created, and when. |
There was a problem hiding this comment.
i'm thinking we can drop this actually and just focus this tip box on MRs being unaffected. The message of creating a secret yourself is sort of covered by the first sentence after this box.
…evel A common source of confusion when upgrading to v2 is assuming that the removal of native XR connection details also affects managed resources. This is not the case — writeConnectionSecretToRef on MRs is unchanged. Add a tip callout to the upgrade guide's "Composite resource connection details" section and expand the note in the connection details composition guide to explicitly state that only the XR-level aggregation was removed, while MR-level usage continues to work as before. Applied across all v2.x versions and master. Signed-off-by: Yury Tsarev <yury@upbound.io>
ytsarev
force-pushed
the
xr-no-mr-connectionv2
branch
from
1f17e86 to
4cf27d8
Compare
|
@jbw976 thanks a lot for the review! I addressed all suggestions, looks like Vale is happy too. Please take another look! |
2 participants
A common source of confusion when upgrading to v2 is assuming that the removal of native XR connection details also affects managed resources. This is not the case — writeConnectionSecretToRef on MRs is unchanged.
Add a tip callout to the upgrade guide's "Composite resource connection details" section and expand the note in the connection details composition guide to explicitly state that only the XR-level aggregation was removed, while MR-level usage continues to work as before. Applied across all v2.x versions and master.