Skip to content

Conversation

@jbw976
Copy link
Member

@jbw976 jbw976 commented Dec 12, 2025

While getting deeper into making sense of connection secrets in v2 for #1001, I wanted to walk through how connection details worked in v1 scenarios. The docs page for that content, https://docs.crossplane.io/v1.20/concepts/connection-details, has a couple issues preventing it from working correctly.

This PR updates that content to ensure that the connection details key names in the XRD match what is being used in the Composition. When they are not matching, the desired keys do not make it to the final XR and Claim connection secrets because they get filtered out by the XRD's .spec.connectionSecretKeys list.

Signed-off-by: Jared Watts <jbw976@gmail.com>
@netlify
Copy link

netlify bot commented Dec 12, 2025

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit bc81776
🔍 Latest deploy log https://app.netlify.com/projects/crossplane/deploys/693c9c63c72e6a000875a349
😎 Deploy Preview https://deploy-preview-1033--crossplane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 93 (🔴 down 1 from production)
Accessibility: 90 (🔴 down 2 from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

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

type: FromConnectionSecretKey
fromConnectionSecretKey: password
- name: key
- name: secret
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

standardizing on using secret for this key name, as used other places

name: xsecrettests.example.org
spec:
group: example.org
connectionSecretKeys:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a correct list of connection secret keys to include in the XR and Claim's secrets. They match exactly what is being used in the Composition, so all 8 of these keys will now make it to the final XR/Claim secrets. e.g.:

❯ kubectl describe Secret/my-access-key-secret
Name:         my-access-key-secret
Namespace:    default
Labels:       <none>
Annotations:  <none>

Type:  connection.crossplane.io/v1alpha1

Data
====
key2-password:  40 bytes
key2-secret:    40 bytes
key2-smtp:      44 bytes
key2-user:      20 bytes
password:       40 bytes
secret:         40 bytes
smtp:           44 bytes
user:           20 bytes

type: FromConnectionSecretKey
fromConnectionSecretKey: password
- name: key
- name: secret
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

another place to standardize on using secret for the name of this key so it's consistent

Copy link
Member

@negz negz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@negz
Copy link
Member

negz commented Dec 12, 2025

Oh - just noticed Vale is sad though. Looks like these are pre-existing?

@jbw976
Copy link
Member Author

jbw976 commented Dec 12, 2025

just noticed Vale is sad though. Looks like these are pre-existing?

yep yep, they are warnings (not errors) that are pre-existing 😅

@jbw976 jbw976 merged commit 4a954a1 into crossplane:master Dec 12, 2025
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