Clarify the specifics of connection details in compositions #485
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.
This PR attempts to clarify the nuances/specifics that are necessary to correctly specify the connection details that will be aggregated from composed resources and published for a claim.
This wording was put together in our latest FAQ blog post, so I wanted to bring the docs closer in line to what we felt worked in that post: https://blog.crossplane.io/faq-2-claim-connection-details/
Most of the changes are just rewordings and clarifications, e.g. to point to specific field paths, but there is 1 line I found in my testing that appears to be incorrect in our current docs:
writeConnectionSecretToRef
.I believe this is inaccurate because XR/XRDs do not have a
writeConnectionSecretToRef
field. Instead, a Composition has awriteConnectionSecretsToNamespace
field and that was missing from our current docs.