62
62
scope : Namespaced
63
63
group : example.org
64
64
names :
65
- kind : XMyDatabase
65
+ kind : MyDatabase
66
66
plural : mydatabases
67
67
versions :
68
68
- name : v1alpha1
@@ -119,8 +119,6 @@ The required name fields are:
119
119
120
120
* ` kind ` - the ` kind ` value to use when calling this API. The kind is
121
121
[ 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.
124
122
* ` plural ` - the plural name used for the API URL. The plural name must be
125
123
lowercase.
126
124
@@ -145,7 +143,7 @@ metadata:
145
143
spec :
146
144
group : example.org
147
145
names :
148
- kind : XMyDatabase
146
+ kind : MyDatabase
149
147
plural : mydatabases
150
148
# Removed for brevity
151
149
```
@@ -211,12 +209,12 @@ is a {{<hover label="schema" line="20">}}string{{</hover>}}.
211
209
apiVersion : apiextensions.crossplane.io/v1
212
210
kind : CompositeResourceDefinition
213
211
metadata :
214
- name : xdatabases .custom-api.example.org
212
+ name : databases .custom-api.example.org
215
213
spec :
216
214
group : custom-api.example.org
217
215
names :
218
- kind : xDatabase
219
- plural : xdatabases
216
+ kind : Database
217
+ plural : databases
220
218
versions :
221
219
- name : v1alpha1
222
220
schema :
@@ -239,7 +237,7 @@ A composite resource using this API references the
239
237
240
238
``` yaml {label="xr"}
241
239
apiVersion : custom-api.example.org/v1alpha1
242
- kind : xDatabase
240
+ kind : Database
243
241
metadata :
244
242
name : my-composite-resource
245
243
spec :
@@ -279,12 +277,12 @@ In this example the XRD requires
279
277
apiVersion : apiextensions.crossplane.io/v1
280
278
kind : CompositeResourceDefinition
281
279
metadata :
282
- name : xdatabases .custom-api.example.org
280
+ name : databases .custom-api.example.org
283
281
spec :
284
282
group : custom-api.example.org
285
283
names :
286
- kind : xDatabase
287
- plural : xdatabases
284
+ kind : Database
285
+ plural : databases
288
286
versions :
289
287
- name : v1alpha1
290
288
schema :
@@ -377,12 +375,12 @@ and
377
375
apiVersion: apiextensions.crossplane.io/v1
378
376
kind: CompositeResourceDefinition
379
377
metadata:
380
- name: xdatabases .custom-api.example.org
378
+ name: databases .custom-api.example.org
381
379
spec:
382
380
group: custom-api.example.org
383
381
names:
384
- kind: xDatabase
385
- plural: xdatabases
382
+ kind: Database
383
+ plural: databases
386
384
versions:
387
385
- name: v1alpha1
388
386
served: true
@@ -460,12 +458,12 @@ A second version,
460
458
apiVersion: apiextensions.crossplane.io/v1
461
459
kind: CompositeResourceDefinition
462
460
metadata:
463
- name: xdatabases .custom-api.example.org
461
+ name: databases .custom-api.example.org
464
462
spec:
465
463
group: custom-api.example.org
466
464
names:
467
- kind: xDatabase
468
- plural: xdatabases
465
+ kind: Database
466
+ plural: databases
469
467
versions:
470
468
- name: v1alpha1
471
469
schema:
@@ -552,7 +550,7 @@ to set the default Composition.
552
550
apiVersion: apiextensions.crossplane.io/v1
553
551
kind: CompositeResourceDefinition
554
552
metadata:
555
- name: xdatabases .custom-api.example.org
553
+ name: databases .custom-api.example.org
556
554
spec:
557
555
defaultCompositionRef:
558
556
name: myComposition
@@ -583,7 +581,7 @@ this XRD.
583
581
apiVersion: apiextensions.crossplane.io/v1
584
582
kind: CompositeResourceDefinition
585
583
metadata:
586
- name: xdatabases .custom-api.example.org
584
+ name: databases .custom-api.example.org
587
585
spec:
588
586
defaultCompositionUpdatePolicy: Manual
589
587
group: custom-api.example.org
609
607
apiVersion: apiextensions.crossplane.io/v1
610
608
kind: CompositeResourceDefinition
611
609
metadata:
612
- name: xdatabases .custom-api.example.org
610
+ name: databases .custom-api.example.org
613
611
spec:
614
612
enforcedCompositionRef:
615
613
name: myComposition
@@ -632,7 +630,7 @@ Verify an XRD with `kubectl get compositeresourcedefinition` or the short form,
632
630
` ` ` yaml {label="getxrd",copy-lines="1"}
633
631
kubectl get xrd
634
632
NAME ESTABLISHED OFFERED AGE
635
- xdatabases .custom-api.example.org True True 22m
633
+ databases .custom-api.example.org True True 22m
636
634
` ` `
637
635
638
636
The `ESTABLISHED` field indicates Crossplane installed the Kubernetes custom
@@ -649,7 +647,7 @@ View the conditions of a XRD under their `Status` with
649
647
650
648
` ` ` yaml {copy-lines="none"}
651
649
kubectl describe xrd
652
- Name: xpostgresqlinstances .database.starter.org
650
+ Name: postgresqlinstances .database.starter.org
653
651
API Version: apiextensions.crossplane.io/v1
654
652
Kind: CompositeResourceDefinition
655
653
# Removed for brevity
0 commit comments