@@ -4,9 +4,9 @@ weight: 10
4
4
description : " Composite resources, an XR or XRs, represent a collection of related cloud resources."
5
5
---
6
6
7
- A composite resource represents a set of Kubernetes resources as a single
8
- Kubernetes object. Crossplane creates composite resources when users access a
9
- custom API, defined in the CompositeResourceDefinition.
7
+ A composite resource, or XR, represents a set of Kubernetes resources as a
8
+ single Kubernetes object. Crossplane creates composite resources when users
9
+ access a custom API, defined in the CompositeResourceDefinition.
10
10
11
11
{{<hint "tip" >}}
12
12
Composite resources are a _ composite_ of Kubernetes resources.
@@ -24,7 +24,7 @@ Crossplane has four core components that users commonly mix up:
24
24
Composition template to create new resources.
25
25
{{</expand >}}
26
26
27
- ## Creating composite resources
27
+ ## Create composite resources
28
28
29
29
Creating composite resources requires a
30
30
[ Composition] ({{<ref "./compositions">}}) and a
@@ -34,7 +34,29 @@ Creating composite resources requires a
34
34
The Composition defines the set of resources to create. The XRD defines the
35
35
custom API users call to request the set of resources.
36
36
37
- ![ Diagram of the relationship of Crossplane components] ( /media/composition-how-it-works.svg )
37
+ ``` mermaid
38
+ flowchart TD
39
+
40
+ user(["User"])
41
+ xr("Composite Resource (XR)")
42
+ xrd("Composite Resource Definition (XRD)")
43
+ comp("Composition")
44
+ cda("Composed Resource A")
45
+ cdb("Composed Resource B")
46
+ cdc("Composed Resource C")
47
+
48
+ xrd -.defines.-> xr
49
+
50
+ user --creates--> xr
51
+ xr compose-a@--composes-->cda
52
+ xr compose-b@--composes-->cdb
53
+ xr compose-c@--composes-->cdc
54
+
55
+ configure-xr@{animate: true}
56
+ compose-a@{animate: true}
57
+ compose-b@{animate: true}
58
+ compose-c@{animate: true}
59
+ ```
38
60
39
61
XRDs define the API used to create a composite resource. For example,
40
62
this {{<hover label =" xrd1 " line =" 2 " >}}CompositeResourceDefinition{{</hover >}}
@@ -297,7 +319,7 @@ Spec:
297
319
298
320
### Composite resource conditions
299
321
300
- A composite resource has two status conditions Synced and Ready.
322
+ A composite resource has two status conditions: Synced and Ready.
301
323
302
324
Crossplane sets the Synced status condition to True when it's able to
303
325
successfully reconcile the composite resource. If Crossplane can't reconcile the
@@ -308,7 +330,7 @@ composition function pipeline reports that all of its composed resources are
308
330
ready. If a composed resource isn't ready Crossplane will report it in the
309
331
Ready condition.
310
332
311
- ## Composed resource labels
333
+ ## Composite resource labels
312
334
313
335
Crossplane adds labels to composed resources to show their relationship to
314
336
other Crossplane components.
0 commit comments