Skip to content

Commit dd0f208

Browse files
committed
Update MRs concepts, and drop all other mentions of connection details
We're considering removing connection details from XRs in v2 so for now focus on their existence at the MR level. Signed-off-by: Nic Cope <[email protected]>
1 parent 09cd242 commit dd0f208

File tree

6 files changed

+41
-380
lines changed

6 files changed

+41
-380
lines changed

content/v2.0-preview/composition/composite-resource-definitions.md

Lines changed: 0 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -480,70 +480,6 @@ spec:
480480
Changing or expanding the XRD schema requires restarting the [Crossplane pod]({{<ref "../guides/pods#crossplane-pod">}}) to take effect.
481481
{{< /hint >}}
482482

483-
### Manage connection secrets
484-
485-
When a composite resource creates managed resources, Crossplane provides any
486-
[connection secrets]({{<ref "../managed-resources/managed-resources#writeconnectionsecrettoref">}})
487-
to the composite resource. This requires the creators of composite resources to
488-
know the secrets provided by a managed resource. In other cases, Crossplane
489-
administrators may not want to expose some or all the generated connection
490-
secrets.
491-
492-
XRDs can define a list of
493-
{{<hover label="key" line="10">}}connectionSecretKeys{{</hover>}}
494-
to limit what's provided to a composite resource.
495-
496-
Crossplane only provides the keys listed in the
497-
{{<hover label="key" line="10">}}connectionSecretKeys{{</hover>}}
498-
to the composite resource using this XRD. Any other connection secrets aren't
499-
passed to the composite resource.
500-
501-
{{<hint "important" >}}
502-
The keys listed in the
503-
{{<hover label="key" line="10">}}connectionSecretKeys{{</hover>}} must match the
504-
key names listed in the Composition's `connectionDetails`.
505-
506-
An XRD ignores any keys listed that aren't created by a managed resource.
507-
508-
For more information read the
509-
[Composition documentation]({{<ref "./compositions#store-connection-details">}}).
510-
{{< /hint >}}
511-
512-
513-
For example, an XRD passes the keys
514-
{{<hover label="key" line="11">}}username{{</hover>}},
515-
{{<hover label="key" line="12">}}password{{</hover>}} and
516-
{{<hover label="key" line="13">}}address{{</hover>}}.
517-
518-
Composite resources save these in the secret defined by their
519-
`writeConnectionSecretToRef` field.
520-
521-
```yaml {label="key",copy-lines="none"}
522-
apiVersion: apiextensions.crossplane.io/v1
523-
kind: CompositeResourceDefinition
524-
metadata:
525-
name: xdatabases.custom-api.example.org
526-
spec:
527-
group: custom-api.example.org
528-
names:
529-
kind: xDatabase
530-
plural: xdatabases
531-
connectionSecretKeys:
532-
- username
533-
- password
534-
- address
535-
versions:
536-
# Removed for brevity
537-
```
538-
539-
{{<hint "warning">}}
540-
You can't change the `connectionSecretKeys` of an XRD. You must delete and
541-
recreate the XRD to change the `connectionSecretKeys`.
542-
{{</hint >}}
543-
544-
For more information on connection secrets read the
545-
[Connection Secrets knowledge base article]({{<ref "../managed-resources/connection-details">}}).
546-
547483
### Set composite resource defaults
548484
XRDs can set default parameters for composite resources.
549485

content/v2.0-preview/composition/composite-resources.md

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -281,44 +281,6 @@ spec:
281281
# Removed for brevity
282282
```
283283

284-
### Manage connection secrets
285-
286-
When a composite resource creates resources, Crossplane provides any
287-
[connection secrets]({{<ref "../managed-resources/managed-resources#writeconnectionsecrettoref">}})
288-
to the composite resource.
289-
290-
{{<hint "important" >}}
291-
292-
A resource may only access connection secrets allowed by the XRD. By
293-
default XRDs provide access to all connection secrets generated by managed
294-
resources.
295-
Read more about [managing connection secrets]({{<ref "./composite-resource-definitions#manage-connection-secrets">}})
296-
in the XRD documentation.
297-
{{< /hint >}}
298-
299-
Use
300-
{{<hover label="writesecret" line="6">}}writeConnectionSecretToRef{{</hover>}}
301-
to specify where the composite resource writes their connection secrets to.
302-
303-
For example, this composite resource saves the connection secrets in a
304-
Kubernetes secret object named
305-
{{<hover label="writesecret" line="7">}}my-secret{{</hover>}} in the namespace
306-
{{<hover label="writesecret" line="8">}}crossplane-system{{</hover>}}.
307-
308-
```yaml {label="writesecret",copy-lines="none"}
309-
apiVersion: example.org/v1alpha1
310-
kind: xMyDatabase
311-
metadata:
312-
name: my-composite-resource
313-
spec:
314-
writeConnectionSecretToRef:
315-
name: my-secret
316-
namespace: crossplane-system
317-
# Removed for brevity
318-
```
319-
320-
For more information on connection secrets read the [Connection Secrets knowledge base article]({{<ref "../managed-resources/connection-details">}}).
321-
322284
### Pausing composite resources
323285

324286
<!-- vale Google.WordList = NO -->

content/v2.0-preview/guides/function-patch-and-transform.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1833,13 +1833,10 @@ the composite resources.
18331833
By default an XRD writes all secret keys listed in the composed resources
18341834
`connectionDetails` to the combined secret object.
18351835

1836-
Read the
1837-
[CompositeResourceDefinition documentation]({{<ref "../composition/composite-resource-definitions#manage-connection-secrets">}})
1838-
for more information on restricting secret keys.
1839-
{{< /hint >}}
18401836

1841-
For more information on connection secrets read the
1842-
[Connection Secrets concepts age]({{<ref "../managed-resources/connection-details">}}).
1837+
For more information on connection secrets read about
1838+
[managed resources]({{<ref "../managed-resources/managed-resources#writeConnectionSecretToRef">}}).
1839+
{{</hint>}}
18431840

18441841
## Resource readiness checks
18451842

content/v2.0-preview/managed-resources/connection-details.md

Lines changed: 0 additions & 77 deletions
This file was deleted.

0 commit comments

Comments
 (0)