From ec97ef21b7e88089d46aac30a5d5eac372472faf Mon Sep 17 00:00:00 2001 From: Jared Watts Date: Tue, 18 Jul 2023 14:36:37 -0700 Subject: [PATCH] Fix errors in composition secret guidance Signed-off-by: Jared Watts --- content/master/concepts/composition.md | 13 ++++++++----- content/v1.10/reference/composition.md | 13 ++++++++----- content/v1.11/concepts/composition.md | 13 ++++++++----- content/v1.12/concepts/composition.md | 13 ++++++++----- 4 files changed, 32 insertions(+), 20 deletions(-) diff --git a/content/master/concepts/composition.md b/content/master/concepts/composition.md index 2ea5d644c..e3c648442 100644 --- a/content/master/concepts/composition.md +++ b/content/master/concepts/composition.md @@ -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 diff --git a/content/v1.10/reference/composition.md b/content/v1.10/reference/composition.md index 73d7bfb31..d78d6bdfc 100644 --- a/content/v1.10/reference/composition.md +++ b/content/v1.10/reference/composition.md @@ -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 diff --git a/content/v1.11/concepts/composition.md b/content/v1.11/concepts/composition.md index 7f7cfcb9e..ac2fdffa3 100644 --- a/content/v1.11/concepts/composition.md +++ b/content/v1.11/concepts/composition.md @@ -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 diff --git a/content/v1.12/concepts/composition.md b/content/v1.12/concepts/composition.md index cc6b39780..0a2f5326e 100644 --- a/content/v1.12/concepts/composition.md +++ b/content/v1.12/concepts/composition.md @@ -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