mirror of https://github.com/crossplane/docs.git
docs: remove X from kind
Signed-off-by: Amund Tenstad <github@amund.io>
This commit is contained in:
parent
3b8bad4228
commit
b7fce760f8
|
|
@ -62,7 +62,7 @@ spec:
|
||||||
scope: Namespaced
|
scope: Namespaced
|
||||||
group: example.org
|
group: example.org
|
||||||
names:
|
names:
|
||||||
kind: XMyDatabase
|
kind: MyDatabase
|
||||||
plural: mydatabases
|
plural: mydatabases
|
||||||
versions:
|
versions:
|
||||||
- name: v1alpha1
|
- name: v1alpha1
|
||||||
|
|
@ -119,8 +119,6 @@ The required name fields are:
|
||||||
|
|
||||||
* `kind` - the `kind` value to use when calling this API. The kind is
|
* `kind` - the `kind` value to use when calling this API. The kind is
|
||||||
[UpperCamelCased](https://kubernetes.io/docs/contribute/style/style-guide/#use-upper-camel-case-for-api-objects).
|
[UpperCamelCased](https://kubernetes.io/docs/contribute/style/style-guide/#use-upper-camel-case-for-api-objects).
|
||||||
Crossplane recommends starting XRD `kinds` with an `X` to show
|
|
||||||
it's a custom Crossplane API definition.
|
|
||||||
* `plural` - the plural name used for the API URL. The plural name must be
|
* `plural` - the plural name used for the API URL. The plural name must be
|
||||||
lowercase.
|
lowercase.
|
||||||
|
|
||||||
|
|
@ -145,7 +143,7 @@ metadata:
|
||||||
spec:
|
spec:
|
||||||
group: example.org
|
group: example.org
|
||||||
names:
|
names:
|
||||||
kind: XMyDatabase
|
kind: MyDatabase
|
||||||
plural: mydatabases
|
plural: mydatabases
|
||||||
# Removed for brevity
|
# Removed for brevity
|
||||||
```
|
```
|
||||||
|
|
@ -211,12 +209,12 @@ is a {{<hover label="schema" line="20">}}string{{</hover>}}.
|
||||||
apiVersion: apiextensions.crossplane.io/v1
|
apiVersion: apiextensions.crossplane.io/v1
|
||||||
kind: CompositeResourceDefinition
|
kind: CompositeResourceDefinition
|
||||||
metadata:
|
metadata:
|
||||||
name: xdatabases.custom-api.example.org
|
name: databases.custom-api.example.org
|
||||||
spec:
|
spec:
|
||||||
group: custom-api.example.org
|
group: custom-api.example.org
|
||||||
names:
|
names:
|
||||||
kind: xDatabase
|
kind: Database
|
||||||
plural: xdatabases
|
plural: databases
|
||||||
versions:
|
versions:
|
||||||
- name: v1alpha1
|
- name: v1alpha1
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -239,7 +237,7 @@ A composite resource using this API references the
|
||||||
|
|
||||||
```yaml {label="xr"}
|
```yaml {label="xr"}
|
||||||
apiVersion: custom-api.example.org/v1alpha1
|
apiVersion: custom-api.example.org/v1alpha1
|
||||||
kind: xDatabase
|
kind: Database
|
||||||
metadata:
|
metadata:
|
||||||
name: my-composite-resource
|
name: my-composite-resource
|
||||||
spec:
|
spec:
|
||||||
|
|
@ -279,12 +277,12 @@ In this example the XRD requires
|
||||||
apiVersion: apiextensions.crossplane.io/v1
|
apiVersion: apiextensions.crossplane.io/v1
|
||||||
kind: CompositeResourceDefinition
|
kind: CompositeResourceDefinition
|
||||||
metadata:
|
metadata:
|
||||||
name: xdatabases.custom-api.example.org
|
name: databases.custom-api.example.org
|
||||||
spec:
|
spec:
|
||||||
group: custom-api.example.org
|
group: custom-api.example.org
|
||||||
names:
|
names:
|
||||||
kind: xDatabase
|
kind: Database
|
||||||
plural: xdatabases
|
plural: databases
|
||||||
versions:
|
versions:
|
||||||
- name: v1alpha1
|
- name: v1alpha1
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -377,12 +375,12 @@ and
|
||||||
apiVersion: apiextensions.crossplane.io/v1
|
apiVersion: apiextensions.crossplane.io/v1
|
||||||
kind: CompositeResourceDefinition
|
kind: CompositeResourceDefinition
|
||||||
metadata:
|
metadata:
|
||||||
name: xdatabases.custom-api.example.org
|
name: databases.custom-api.example.org
|
||||||
spec:
|
spec:
|
||||||
group: custom-api.example.org
|
group: custom-api.example.org
|
||||||
names:
|
names:
|
||||||
kind: xDatabase
|
kind: Database
|
||||||
plural: xdatabases
|
plural: databases
|
||||||
versions:
|
versions:
|
||||||
- name: v1alpha1
|
- name: v1alpha1
|
||||||
served: true
|
served: true
|
||||||
|
|
@ -460,12 +458,12 @@ A second version,
|
||||||
apiVersion: apiextensions.crossplane.io/v1
|
apiVersion: apiextensions.crossplane.io/v1
|
||||||
kind: CompositeResourceDefinition
|
kind: CompositeResourceDefinition
|
||||||
metadata:
|
metadata:
|
||||||
name: xdatabases.custom-api.example.org
|
name: databases.custom-api.example.org
|
||||||
spec:
|
spec:
|
||||||
group: custom-api.example.org
|
group: custom-api.example.org
|
||||||
names:
|
names:
|
||||||
kind: xDatabase
|
kind: Database
|
||||||
plural: xdatabases
|
plural: databases
|
||||||
versions:
|
versions:
|
||||||
- name: v1alpha1
|
- name: v1alpha1
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -552,7 +550,7 @@ to set the default Composition.
|
||||||
apiVersion: apiextensions.crossplane.io/v1
|
apiVersion: apiextensions.crossplane.io/v1
|
||||||
kind: CompositeResourceDefinition
|
kind: CompositeResourceDefinition
|
||||||
metadata:
|
metadata:
|
||||||
name: xdatabases.custom-api.example.org
|
name: databases.custom-api.example.org
|
||||||
spec:
|
spec:
|
||||||
defaultCompositionRef:
|
defaultCompositionRef:
|
||||||
name: myComposition
|
name: myComposition
|
||||||
|
|
@ -583,7 +581,7 @@ this XRD.
|
||||||
apiVersion: apiextensions.crossplane.io/v1
|
apiVersion: apiextensions.crossplane.io/v1
|
||||||
kind: CompositeResourceDefinition
|
kind: CompositeResourceDefinition
|
||||||
metadata:
|
metadata:
|
||||||
name: xdatabases.custom-api.example.org
|
name: databases.custom-api.example.org
|
||||||
spec:
|
spec:
|
||||||
defaultCompositionUpdatePolicy: Manual
|
defaultCompositionUpdatePolicy: Manual
|
||||||
group: custom-api.example.org
|
group: custom-api.example.org
|
||||||
|
|
@ -609,7 +607,7 @@ set
|
||||||
apiVersion: apiextensions.crossplane.io/v1
|
apiVersion: apiextensions.crossplane.io/v1
|
||||||
kind: CompositeResourceDefinition
|
kind: CompositeResourceDefinition
|
||||||
metadata:
|
metadata:
|
||||||
name: xdatabases.custom-api.example.org
|
name: databases.custom-api.example.org
|
||||||
spec:
|
spec:
|
||||||
enforcedCompositionRef:
|
enforcedCompositionRef:
|
||||||
name: myComposition
|
name: myComposition
|
||||||
|
|
@ -632,7 +630,7 @@ Verify an XRD with `kubectl get compositeresourcedefinition` or the short form,
|
||||||
```yaml {label="getxrd",copy-lines="1"}
|
```yaml {label="getxrd",copy-lines="1"}
|
||||||
kubectl get xrd
|
kubectl get xrd
|
||||||
NAME ESTABLISHED OFFERED AGE
|
NAME ESTABLISHED OFFERED AGE
|
||||||
xdatabases.custom-api.example.org True True 22m
|
databases.custom-api.example.org True True 22m
|
||||||
```
|
```
|
||||||
|
|
||||||
The `ESTABLISHED` field indicates Crossplane installed the Kubernetes custom
|
The `ESTABLISHED` field indicates Crossplane installed the Kubernetes custom
|
||||||
|
|
@ -649,7 +647,7 @@ View the conditions of a XRD under their `Status` with
|
||||||
|
|
||||||
```yaml {copy-lines="none"}
|
```yaml {copy-lines="none"}
|
||||||
kubectl describe xrd
|
kubectl describe xrd
|
||||||
Name: xpostgresqlinstances.database.starter.org
|
Name: postgresqlinstances.database.starter.org
|
||||||
API Version: apiextensions.crossplane.io/v1
|
API Version: apiextensions.crossplane.io/v1
|
||||||
Kind: CompositeResourceDefinition
|
Kind: CompositeResourceDefinition
|
||||||
# Removed for brevity
|
# Removed for brevity
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue