Skip to content

Commit 592c9bc

Browse files
committed
Remove mention of claims from getting-started
Signed-off-by: Nic Cope <[email protected]>
1 parent 74ce12d commit 592c9bc

File tree

1 file changed

+3
-160
lines changed

1 file changed

+3
-160
lines changed

content/v2.0-preview/getting-started/introduction.md

Lines changed: 3 additions & 160 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,7 @@ This table provides a summary of Crossplane components and their roles.
4444
| [Managed Resource]({{<ref "#managed-resources">}}) | `MR` | cluster | A Provider resource created and managed by Crossplane inside the Kubernetes cluster. |
4545
| [Composition]({{<ref "#compositions">}}) | | cluster | A template for creating multiple _managed resources_ at once. |
4646
| [Composite Resources]({{<ref "#composite-resources" >}}) | `XR` | cluster | Uses a _Composition_ template to create multiple _managed resources_ as a single Kubernetes object. |
47-
| [CompositeResourceDefinitions]({{<ref "#composite-resource-definitions" >}}) | `XRD` | cluster | Defines the API schema for _Composite Resources_ and _Claims_ |
48-
| [Claims]({{<ref "#claims" >}}) | `XC` | namespace | Like a _Composite Resource_, but namespace scoped. |
47+
| [CompositeResourceDefinitions]({{<ref "#composite-resource-definitions" >}}) | `XRD` | cluster | Defines the API schema for _Composite Resources_ |
4948
{{< /table >}}
5049

5150
## The Crossplane Pod
@@ -208,50 +207,6 @@ every time a user requests this set of resources.
208207
If a _Composition_ allows a user to define resource settings, users apply them
209208
in a _Composite Resource_.
210209

211-
212-
<!-- A _Composition_ defines which _Composite Resources_ can use the _Composition_
213-
template with the _Composition_ `spec.compositeTypeRef` value. This defines the
214-
{{<hover label="comp" line="7">}}apiVersion{{< /hover >}} and {{<hover
215-
label="comp" line="8">}}kind{{< /hover >}} of _Composite Resources_ that can use the
216-
_Composition_.
217-
218-
For example, in the _Composition_:
219-
```yaml {label="comp"}
220-
apiVersion: apiextensions.crossplane.io/v1
221-
kind: Composition
222-
metadata:
223-
name: test.example.org
224-
spec:
225-
compositeTypeRef:
226-
apiVersion: test.example.org/v1alpha1
227-
kind: MyComputeResource
228-
# Removed for brevity
229-
```
230-
231-
A _Composite Resource_ that can use this template must match this
232-
{{<hover label="comp" line="7">}}apiVersion{{< /hover >}} and {{<hover
233-
label="comp" line="8">}}kind{{< /hover >}}.
234-
235-
```yaml {label="xr"}
236-
apiVersion: test.example.org/v1alpha1
237-
kind: MyComputeResource
238-
metadata:
239-
name: my-resource
240-
spec:
241-
storage: "large"
242-
```
243-
244-
The _Composite Resource_ {{<hover label="xr" line="1">}}apiVersion{{< /hover >}}
245-
matches the and _Composition_
246-
{{<hover label="comp" line="7">}}apiVersion{{</hover >}} and the
247-
_Composite Resource_ {{<hover label="xr" line="2">}}kind{{< /hover >}}
248-
matches the _Composition_ {{<hover label="comp" line="8">}}kind{{< /hover >}}.
249-
250-
In this example, the _Composite Resource_ also sets the
251-
{{<hover label="xr" line="7">}}storage{{< /hover >}} setting. The
252-
_Composition_ uses this value when creating the associated _managed resources_
253-
owned by this _Composite Resource_. -->
254-
255210
{{< hint "tip" >}}
256211
_Compositions_ are templates for a set of _managed resources_.
257212
_Composite Resources_ fill out the template and create _managed resources_.
@@ -265,12 +220,7 @@ Use `kubectl get composite` to view all _Composite Resources_.
265220

266221
## Composite Resource Definitions
267222
_Composite Resource Definitions_ (`XRDs`) create custom Kubernetes APIs used by
268-
_Claims_ and _Composite Resources_.
269-
270-
{{< hint "note" >}}
271-
The [_Claims_]({{<ref "#claims">}}) section discusses
272-
_Claims_.
273-
{{< /hint >}}
223+
_Composite Resources_.
274224

275225
Platform teams define the custom APIs.
276226
These APIs can define specific values
@@ -378,114 +328,7 @@ spec:
378328
A _Composite Resource Definition_ can define a wide variety of settings and options.
379329

380330
Creating a _Composite Resource Definition_ enables the creation of _Composite
381-
Resources_ but can also create a _Claim_.
382-
383-
_Composite Resource Definitions_ with a `spec.claimNames` allow developers to
384-
create _Claims_.
385-
386-
For example, the
387-
{{< hover label="xrdClaim" line="6" >}}claimNames.kind{{</hover >}}
388-
allows the creation of _Claims_ of `kind: computeClaim`.
389-
```yaml {label="xrdClaim"}
390-
# Composite Resource Definition (XRD)
391-
spec:
392-
group: test.example.org
393-
names:
394-
kind: MyComputeResource
395-
claimNames:
396-
kind: computeClaim
397-
# Removed for brevity
398-
```
399-
400-
## Claims
401-
_Claims_ are the primary way developers interact with Crossplane.
402-
403-
_Claims_ access the custom APIs defined by the platform team in a _Composite
404-
Resource Definition_.
405-
406-
_Claims_ look like _Composite Resources_, but they're namespace scoped,
407-
while _Composite Resources_ are cluster scoped.
408-
409-
{{< hint "note" >}}
410-
**Why does namespace scope matter?**
411-
Having namespace scoped _Claims_ allows multiple teams, using unique namespaces,
412-
to create the same types of resources, independent of each other. The compute
413-
resources of team A are unique to the compute resources of team B.
414-
415-
Directly creating _Composite Resources_ requires cluster-wide permissions,
416-
shared with all teams.
417-
_Claims_ create the same set of resources, but on a namespace level.
418-
{{< /hint >}}
419-
420-
The previous _Composite Resource Definition_ allows the creation of _Claims_
421-
of the kind
422-
{{<hover label="xrdClaim2" line="7" >}}computeClaim{{</hover>}}.
423-
424-
Claims use the same
425-
{{< hover label="xrdClaim2" line="3" >}}apiVersion{{< /hover >}}
426-
defined in _Composite Resource Definition_ and also used by
427-
_Composite Resources_.
428-
```yaml {label="xrdClaim2"}
429-
# Composite Resource Definition (XRD)
430-
spec:
431-
group: test.example.org
432-
names:
433-
kind: MyComputeResource
434-
claimNames:
435-
kind: computeClaim
436-
# Removed for brevity
437-
```
438-
439-
In an example _Claim_ the
440-
{{<hover label="claim" line="2">}}apiVersion{{< /hover >}}
441-
matches the {{<hover label="xrdClaim2" line="3">}}group{{< /hover >}} in the
442-
_Composite Resource Definition_.
443-
444-
The _Claim_ {{<hover label="claim" line="3">}}kind{{< /hover >}} matches the
445-
_Composite Resource Definition_
446-
{{<hover label="xrdClaim2" line="7">}}claimNames.kind{{< /hover >}}.
447-
448-
```yaml {label="claim"}
449-
# Claim
450-
apiVersion: test.example.org/v1alpha1
451-
kind: computeClaim
452-
metadata:
453-
name: myClaim
454-
namespace: devGroup
455-
spec:
456-
size: "large"
457-
```
458-
459-
A _Claim_ can install in a {{<hover label="claim" line="6">}}namespace{{</hover >}}.
460-
The _Composite Resource Definition_ defines the
461-
{{<hover label="claim" line="7">}}spec{{< /hover >}} options the same way it
462-
does for a _Composite Resource_
463-
{{<hover label="xr-claim" line="6">}}spec{{< /hover >}}.
464-
465-
{{< hint "tip" >}}
466-
_Composite Resources_ and _Claims_ are similar.
467-
Only _Claims_ can be in
468-
a {{<hover label="claim" line="6">}}namespace{{</hover >}}.
469-
Also the _Composite Resource's_ {{<hover label="xr-claim"
470-
line="3">}}kind{{</hover >}} may be different than the _Claim's_
471-
{{<hover label="claim" line="3">}}kind{{< /hover >}}.
472-
The _Composite Resource Definition_ defines the
473-
{{<hover label="xrdClaim2" line="7">}}kind{{</hover >}} values.
474-
{{< /hint >}}
475-
476-
```yaml {label="xr-claim"}
477-
# Composite Resource (XR)
478-
apiVersion: test.example.org/v1alpha1
479-
kind: MyComputeResource
480-
metadata:
481-
name: my-resource
482-
spec:
483-
storage: "large"
484-
```
485-
486-
_Claims_ are namespace scoped.
487-
488-
View all available Claims with the command `kubectl get claim`.
331+
Resources_.
489332

490333
## Next steps
491334
Build your own Crossplane platform using one of the quickstart guides.

0 commit comments

Comments
 (0)