Skip to content

docs: remove X from kind #978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+20 −22
Open

docs: remove X from kind #978

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 20 additions & 22 deletions content/v2.0/composition/composite-resource-definitions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ spec:
scope: Namespaced
group: example.org
names:
kind: XMyDatabase
kind: MyDatabase
plural: mydatabases
versions:
- name: v1alpha1
Expand Down Expand Up @@ -119,8 +119,6 @@ The required name fields are:

* `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).
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
lowercase.

Expand All @@ -145,7 +143,7 @@ metadata:
spec:
group: example.org
names:
kind: XMyDatabase
kind: MyDatabase
plural: mydatabases
# Removed for brevity
```
Expand Down Expand Up @@ -211,12 +209,12 @@ is a {{<hover label="schema" line="20">}}string{{</hover>}}.
apiVersion: apiextensions.crossplane.io/v1
kind: CompositeResourceDefinition
metadata:
name: xdatabases.custom-api.example.org
name: databases.custom-api.example.org
spec:
group: custom-api.example.org
names:
kind: xDatabase
plural: xdatabases
kind: Database
plural: databases
versions:
- name: v1alpha1
schema:
Expand All @@ -239,7 +237,7 @@ A composite resource using this API references the

```yaml {label="xr"}
apiVersion: custom-api.example.org/v1alpha1
kind: xDatabase
kind: Database
metadata:
name: my-composite-resource
spec:
Expand Down Expand Up @@ -279,12 +277,12 @@ In this example the XRD requires
apiVersion: apiextensions.crossplane.io/v1
kind: CompositeResourceDefinition
metadata:
name: xdatabases.custom-api.example.org
name: databases.custom-api.example.org
spec:
group: custom-api.example.org
names:
kind: xDatabase
plural: xdatabases
kind: Database
plural: databases
versions:
- name: v1alpha1
schema:
Expand Down Expand Up @@ -377,12 +375,12 @@ and
apiVersion: apiextensions.crossplane.io/v1
kind: CompositeResourceDefinition
metadata:
name: xdatabases.custom-api.example.org
name: databases.custom-api.example.org
spec:
group: custom-api.example.org
names:
kind: xDatabase
plural: xdatabases
kind: Database
plural: databases
versions:
- name: v1alpha1
served: true
Expand Down Expand Up @@ -460,12 +458,12 @@ A second version,
apiVersion: apiextensions.crossplane.io/v1
kind: CompositeResourceDefinition
metadata:
name: xdatabases.custom-api.example.org
name: databases.custom-api.example.org
spec:
group: custom-api.example.org
names:
kind: xDatabase
plural: xdatabases
kind: Database
plural: databases
versions:
- name: v1alpha1
schema:
Expand Down Expand Up @@ -552,7 +550,7 @@ to set the default Composition.
apiVersion: apiextensions.crossplane.io/v1
kind: CompositeResourceDefinition
metadata:
name: xdatabases.custom-api.example.org
name: databases.custom-api.example.org
spec:
defaultCompositionRef:
name: myComposition
Expand Down Expand Up @@ -583,7 +581,7 @@ this XRD.
apiVersion: apiextensions.crossplane.io/v1
kind: CompositeResourceDefinition
metadata:
name: xdatabases.custom-api.example.org
name: databases.custom-api.example.org
spec:
defaultCompositionUpdatePolicy: Manual
group: custom-api.example.org
Expand All @@ -609,7 +607,7 @@ set
apiVersion: apiextensions.crossplane.io/v1
kind: CompositeResourceDefinition
metadata:
name: xdatabases.custom-api.example.org
name: databases.custom-api.example.org
spec:
enforcedCompositionRef:
name: myComposition
Expand All @@ -632,7 +630,7 @@ Verify an XRD with `kubectl get compositeresourcedefinition` or the short form,
```yaml {label="getxrd",copy-lines="1"}
kubectl get xrd
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
Expand All @@ -649,7 +647,7 @@ View the conditions of a XRD under their `Status` with

```yaml {copy-lines="none"}
kubectl describe xrd
Name: xpostgresqlinstances.database.starter.org
Name: postgresqlinstances.database.starter.org
API Version: apiextensions.crossplane.io/v1
Kind: CompositeResourceDefinition
# Removed for brevity
Expand Down