Skip to content

Commit 8dd741a

Browse files
committed
Replace ancient diagram with mermaidjs
RIP last mention of claims (hopefully). Signed-off-by: Nic Cope <[email protected]>
1 parent 1ad4360 commit 8dd741a

File tree

2 files changed

+30
-8
lines changed

2 files changed

+30
-8
lines changed

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

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ 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 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.
1010

1111
{{<hint "tip" >}}
1212
Composite resources are a _composite_ of Kubernetes resources.
@@ -24,7 +24,7 @@ Crossplane has four core components that users commonly mix up:
2424
Composition template to create new resources.
2525
{{</expand >}}
2626

27-
## Creating composite resources
27+
## Create composite resources
2828

2929
Creating composite resources requires a
3030
[Composition]({{<ref "./compositions">}}) and a
@@ -34,7 +34,29 @@ Creating composite resources requires a
3434
The Composition defines the set of resources to create. The XRD defines the
3535
custom API users call to request the set of resources.
3636

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+
```
3860

3961
XRDs define the API used to create a composite resource. For example,
4062
this {{<hover label="xrd1" line="2">}}CompositeResourceDefinition{{</hover>}}
@@ -297,7 +319,7 @@ Spec:
297319

298320
### Composite resource conditions
299321

300-
A composite resource has two status conditions Synced and Ready.
322+
A composite resource has two status conditions: Synced and Ready.
301323

302324
Crossplane sets the Synced status condition to True when it's able to
303325
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
308330
ready. If a composed resource isn't ready Crossplane will report it in the
309331
Ready condition.
310332

311-
## Composed resource labels
333+
## Composite resource labels
312334

313335
Crossplane adds labels to composed resources to show their relationship to
314336
other Crossplane components.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ aliases:
55
- composition
66
- composition-functions
77
- /knowledge-base/guides/composition-functions
8-
description: "Compositions are a template for creating Crossplane resources"
8+
description: "Compositions are a template for creating composite resources"
99
---
1010

1111
Compositions are a template for creating multiple Kubernetes resources as a

0 commit comments

Comments
 (0)