Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify the specifics of connection details in compositions #485

Merged
merged 2 commits into from
Jul 18, 2023

Conversation

jbw976
Copy link
Member

@jbw976 jbw976 commented Jul 15, 2023

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:

  1. The claim and XR must both specify a writeConnectionSecretToRef.

I believe this is inaccurate because XR/XRDs do not have a writeConnectionSecretToRef field. Instead, a Composition has a writeConnectionSecretsToNamespace field and that was missing from our current docs.

@netlify
Copy link

netlify bot commented Jul 15, 2023

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit ec97ef2
🔍 Latest deploy log https://app.netlify.com/sites/crossplane/deploys/64b7061c36818e00088e68cf
😎 Deploy Preview https://deploy-preview-485--crossplane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@plumbis
Copy link
Collaborator

plumbis commented Jul 15, 2023

Can you take a look at the changes in PR #475 and give feedback on this there?

XRD Secrets

XR Secrets

Composition Secrets

Looks like I may have missed covering secrets for Claims.

@jbw976 jbw976 mentioned this pull request Jul 18, 2023
@jbw976
Copy link
Member Author

jbw976 commented Jul 18, 2023

Just took a pass now @plumbis: #475 (review)

@jbw976
Copy link
Member Author

jbw976 commented Jul 18, 2023

there is 1 line I found in my testing that appears to be incorrect in our current docs:

  1. The claim and XR must both specify a writeConnectionSecretToRef.

I believe this is inaccurate because XR/XRDs do not have a writeConnectionSecretToRef field

btw, I think I goofed this 😓 - I think I was reading the original documentation from the perspective of the XRD having to specify a writeConnectionSecretToRef field. What I now believe I overlooked is the scenario of someone directly creating a XR instead of indirectly having the XR created via a claim.

I'll try to update both this PR and the blog post to get this detail correct 😩

@jbw976
Copy link
Member Author

jbw976 commented Jul 18, 2023

@plumbis I updated the guidance in these docs to be actually accurate in ec97ef2, can you take another look?

I also published that update to https://blog.crossplane.io/faq-2-claim-connection-details/ already so the correction is out there for folks. We can tweak if needed from feedback in this PR 😅

@plumbis plumbis merged commit 450ea44 into crossplane:master Jul 18, 2023
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants