From 92ab3d696cb41d5d0ad54e5dfaa94193661be520 Mon Sep 17 00:00:00 2001 From: Moulick Aggarwal Date: Mon, 8 Jul 2024 14:10:23 +0200 Subject: [PATCH] Cleanup spaces in composition-functions.md Signed-off-by: Moulick Aggarwal --- .../v1.14/concepts/composition-functions.md | 46 +++++++++---------- .../v1.15/concepts/composition-functions.md | 44 +++++++++--------- .../v1.16/concepts/composition-functions.md | 44 +++++++++--------- 3 files changed, 67 insertions(+), 67 deletions(-) diff --git a/content/v1.14/concepts/composition-functions.md b/content/v1.14/concepts/composition-functions.md index 5610654f..a42d895b 100644 --- a/content/v1.14/concepts/composition-functions.md +++ b/content/v1.14/concepts/composition-functions.md @@ -5,7 +5,7 @@ alphaVersion: "1.11" betaVersion: "1.14" weight: 80 description: "Composition Functions allow you to template resources using general-purpose programming languages" -aliases: +aliases: - /knowledge-base/guides/composition-functions --- @@ -88,45 +88,45 @@ Crossplane has four core components that users commonly mix up: * [Composition]({{}}) - A template to define how to create resources. * [CompositeResourceDefinition]({{}}) - (`XRD`) - A custom API specification. + (`XRD`) - A custom API specification. * [Composite Resource]({{}}) (`XR`) - Created by using the custom API defined in a CompositeResourceDefinition. XRs use the - Composition template to create new managed resources. + Composition template to create new managed resources. * [Claim]({{}}) (`XRC`) - Like a Composite Resource, but with - namespace scoping. + namespace scoping. {{}} -To use composition functions set the Composition +To use composition functions set the Composition {{}}mode{{}} to {{}}Pipeline{{}}. -Define a {{}}pipeline{{}} of -{{}}steps{{}}. Each -{{}}step{{}} calls a Function. +Define a {{}}pipeline{{}} of +{{}}steps{{}}. Each +{{}}step{{}} calls a Function. -Each {{}}step{{}} uses a +Each {{}}step{{}} uses a {{}}functionRef{{}} to reference the -{{}}name{{}} of the Function to call. +{{}}name{{}} of the Function to call. {{}} -Compositions using {{}}mode: Pipeline{{}} -can't specify resource templates with a `resources` field. +Compositions using {{}}mode: Pipeline{{}} +can't specify resource templates with a `resources` field. Use function "Patch and Transform" to create resource templates. {{< /hint >}} -Some Functions also allow you to specify an -{{}}input{{}}. +Some Functions also allow you to specify an +{{}}input{{}}. The function defines the {{}}kind{{}} of input. This example uses -[Function Patch and Transform](https://github.com/crossplane-contrib/function-patch-and-transform). +[Function Patch and Transform](https://github.com/crossplane-contrib/function-patch-and-transform). Function Patch and Transform implements Crossplane resource -templates. -The input kind is {{}}Resources{{}}, -and it accepts [Patch and Transform]({{}}) +templates. +The input kind is {{}}Resources{{}}, +and it accepts [Patch and Transform]({{}}) {{}}resources{{}} as input. ```yaml {label="single",copy-lines="none"} @@ -163,7 +163,7 @@ calls them all. It calls them in the order they appear in the pipeline. Crossplane passes each Function in the pipeline the result of the previous Function. This enables powerful combinations of Functions. In this example, Crossplane calls {{}}function-cue{{}} to -create an S3 bucket. Crossplane then passes the bucket to +create an S3 bucket. Crossplane then passes the bucket to {{}}function-auto-ready{{}}, which marks the composite resource as ready when the bucket becomes ready. @@ -212,7 +212,7 @@ Running `crossplane beta render` requires [Docker](https://www.docker.com). {{< /hint >}} Provide a composite resource, composition and composition functions to render -the output locally. +the output locally. ```shell crossplane beta render xr.yaml composition.yaml functions.yaml @@ -454,8 +454,8 @@ $ crossplane xpkg push -f package/*.xpkg crossplane-contrib/function-example:v0. ``` {{}} -Crossplane has a -[guide to writing a composition function in Go]({{}}). +Crossplane has a +[guide to writing a composition function in Go]({{}}). {{}} When you're writing a composition function it's useful to know how composition @@ -514,7 +514,7 @@ which composed resources it should create or update. A _composed_ resource is a resource created by a composite resource. Composed resources are usually Crossplane managed resources (MRs), but they can be any kind of Crossplane resource. For example a composite resource could also create -a ProviderConfig, or another kind of composite resource. +a ProviderConfig, or another kind of composite resource. {{}} diff --git a/content/v1.15/concepts/composition-functions.md b/content/v1.15/concepts/composition-functions.md index 136b17fa..a86fceba 100644 --- a/content/v1.15/concepts/composition-functions.md +++ b/content/v1.15/concepts/composition-functions.md @@ -5,7 +5,7 @@ alphaVersion: "1.11" betaVersion: "1.14" weight: 80 description: "Composition Functions allow you to template resources using general-purpose programming languages" -aliases: +aliases: - /knowledge-base/guides/composition-functions --- @@ -88,45 +88,45 @@ Crossplane has four core components that users commonly mix up: * [Composition]({{}}) - A template to define how to create resources. * [CompositeResourceDefinition]({{}}) - (`XRD`) - A custom API specification. + (`XRD`) - A custom API specification. * [Composite Resource]({{}}) (`XR`) - Created by using the custom API defined in a CompositeResourceDefinition. XRs use the - Composition template to create new managed resources. + Composition template to create new managed resources. * [Claim]({{}}) (`XRC`) - Like a Composite Resource, but with - namespace scoping. + namespace scoping. {{}} -To use composition functions set the Composition +To use composition functions set the Composition {{}}mode{{}} to {{}}Pipeline{{}}. -Define a {{}}pipeline{{}} of -{{}}steps{{}}. Each -{{}}step{{}} calls a Function. +Define a {{}}pipeline{{}} of +{{}}steps{{}}. Each +{{}}step{{}} calls a Function. -Each {{}}step{{}} uses a +Each {{}}step{{}} uses a {{}}functionRef{{}} to reference the -{{}}name{{}} of the Function to call. +{{}}name{{}} of the Function to call. {{}} -Compositions using {{}}mode: Pipeline{{}} -can't specify resource templates with a `resources` field. +Compositions using {{}}mode: Pipeline{{}} +can't specify resource templates with a `resources` field. Use function "Patch and Transform" to create resource templates. {{< /hint >}} -Some Functions also allow you to specify an -{{}}input{{}}. +Some Functions also allow you to specify an +{{}}input{{}}. The function defines the {{}}kind{{}} of input. This example uses -[Function Patch and Transform](https://github.com/crossplane-contrib/function-patch-and-transform). +[Function Patch and Transform](https://github.com/crossplane-contrib/function-patch-and-transform). Function Patch and Transform implements Crossplane resource -templates. -The input kind is {{}}Resources{{}}, -and it accepts [Patch and Transform]({{}}) +templates. +The input kind is {{}}Resources{{}}, +and it accepts [Patch and Transform]({{}}) {{}}resources{{}} as input. ```yaml {label="single",copy-lines="none"} @@ -163,7 +163,7 @@ calls them all. It calls them in the order they appear in the pipeline. Crossplane passes each Function in the pipeline the result of the previous Function. This enables powerful combinations of Functions. In this example, Crossplane calls {{}}function-cue{{}} to -create an S3 bucket. Crossplane then passes the bucket to +create an S3 bucket. Crossplane then passes the bucket to {{}}function-auto-ready{{}}, which marks the composite resource as ready when the bucket becomes ready. @@ -212,7 +212,7 @@ Running `crossplane beta render` requires [Docker](https://www.docker.com). {{< /hint >}} Provide a composite resource, composition and composition functions to render -the output locally. +the output locally. ```shell crossplane beta render xr.yaml composition.yaml functions.yaml @@ -533,7 +533,7 @@ Crossplane errors if stability isn't reached after 5 iterations. A _composed_ resource is a resource created by a composite resource. Composed resources are usually Crossplane managed resources (MRs), but they can be any kind of Crossplane resource. For example a composite resource could also create -a ProviderConfig, or another kind of composite resource. +a ProviderConfig, or another kind of composite resource. {{}} @@ -742,4 +742,4 @@ looking for a log line: If you don't see the log line emitted when Crossplane starts, you have disabled __extra resources__ for composition functions, which means requests by functions for __extra -resources__ are just ignored. \ No newline at end of file +resources__ are just ignored. diff --git a/content/v1.16/concepts/composition-functions.md b/content/v1.16/concepts/composition-functions.md index 136b17fa..a86fceba 100644 --- a/content/v1.16/concepts/composition-functions.md +++ b/content/v1.16/concepts/composition-functions.md @@ -5,7 +5,7 @@ alphaVersion: "1.11" betaVersion: "1.14" weight: 80 description: "Composition Functions allow you to template resources using general-purpose programming languages" -aliases: +aliases: - /knowledge-base/guides/composition-functions --- @@ -88,45 +88,45 @@ Crossplane has four core components that users commonly mix up: * [Composition]({{}}) - A template to define how to create resources. * [CompositeResourceDefinition]({{}}) - (`XRD`) - A custom API specification. + (`XRD`) - A custom API specification. * [Composite Resource]({{}}) (`XR`) - Created by using the custom API defined in a CompositeResourceDefinition. XRs use the - Composition template to create new managed resources. + Composition template to create new managed resources. * [Claim]({{}}) (`XRC`) - Like a Composite Resource, but with - namespace scoping. + namespace scoping. {{}} -To use composition functions set the Composition +To use composition functions set the Composition {{}}mode{{}} to {{}}Pipeline{{}}. -Define a {{}}pipeline{{}} of -{{}}steps{{}}. Each -{{}}step{{}} calls a Function. +Define a {{}}pipeline{{}} of +{{}}steps{{}}. Each +{{}}step{{}} calls a Function. -Each {{}}step{{}} uses a +Each {{}}step{{}} uses a {{}}functionRef{{}} to reference the -{{}}name{{}} of the Function to call. +{{}}name{{}} of the Function to call. {{}} -Compositions using {{}}mode: Pipeline{{}} -can't specify resource templates with a `resources` field. +Compositions using {{}}mode: Pipeline{{}} +can't specify resource templates with a `resources` field. Use function "Patch and Transform" to create resource templates. {{< /hint >}} -Some Functions also allow you to specify an -{{}}input{{}}. +Some Functions also allow you to specify an +{{}}input{{}}. The function defines the {{}}kind{{}} of input. This example uses -[Function Patch and Transform](https://github.com/crossplane-contrib/function-patch-and-transform). +[Function Patch and Transform](https://github.com/crossplane-contrib/function-patch-and-transform). Function Patch and Transform implements Crossplane resource -templates. -The input kind is {{}}Resources{{}}, -and it accepts [Patch and Transform]({{}}) +templates. +The input kind is {{}}Resources{{}}, +and it accepts [Patch and Transform]({{}}) {{}}resources{{}} as input. ```yaml {label="single",copy-lines="none"} @@ -163,7 +163,7 @@ calls them all. It calls them in the order they appear in the pipeline. Crossplane passes each Function in the pipeline the result of the previous Function. This enables powerful combinations of Functions. In this example, Crossplane calls {{}}function-cue{{}} to -create an S3 bucket. Crossplane then passes the bucket to +create an S3 bucket. Crossplane then passes the bucket to {{}}function-auto-ready{{}}, which marks the composite resource as ready when the bucket becomes ready. @@ -212,7 +212,7 @@ Running `crossplane beta render` requires [Docker](https://www.docker.com). {{< /hint >}} Provide a composite resource, composition and composition functions to render -the output locally. +the output locally. ```shell crossplane beta render xr.yaml composition.yaml functions.yaml @@ -533,7 +533,7 @@ Crossplane errors if stability isn't reached after 5 iterations. A _composed_ resource is a resource created by a composite resource. Composed resources are usually Crossplane managed resources (MRs), but they can be any kind of Crossplane resource. For example a composite resource could also create -a ProviderConfig, or another kind of composite resource. +a ProviderConfig, or another kind of composite resource. {{}} @@ -742,4 +742,4 @@ looking for a log line: If you don't see the log line emitted when Crossplane starts, you have disabled __extra resources__ for composition functions, which means requests by functions for __extra -resources__ are just ignored. \ No newline at end of file +resources__ are just ignored.