Update README and examples for v2 connection details behavior#530
Merged
jbw976 merged 1 commit intocrossplane-contrib:mainfrom Jan 7, 2026
Merged
Update README and examples for v2 connection details behavior#530jbw976 merged 1 commit intocrossplane-contrib:mainfrom
jbw976 merged 1 commit intocrossplane-contrib:mainfrom
Conversation
Signed-off-by: Jared Watts <jbw976@gmail.com>
jbw976
requested review from
bobh66,
negz,
sergenyalcin and
turkenf
as code owners
13 tasks
bobh66
approved these changes
Jan 6, 2026
Collaborator
bobh66
left a comment
bobh66
left a comment
There was a problem hiding this comment.
My only concern is that with this change none of the examples include the v1 CompositeConnectionDetails, which is probably fine since it's still documented and a pretty simple API.
Member
Author
|
Thanks for taking a look @bobh66! yep i think i agree with that assessment - it's simple and it's shown and explained in the README. I like the examples all being updated to using the modern approach of composing a secret to avoid chances of folks using the examples and them silently not working on v2, which is the mainline path these days. |
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
2 participants
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.
Description of your changes
This PR updates the README and yaml example manifests for how connection details work in crossplane v2.
The
CompositeConnectionDetailsspecial type is only useful for legacy v1 XRs.For modern v2 XRs, it is recommended to compose a
Secretobject as shown in https://docs.crossplane.io/latest/guides/connection-details-composition/.Part of crossplane/docs#1001
I have:
Added or updated unit tests for my change.