Skip to content

Commit 8e109bf

Browse files
kruthiwusirika5kruthiwusirika5
committed
docs: use apiextensions.crossplane.io/v2 for XRD in v2 docs
In Crossplane v2, CompositeResourceDefinition (XRD) apiVersion v1 is deprecated. Update v2.0, v2.1, v2.2 and master doc content to show apiextensions.crossplane.io/v2 for all XRD YAML examples and kubectl describe output. Leaves migration/upgrade doc v1 examples unchanged. Fixes #1037 Signed-off-by: Kruthi Wusirika <kruthiwusirika@gmail.com>
1 parent b8b927a commit 8e109bf

20 files changed

+52
-52
lines changed

‎content/master/cli/command-reference.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1011,7 +1011,7 @@ Apply a CEL rule with the
10111011
inside the schema {{<hover label="celXRD" line="10" >}}spec{{</hover>}} object of an XRD.
10121012

10131013
```yaml {label="celXRD"}
1014-
apiVersion: apiextensions.crossplane.io/v1
1014+
apiVersion: apiextensions.crossplane.io/v2
10151015
kind: CompositeResourceDefinition
10161016
metadata:
10171017
name: myXR.crossplane.io

‎content/master/composition/composite-resource-definitions.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ label="xrdName" line="9">}}plural{{</hover>}} name
138138
{{<hover label="xrdName" line="6">}}example.org{{</hover>}}.
139139

140140
```yaml {label="xrdName",copy-lines="none"}
141-
apiVersion: apiextensions.crossplane.io/v1
141+
apiVersion: apiextensions.crossplane.io/v2
142142
kind: CompositeResourceDefinition
143143
metadata:
144144
name: mydatabases.example.org
@@ -208,7 +208,7 @@ In this example, the key {{<hover label="schema" line="19">}}region{{</hover>}}
208208
is a {{<hover label="schema" line="20">}}string{{</hover>}}.
209209

210210
```yaml {label="schema",copy-lines="none"}
211-
apiVersion: apiextensions.crossplane.io/v1
211+
apiVersion: apiextensions.crossplane.io/v2
212212
kind: CompositeResourceDefinition
213213
metadata:
214214
name: xdatabases.custom-api.example.org
@@ -276,7 +276,7 @@ In this example the XRD requires
276276
{{< hover label="required" line="21">}}size{{</hover>}} but
277277
{{< hover label="required" line="23">}}name{{</hover>}} is optional.
278278
```yaml {label="required",copy-lines="none"}
279-
apiVersion: apiextensions.crossplane.io/v1
279+
apiVersion: apiextensions.crossplane.io/v2
280280
kind: CompositeResourceDefinition
281281
metadata:
282282
name: xdatabases.custom-api.example.org
@@ -374,7 +374,7 @@ and
374374
{{<hover label="served" line="13" >}}referenceable: true{{</hover>}}.
375375

376376
```yaml {label="served"}
377-
apiVersion: apiextensions.crossplane.io/v1
377+
apiVersion: apiextensions.crossplane.io/v2
378378
kind: CompositeResourceDefinition
379379
metadata:
380380
name: xdatabases.custom-api.example.org
@@ -457,7 +457,7 @@ A second version,
457457
{{<hover label="ver" line="31">}}size{{</hover>}}.
458458

459459
```yaml {label="ver",copy-lines="none"}
460-
apiVersion: apiextensions.crossplane.io/v1
460+
apiVersion: apiextensions.crossplane.io/v2
461461
kind: CompositeResourceDefinition
462462
metadata:
463463
name: xdatabases.custom-api.example.org
@@ -549,7 +549,7 @@ Set a
549549
to set the default Composition.
550550

551551
```yaml {label="defaultComp",copy-lines="none"}
552-
apiVersion: apiextensions.crossplane.io/v1
552+
apiVersion: apiextensions.crossplane.io/v2
553553
kind: CompositeResourceDefinition
554554
metadata:
555555
name: xdatabases.custom-api.example.org
@@ -580,7 +580,7 @@ to set the default Composition update policy for composite resources and using
580580
this XRD.
581581

582582
```yaml {label="compRev",copy-lines="none"}
583-
apiVersion: apiextensions.crossplane.io/v1
583+
apiVersion: apiextensions.crossplane.io/v2
584584
kind: CompositeResourceDefinition
585585
metadata:
586586
name: xdatabases.custom-api.example.org
@@ -606,7 +606,7 @@ set
606606
{{<hover label="enforceComp" line="6">}}enforcedCompositionRef.name: myComposition{{</hover>}}.
607607

608608
```yaml {label="defaultComp",copy-lines="none"}
609-
apiVersion: apiextensions.crossplane.io/v1
609+
apiVersion: apiextensions.crossplane.io/v2
610610
kind: CompositeResourceDefinition
611611
metadata:
612612
name: xdatabases.custom-api.example.org
@@ -650,7 +650,7 @@ View the conditions of a XRD under their `Status` with
650650
```yaml {copy-lines="none"}
651651
kubectl describe xrd
652652
Name: xpostgresqlinstances.database.starter.org
653-
API Version: apiextensions.crossplane.io/v1
653+
API Version: apiextensions.crossplane.io/v2
654654
Kind: CompositeResourceDefinition
655655
# Removed for brevity
656656
Status:

‎content/master/composition/composite-resources.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ creates a custom API endpoint
6464
{{<hover label="xrd1" line="4">}}mydatabases.example.org{{</hover>}}.
6565

6666
```yaml {label="xrd1",copy-lines="none"}
67-
apiVersion: apiextensions.crossplane.io/v1
67+
apiVersion: apiextensions.crossplane.io/v2
6868
kind: CompositeResourceDefinition
6969
metadata:
7070
name: mydatabases.example.org

‎content/master/composition/composition-revisions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ spec:
169169

170170
Apply the example XRD.
171171
```yaml
172-
apiVersion: apiextensions.crossplane.io/v1
172+
apiVersion: apiextensions.crossplane.io/v2
173173
kind: CompositeResourceDefinition
174174
metadata:
175175
name: myvpcs.aws.example.upbound.io

‎content/master/guides/function-patch-and-transform.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ spec:
533533

534534
{{<expand "Reference CompositeResourceDefinition" >}}
535535
```yaml {copy-lines="all"}
536-
apiVersion: apiextensions.crossplane.io/v1
536+
apiVersion: apiextensions.crossplane.io/v2
537537
kind: CompositeResourceDefinition
538538
metadata:
539539
name: examples.example.org

‎content/v2.0/cli/command-reference.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1011,7 +1011,7 @@ Apply a CEL rule with the
10111011
inside the schema {{<hover label="celXRD" line="10" >}}spec{{</hover>}} object of an XRD.
10121012

10131013
```yaml {label="celXRD"}
1014-
apiVersion: apiextensions.crossplane.io/v1
1014+
apiVersion: apiextensions.crossplane.io/v2
10151015
kind: CompositeResourceDefinition
10161016
metadata:
10171017
name: myXR.crossplane.io

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ label="xrdName" line="9">}}plural{{</hover>}} name
138138
{{<hover label="xrdName" line="6">}}example.org{{</hover>}}.
139139

140140
```yaml {label="xrdName",copy-lines="none"}
141-
apiVersion: apiextensions.crossplane.io/v1
141+
apiVersion: apiextensions.crossplane.io/v2
142142
kind: CompositeResourceDefinition
143143
metadata:
144144
name: mydatabases.example.org
@@ -208,7 +208,7 @@ In this example, the key {{<hover label="schema" line="19">}}region{{</hover>}}
208208
is a {{<hover label="schema" line="20">}}string{{</hover>}}.
209209

210210
```yaml {label="schema",copy-lines="none"}
211-
apiVersion: apiextensions.crossplane.io/v1
211+
apiVersion: apiextensions.crossplane.io/v2
212212
kind: CompositeResourceDefinition
213213
metadata:
214214
name: xdatabases.custom-api.example.org
@@ -276,7 +276,7 @@ In this example the XRD requires
276276
{{< hover label="required" line="21">}}size{{</hover>}} but
277277
{{< hover label="required" line="23">}}name{{</hover>}} is optional.
278278
```yaml {label="required",copy-lines="none"}
279-
apiVersion: apiextensions.crossplane.io/v1
279+
apiVersion: apiextensions.crossplane.io/v2
280280
kind: CompositeResourceDefinition
281281
metadata:
282282
name: xdatabases.custom-api.example.org
@@ -374,7 +374,7 @@ and
374374
{{<hover label="served" line="13" >}}referenceable: true{{</hover>}}.
375375

376376
```yaml {label="served"}
377-
apiVersion: apiextensions.crossplane.io/v1
377+
apiVersion: apiextensions.crossplane.io/v2
378378
kind: CompositeResourceDefinition
379379
metadata:
380380
name: xdatabases.custom-api.example.org
@@ -457,7 +457,7 @@ A second version,
457457
{{<hover label="ver" line="31">}}size{{</hover>}}.
458458

459459
```yaml {label="ver",copy-lines="none"}
460-
apiVersion: apiextensions.crossplane.io/v1
460+
apiVersion: apiextensions.crossplane.io/v2
461461
kind: CompositeResourceDefinition
462462
metadata:
463463
name: xdatabases.custom-api.example.org
@@ -549,7 +549,7 @@ Set a
549549
to set the default Composition.
550550

551551
```yaml {label="defaultComp",copy-lines="none"}
552-
apiVersion: apiextensions.crossplane.io/v1
552+
apiVersion: apiextensions.crossplane.io/v2
553553
kind: CompositeResourceDefinition
554554
metadata:
555555
name: xdatabases.custom-api.example.org
@@ -580,7 +580,7 @@ to set the default Composition update policy for composite resources and using
580580
this XRD.
581581

582582
```yaml {label="compRev",copy-lines="none"}
583-
apiVersion: apiextensions.crossplane.io/v1
583+
apiVersion: apiextensions.crossplane.io/v2
584584
kind: CompositeResourceDefinition
585585
metadata:
586586
name: xdatabases.custom-api.example.org
@@ -606,7 +606,7 @@ set
606606
{{<hover label="enforceComp" line="6">}}enforcedCompositionRef.name: myComposition{{</hover>}}.
607607

608608
```yaml {label="defaultComp",copy-lines="none"}
609-
apiVersion: apiextensions.crossplane.io/v1
609+
apiVersion: apiextensions.crossplane.io/v2
610610
kind: CompositeResourceDefinition
611611
metadata:
612612
name: xdatabases.custom-api.example.org
@@ -650,7 +650,7 @@ View the conditions of a XRD under their `Status` with
650650
```yaml {copy-lines="none"}
651651
kubectl describe xrd
652652
Name: xpostgresqlinstances.database.starter.org
653-
API Version: apiextensions.crossplane.io/v1
653+
API Version: apiextensions.crossplane.io/v2
654654
Kind: CompositeResourceDefinition
655655
# Removed for brevity
656656
Status:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ creates a custom API endpoint
6464
{{<hover label="xrd1" line="4">}}mydatabases.example.org{{</hover>}}.
6565

6666
```yaml {label="xrd1",copy-lines="none"}
67-
apiVersion: apiextensions.crossplane.io/v1
67+
apiVersion: apiextensions.crossplane.io/v2
6868
kind: CompositeResourceDefinition
6969
metadata:
7070
name: mydatabases.example.org

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ spec:
169169

170170
Apply the example XRD.
171171
```yaml
172-
apiVersion: apiextensions.crossplane.io/v1
172+
apiVersion: apiextensions.crossplane.io/v2
173173
kind: CompositeResourceDefinition
174174
metadata:
175175
name: myvpcs.aws.example.upbound.io

‎content/v2.0/guides/function-patch-and-transform.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ spec:
533533

534534
{{<expand "Reference CompositeResourceDefinition" >}}
535535
```yaml {copy-lines="all"}
536-
apiVersion: apiextensions.crossplane.io/v1
536+
apiVersion: apiextensions.crossplane.io/v2
537537
kind: CompositeResourceDefinition
538538
metadata:
539539
name: examples.example.org

0 commit comments

Comments
 (0)