Skip to content

Commit 4cf27d8

Browse files
committed
docs: clarify writeConnectionSecretToRef removal is XR-only, not MR-level
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>
1 parent b8b927a commit 4cf27d8

File tree

12 files changed

+44
-4
lines changed

12 files changed

+44
-4
lines changed

content/master/guides/connection-details-composition.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ resources and exposes them for the XR.
1717

1818
{{<hint "note">}}
1919
Crossplane v1 included a feature that automatically created connection details
20-
for XRs.
20+
for XRs. Crossplane v2 removes this feature **for XRs only**. Managed Resources (MRs)
21+
aren't affected by this change and still support connection details via their
22+
`writeConnectionSecretToRef` field.
2123

2224
To learn more about how to specify XR connection details in Crossplane v1, please see the
2325
[v1 connection details]({{<ref "../../v1.20/concepts/connection-details">}}) docs page.

content/master/guides/upgrade-to-crossplane-v2.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,13 @@ or [External Secrets Operator](https://external-secrets.io/latest/) before upgra
9696
### Composite resource connection details
9797
**Removed**: composite resources no longer have native connection details support.
9898

99+
{{<hint "tip">}}
100+
**This only affects XRs, managed resources aren't affected.**
101+
102+
Managed resources (MRs) still support the `writeConnectionSecretToRef` field on any
103+
MR spec.
104+
{{</hint>}}
105+
99106
You can recreate this feature by composing your own connection details `Secret`
100107
as described in the [connection details composition guide]({{<ref "./connection-details-composition">}}).
101108

content/master/whats-new/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,7 @@ remained in alpha for over two years and are now unmaintained.
283283
Composite resources no longer have native connection details support. You
284284
can recreate this feature by composing your own connection details `Secret`
285285
as described in the [connection details composition guide]({{<ref "../guides/connection-details-composition">}}).
286+
Connection details for managed resources (MRs) aren't affected.
286287

287288
Crossplane v2 drops the `--registry` flag that allowed users to specify a default
288289
registry value and now requires users to always specify a fully qualified URL when

content/v2.0/guides/connection-details-composition.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ resources and exposes them for the XR.
1717

1818
{{<hint "note">}}
1919
Crossplane v1 included a feature that automatically created connection details
20-
for XRs.
20+
for XRs. Crossplane v2 removes this feature **for XRs only**. Managed Resources (MRs)
21+
aren't affected by this change and still support connection details via their
22+
`writeConnectionSecretToRef` field.
2123

2224
To learn more about how to specify XR connection details in Crossplane v1, please see the
2325
[v1 connection details]({{<ref "../../v1.20/concepts/connection-details">}}) docs page.

content/v2.0/guides/upgrade-to-crossplane-v2.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,13 @@ or [External Secrets Operator](https://external-secrets.io/latest/) before upgra
9696
### Composite resource connection details
9797
**Removed**: composite resources no longer have native connection details support.
9898

99+
{{<hint "tip">}}
100+
**This only affects XRs, managed resources aren't affected.**
101+
102+
Managed resources (MRs) still support the `writeConnectionSecretToRef` field on any
103+
MR spec.
104+
{{</hint>}}
105+
99106
You can recreate this feature by composing your own connection details `Secret`
100107
as described in the [connection details composition guide]({{<ref "./connection-details-composition">}}).
101108

content/v2.0/whats-new/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,7 @@ remained in alpha for over two years and are now unmaintained.
283283
Composite resources no longer have native connection details support. You
284284
can recreate this feature by composing your own connection details `Secret`
285285
as described in the [connection details composition guide]({{<ref "../guides/connection-details-composition">}}).
286+
Connection details for managed resources (MRs) aren't affected.
286287

287288
Crossplane v2 drops the `--registry` flag that allowed users to specify a default
288289
registry value and now requires users to always specify a fully qualified URL when

content/v2.1/guides/connection-details-composition.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ resources and exposes them for the XR.
1717

1818
{{<hint "note">}}
1919
Crossplane v1 included a feature that automatically created connection details
20-
for XRs.
20+
for XRs. Crossplane v2 removes this feature **for XRs only**. Managed Resources (MRs)
21+
aren't affected by this change and still support connection details via their
22+
`writeConnectionSecretToRef` field.
2123

2224
To learn more about how to specify XR connection details in Crossplane v1, please see the
2325
[v1 connection details]({{<ref "../../v1.20/concepts/connection-details">}}) docs page.

content/v2.1/guides/upgrade-to-crossplane-v2.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,13 @@ or [External Secrets Operator](https://external-secrets.io/latest/) before upgra
9696
### Composite resource connection details
9797
**Removed**: composite resources no longer have native connection details support.
9898

99+
{{<hint "tip">}}
100+
**This only affects XRs, managed resources aren't affected.**
101+
102+
Managed resources (MRs) still support the `writeConnectionSecretToRef` field on any
103+
MR spec.
104+
{{</hint>}}
105+
99106
You can recreate this feature by composing your own connection details `Secret`
100107
as described in the [connection details composition guide]({{<ref "./connection-details-composition">}}).
101108

content/v2.1/whats-new/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,7 @@ remained in alpha for over two years and are now unmaintained.
283283
Composite resources no longer have native connection details support. You
284284
can recreate this feature by composing your own connection details `Secret`
285285
as described in the [connection details composition guide]({{<ref "../guides/connection-details-composition">}}).
286+
Connection details for managed resources (MRs) aren't affected.
286287

287288
Crossplane v2 drops the `--registry` flag that allowed users to specify a default
288289
registry value and now requires users to always specify a fully qualified URL when

content/v2.2/guides/connection-details-composition.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ resources and exposes them for the XR.
1717

1818
{{<hint "note">}}
1919
Crossplane v1 included a feature that automatically created connection details
20-
for XRs.
20+
for XRs. Crossplane v2 removes this feature **for XRs only**. Managed Resources (MRs)
21+
aren't affected by this change and still support connection details via their
22+
`writeConnectionSecretToRef` field.
2123

2224
To learn more about how to specify XR connection details in Crossplane v1, please see the
2325
[v1 connection details]({{<ref "../../v1.20/concepts/connection-details">}}) docs page.

0 commit comments

Comments
 (0)