Skip to content

Commit

Permalink
Fix errors in composition secret guidance
Browse files Browse the repository at this point in the history
Signed-off-by: Jared Watts <jbw976@gmail.com>
  • Loading branch information
jbw976 committed Jul 18, 2023
1 parent 91f03e3 commit ec97ef2
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 20 deletions.
13 changes: 8 additions & 5 deletions content/master/concepts/composition.md
Original file line number Diff line number Diff line change
Expand Up @@ -1273,17 +1273,20 @@ source of confusion because several things need to align for it to work:
1. The **claim** must specify the secret where the aggregated connection details
should be written
* This is the `spec.writeConnectionSecretToRef` field in a claim
1. The **composite resource** must define which connection details to aggregate
from its children and publish to the claim
* This is the `spec.connectionSecretKeys` field in a composite resource
* If creating a composite resource directly (without a claim) then this same
field must be set on your composite resource instead
1. The **composite resource definition** must state which connection details to
aggregate from its children to publish to the claim
* This is the `spec.connectionSecretKeys` field in a
`CompositeResourceDefinition`
1. The **composition** must define where to write its aggregated connection
details
* This is the `spec.writeConnectionSecretsToNamespace` field in the
composition
`Composition`
1. Each child **composed resource** must define the connection details it
publishes and where to write them
* These are the `connectionDetails` and
`base.spec.writeConnectionSecretToRef` fields of the composed resources
`base.spec.writeConnectionSecretToRef` fields of the composed resources

Finally, you can't currently edit a XRD's supported connection details. The
XRD's `spec.connectionSecretKeys` is effectively immutable. This may change in
Expand Down
13 changes: 8 additions & 5 deletions content/v1.10/reference/composition.md
Original file line number Diff line number Diff line change
Expand Up @@ -820,17 +820,20 @@ source of confusion because several things need to align for it to work:
1. The **claim** must specify the secret where the aggregated connection details
should be written
* This is the `spec.writeConnectionSecretToRef` field in a claim
1. The **composite resource** must define which connection details to aggregate
from its children and publish to the claim
* This is the `spec.connectionSecretKeys` field in a composite resource
* If creating a composite resource directly (without a claim) then this same
field must be set on your composite resource instead
1. The **composite resource definition** must state which connection details to
aggregate from its children to publish to the claim
* This is the `spec.connectionSecretKeys` field in a
`CompositeResourceDefinition`
1. The **composition** must define where to write its aggregated connection
details
* This is the `spec.writeConnectionSecretsToNamespace` field in the
composition
`Composition`
1. Each child **composed resource** must define the connection details it
publishes and where to write them
* These are the `connectionDetails` and
`base.spec.writeConnectionSecretToRef` fields of the composed resources
`base.spec.writeConnectionSecretToRef` fields of the composed resources

Finally, you can't currently edit a XRD's supported connection details. The
XRD's `spec.connectionSecretKeys` is effectively immutable. This may change in
Expand Down
13 changes: 8 additions & 5 deletions content/v1.11/concepts/composition.md
Original file line number Diff line number Diff line change
Expand Up @@ -1184,17 +1184,20 @@ source of confusion because several things need to align for it to work:
1. The **claim** must specify the secret where the aggregated connection details
should be written
* This is the `spec.writeConnectionSecretToRef` field in a claim
1. The **composite resource** must define which connection details to aggregate
from its children and publish to the claim
* This is the `spec.connectionSecretKeys` field in a composite resource
* If creating a composite resource directly (without a claim) then this same
field must be set on your composite resource instead
1. The **composite resource definition** must state which connection details to
aggregate from its children to publish to the claim
* This is the `spec.connectionSecretKeys` field in a
`CompositeResourceDefinition`
1. The **composition** must define where to write its aggregated connection
details
* This is the `spec.writeConnectionSecretsToNamespace` field in the
composition
`Composition`
1. Each child **composed resource** must define the connection details it
publishes and where to write them
* These are the `connectionDetails` and
`base.spec.writeConnectionSecretToRef` fields of the composed resources
`base.spec.writeConnectionSecretToRef` fields of the composed resources

Finally, you can't currently edit a XRD's supported connection details. The
XRD's `spec.connectionSecretKeys` is effectively immutable. This may change in
Expand Down
13 changes: 8 additions & 5 deletions content/v1.12/concepts/composition.md
Original file line number Diff line number Diff line change
Expand Up @@ -1273,17 +1273,20 @@ source of confusion because several things need to align for it to work:
1. The **claim** must specify the secret where the aggregated connection details
should be written
* This is the `spec.writeConnectionSecretToRef` field in a claim
1. The **composite resource** must define which connection details to aggregate
from its children and publish to the claim
* This is the `spec.connectionSecretKeys` field in a composite resource
* If creating a composite resource directly (without a claim) then this same
field must be set on your composite resource instead
1. The **composite resource definition** must state which connection details to
aggregate from its children to publish to the claim
* This is the `spec.connectionSecretKeys` field in a
`CompositeResourceDefinition`
1. The **composition** must define where to write its aggregated connection
details
* This is the `spec.writeConnectionSecretsToNamespace` field in the
composition
`Composition`
1. Each child **composed resource** must define the connection details it
publishes and where to write them
* These are the `connectionDetails` and
`base.spec.writeConnectionSecretToRef` fields of the composed resources
`base.spec.writeConnectionSecretToRef` fields of the composed resources

Finally, you can't currently edit a XRD's supported connection details. The
XRD's `spec.connectionSecretKeys` is effectively immutable. This may change in
Expand Down

0 comments on commit ec97ef2

Please sign in to comment.