Skip to content

Commit 724521d

Browse files
committed
docs: remove X from kind
1 parent 3b8bad4 commit 724521d

File tree

1 file changed

+20
-22
lines changed

1 file changed

+20
-22
lines changed

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

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ spec:
6262
scope: Namespaced
6363
group: example.org
6464
names:
65-
kind: XMyDatabase
65+
kind: MyDatabase
6666
plural: mydatabases
6767
versions:
6868
- name: v1alpha1
@@ -119,8 +119,6 @@ The required name fields are:
119119

120120
* `kind` - the `kind` value to use when calling this API. The kind is
121121
[UpperCamelCased](https://kubernetes.io/docs/contribute/style/style-guide/#use-upper-camel-case-for-api-objects).
122-
Crossplane recommends starting XRD `kinds` with an `X` to show
123-
it's a custom Crossplane API definition.
124122
* `plural` - the plural name used for the API URL. The plural name must be
125123
lowercase.
126124

@@ -145,7 +143,7 @@ metadata:
145143
spec:
146144
group: example.org
147145
names:
148-
kind: XMyDatabase
146+
kind: MyDatabase
149147
plural: mydatabases
150148
# Removed for brevity
151149
```
@@ -211,12 +209,12 @@ is a {{<hover label="schema" line="20">}}string{{</hover>}}.
211209
apiVersion: apiextensions.crossplane.io/v1
212210
kind: CompositeResourceDefinition
213211
metadata:
214-
name: xdatabases.custom-api.example.org
212+
name: databases.custom-api.example.org
215213
spec:
216214
group: custom-api.example.org
217215
names:
218-
kind: xDatabase
219-
plural: xdatabases
216+
kind: Database
217+
plural: databases
220218
versions:
221219
- name: v1alpha1
222220
schema:
@@ -239,7 +237,7 @@ A composite resource using this API references the
239237

240238
```yaml {label="xr"}
241239
apiVersion: custom-api.example.org/v1alpha1
242-
kind: xDatabase
240+
kind: Database
243241
metadata:
244242
name: my-composite-resource
245243
spec:
@@ -279,12 +277,12 @@ In this example the XRD requires
279277
apiVersion: apiextensions.crossplane.io/v1
280278
kind: CompositeResourceDefinition
281279
metadata:
282-
name: xdatabases.custom-api.example.org
280+
name: databases.custom-api.example.org
283281
spec:
284282
group: custom-api.example.org
285283
names:
286-
kind: xDatabase
287-
plural: xdatabases
284+
kind: Database
285+
plural: databases
288286
versions:
289287
- name: v1alpha1
290288
schema:
@@ -377,12 +375,12 @@ and
377375
apiVersion: apiextensions.crossplane.io/v1
378376
kind: CompositeResourceDefinition
379377
metadata:
380-
name: xdatabases.custom-api.example.org
378+
name: databases.custom-api.example.org
381379
spec:
382380
group: custom-api.example.org
383381
names:
384-
kind: xDatabase
385-
plural: xdatabases
382+
kind: Database
383+
plural: databases
386384
versions:
387385
- name: v1alpha1
388386
served: true
@@ -460,12 +458,12 @@ A second version,
460458
apiVersion: apiextensions.crossplane.io/v1
461459
kind: CompositeResourceDefinition
462460
metadata:
463-
name: xdatabases.custom-api.example.org
461+
name: databases.custom-api.example.org
464462
spec:
465463
group: custom-api.example.org
466464
names:
467-
kind: xDatabase
468-
plural: xdatabases
465+
kind: Database
466+
plural: databases
469467
versions:
470468
- name: v1alpha1
471469
schema:
@@ -552,7 +550,7 @@ to set the default Composition.
552550
apiVersion: apiextensions.crossplane.io/v1
553551
kind: CompositeResourceDefinition
554552
metadata:
555-
name: xdatabases.custom-api.example.org
553+
name: databases.custom-api.example.org
556554
spec:
557555
defaultCompositionRef:
558556
name: myComposition
@@ -583,7 +581,7 @@ this XRD.
583581
apiVersion: apiextensions.crossplane.io/v1
584582
kind: CompositeResourceDefinition
585583
metadata:
586-
name: xdatabases.custom-api.example.org
584+
name: databases.custom-api.example.org
587585
spec:
588586
defaultCompositionUpdatePolicy: Manual
589587
group: custom-api.example.org
@@ -609,7 +607,7 @@ set
609607
apiVersion: apiextensions.crossplane.io/v1
610608
kind: CompositeResourceDefinition
611609
metadata:
612-
name: xdatabases.custom-api.example.org
610+
name: databases.custom-api.example.org
613611
spec:
614612
enforcedCompositionRef:
615613
name: myComposition
@@ -632,7 +630,7 @@ Verify an XRD with `kubectl get compositeresourcedefinition` or the short form,
632630
```yaml {label="getxrd",copy-lines="1"}
633631
kubectl get xrd
634632
NAME ESTABLISHED OFFERED AGE
635-
xdatabases.custom-api.example.org True True 22m
633+
databases.custom-api.example.org True True 22m
636634
```
637635

638636
The `ESTABLISHED` field indicates Crossplane installed the Kubernetes custom
@@ -649,7 +647,7 @@ View the conditions of a XRD under their `Status` with
649647

650648
```yaml {copy-lines="none"}
651649
kubectl describe xrd
652-
Name: xpostgresqlinstances.database.starter.org
650+
Name: postgresqlinstances.database.starter.org
653651
API Version: apiextensions.crossplane.io/v1
654652
Kind: CompositeResourceDefinition
655653
# Removed for brevity

0 commit comments

Comments
 (0)