Skip to content

Commit 1f37523

Browse files
committed
Don't say composition is for managed resources
It's for all resources now! Signed-off-by: Nic Cope <[email protected]>
1 parent b54dc8b commit 1f37523

File tree

4 files changed

+24
-34
lines changed

4 files changed

+24
-34
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Crossplane has four core components that users commonly mix up:
2222
* Composite Resource Definition (`XRD`) - This page. A custom API specification.
2323
* [Composite Resource]({{<ref "./composite-resources">}}) (`XR`) - Created by
2424
using the custom API defined in a Composite Resource Definition. XRs use the
25-
Composition template to create new managed resources.
25+
Composition template to create other resources.
2626
{{</expand >}}
2727

2828
Crossplane XRDs are like

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ weight: 10
44
description: "Composite resources, an XR or XRs, represent a collection of related cloud resources."
55
---
66

7-
A composite resource represents a set of managed resources as a single
7+
A composite resource represents a set of Kubernetes resources as a single
88
Kubernetes object. Crossplane creates composite resources when users access a
99
custom API, defined in the CompositeResourceDefinition.
1010

1111
{{<hint "tip" >}}
12-
Composite resources are a _composite_ of managed resources.
13-
A _Composition_ defines how to _compose_ the managed resources together.
12+
Composite resources are a _composite_ of Kubernetes resources.
13+
A _Composition_ defines how to _compose_ the resources together.
1414
{{< /hint >}}
1515

1616
{{<expand "Confused about Compositions, XRDs and XRs?" >}}
@@ -21,7 +21,7 @@ Crossplane has four core components that users commonly mix up:
2121
(`XRD`) - A custom API specification.
2222
* Composite Resource (`XR`) - This page. Created by
2323
using the custom API defined in a Composite Resource Definition. XRs use the
24-
Composition template to create new managed resources.
24+
Composition template to create new resources.
2525
{{</expand >}}
2626

2727
## Creating composite resources
@@ -269,7 +269,7 @@ Use
269269
{{<hover label="desccomposite" line="1">}}kubectl describe composite{{</hover>}}
270270
to view the linked
271271
{{<hover label="desccomposite" line="16">}}Composition Ref{{</hover>}},
272-
and unique managed resources created in the
272+
and unique resources created in the
273273
{{<hover label="desccomposite" line="22">}}Resource Refs{{</hover>}}.
274274

275275

@@ -297,25 +297,21 @@ Spec:
297297

298298
### Composite resource conditions
299299

300-
The conditions of composite resources match the conditions of their managed
300+
The conditions of composite resources match the conditions of their composed
301301
resources.
302302

303-
Read the
304-
[conditions section]({{<ref "../managed-resources/managed-resources#conditions">}}) of the
305-
managed resources documentation for details.
306-
307303
## Composite resource labels
308304

309305
Crossplane adds labels to composite resources to show their relationship to
310306
other Crossplane components.
311307

312308
### Composite label
309+
313310
Crossplane adds the
314311
{{<hover label="complabel" line="4">}} crossplane.io/composite{{</hover>}} label
315-
to all composite resources. The label matches the name of the composite.
316-
Crossplane applies the composite label to any managed resource created by a
317-
composite, creating a reference between the managed resource and owning
318-
composite resource.
312+
to all composed resources. The label matches the name of the composite.
313+
Crossplane applies the composite label to anyresource created by a composite,
314+
creating a reference between the resource and owning composite resource.
319315

320316
```shell {label="complabel",copy-lines="1"}
321317
kubectl describe mydatabase.example.org/my-database-x9rx9

content/v2.0-preview/composition/composition-revisions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ familiarity with Crossplane, and particularly with
1010

1111
A `Composition` configures how Crossplane should reconcile a Composite Resource
1212
(XR). Put otherwise, when you create an XR the selected `Composition` determines
13-
what managed resources Crossplane will create in response. Let's say for example
14-
that you define a `PlatformDB` XR, which represents your organisation's common
13+
what resources Crossplane will create in response. Let's say for example that
14+
you define a `PlatformDB` XR, which represents your organisation's common
1515
database configuration of an Azure MySQL Server and a few firewall rules. The
1616
`Composition` contains the 'base' configuration for the MySQL server and the
1717
firewall rules that are extended by the configuration for the `PlatformDB`.

content/v2.0-preview/composition/compositions.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ aliases:
88
description: "Compositions are a template for creating Crossplane resources"
99
---
1010

11-
Compositions are a template for creating multiple managed resources as a single
12-
object.
11+
Compositions are a template for creating multiple Kubernetes resources as a
12+
single _composite_ resource.
1313

14-
A Composition _composes_ individual managed resources together into a larger,
15-
reusable, solution.
14+
A Composition _composes_ individual resources together into a larger, reusable,
15+
solution.
1616

1717
An example Composition may combine a virtual machine, storage resources and
1818
networking policies. A Composition template links all these individual
@@ -60,7 +60,7 @@ Crossplane has four core components that users commonly mix up:
6060
(`XRD`) - A custom API specification.
6161
* [Composite Resource]({{<ref "./composite-resources">}}) (`XR`) - Created by
6262
using the custom API defined in a Composite Resource Definition. XRs use the
63-
Composition template to create new managed resources.
63+
Composition template to create new resources.
6464
{{</expand >}}
6565

6666
## Create a Composition
@@ -145,8 +145,8 @@ you create a composite resource. The Function also tells Crossplane what to do
145145
with these resources when you update or delete a composite resource.
146146

147147
When Crossplane calls a Function it sends it the current state of the composite
148-
resource. It also sends it the current state of any managed resources the
149-
composite resource owns.
148+
resource. It also sends it the current state of any resources the composite
149+
resource owns.
150150

151151
Crossplane knows what Function to call when a composite resource changes by
152152
looking at the Composition the composite resource uses.
@@ -239,11 +239,10 @@ spec:
239239
```
240240

241241

242-
### Enable composite resources
242+
### Match composite resources
243243

244-
A Composition is only a template defining how to create managed
245-
resources. A Composition limits which Composite Resources can use this
246-
template.
244+
A Composition is only a template defining how to create composed resources. A
245+
Composition limits which kind of composite resource (XR) can use this template.
247246

248247
A Composition's {{<hover label="typeref" line="6">}}compositeTypeRef{{</hover>}}
249248
defines which Composite Resource type can use this Composition.
@@ -559,13 +558,8 @@ stable, so the Function returns the same exact request two times in a row.
559558
Crossplane errors if stability isn't reached after 5 iterations.
560559

561560
{{<hint "tip">}}
562-
<!-- vale write-good.Weasel = NO -->
563-
<!-- Disable Weasel to say "usually", which is correct in this context. -->
564561
A _composed_ resource is a resource created by a composite resource. Composed
565-
resources are usually Crossplane managed resources (MRs), but they can be any
566-
kind of Crossplane resource. For example a composite resource could also create
567-
a ProviderConfig, or another kind of composite resource.
568-
<!-- vale write-good.Weasel = YES -->
562+
resources can be any kind of Kubernetes resource.
569563
{{</hint>}}
570564

571565
### Observed state

0 commit comments

Comments
 (0)