Skip to content

Commit cf1f19f

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 cf1f19f

File tree

8 files changed

+56
-4
lines changed

8 files changed

+56
-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 removed native XR connection details**—but `writeConnectionSecretToRef`
21+
on managed resources (MRs) still works as before. The function pipeline now controls
22+
XR level aggregation; compose the `Secret` explicitly for full control.
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: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,17 @@ 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, not managed resources.**
101+
102+
`writeConnectionSecretToRef` on managed resources (MRs) still works as
103+
before—use it directly on `spec.writeConnectionSecretToRef` in any MR spec.
104+
105+
Only the _XR level_ built-in connection details aggregation changed. Crossplane
106+
v2 gives your composition function full control instead: you decide what goes in
107+
the secret, where it's created, and when.
108+
{{</hint>}}
109+
99110
You can recreate this feature by composing your own connection details `Secret`
100111
as described in the [connection details composition guide]({{<ref "./connection-details-composition">}}).
101112

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 removed native XR connection details**—but `writeConnectionSecretToRef`
21+
on managed resources (MRs) still works as before. The function pipeline now controls
22+
XR level aggregation; compose the `Secret` explicitly for full control.
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: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,17 @@ 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, not managed resources.**
101+
102+
`writeConnectionSecretToRef` on managed resources (MRs) still works as
103+
before—use it directly on `spec.writeConnectionSecretToRef` in any MR spec.
104+
105+
Only the _XR level_ built-in connection details aggregation changed. Crossplane
106+
v2 gives your composition function full control instead: you decide what goes in
107+
the secret, where it's created, and when.
108+
{{</hint>}}
109+
99110
You can recreate this feature by composing your own connection details `Secret`
100111
as described in the [connection details composition guide]({{<ref "./connection-details-composition">}}).
101112

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 removed native XR connection details**—but `writeConnectionSecretToRef`
21+
on managed resources (MRs) still works as before. The function pipeline now controls
22+
XR level aggregation; compose the `Secret` explicitly for full control.
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: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,17 @@ 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, not managed resources.**
101+
102+
`writeConnectionSecretToRef` on managed resources (MRs) still works as
103+
before—use it directly on `spec.writeConnectionSecretToRef` in any MR spec.
104+
105+
Only the _XR level_ built-in connection details aggregation changed. Crossplane
106+
v2 gives your composition function full control instead: you decide what goes in
107+
the secret, where it's created, and when.
108+
{{</hint>}}
109+
99110
You can recreate this feature by composing your own connection details `Secret`
100111
as described in the [connection details composition guide]({{<ref "./connection-details-composition">}}).
101112

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 removed native XR connection details**—but `writeConnectionSecretToRef`
21+
on managed resources (MRs) still works as before. The function pipeline now controls
22+
XR level aggregation; compose the `Secret` explicitly for full control.
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.2/guides/upgrade-to-crossplane-v2.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,17 @@ 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, not managed resources.**
101+
102+
`writeConnectionSecretToRef` on managed resources (MRs) still works as
103+
before—use it directly on `spec.writeConnectionSecretToRef` in any MR spec.
104+
105+
Only the _XR level_ built-in connection details aggregation changed. Crossplane
106+
v2 gives your composition function full control instead: you decide what goes in
107+
the secret, where it's created, and when.
108+
{{</hint>}}
109+
99110
You can recreate this feature by composing your own connection details `Secret`
100111
as described in the [connection details composition guide]({{<ref "./connection-details-composition">}}).
101112

0 commit comments

Comments
 (0)