Skip to content

Commit

Permalink
Clarify claiming-existing-composite-resources: CompositeAlreadyBoundE…
Browse files Browse the repository at this point in the history
…rror

CompositeAlreadyBoundError should be returned if a composite is already bound to a claim

Fixes crossplane#783
  • Loading branch information
gberche-orange authored Jun 6, 2024
1 parent dda19d8 commit 6b66b60
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions content/master/concepts/claims.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ If you don't use namespaces in your Kubernetes deployment Claims aren't necessar
### Claiming existing composite resources

By default, creating a Claim creates a new composite resource. Claims can also
link to existing composite resources.
link to existing composite resources (if not yet referencing a claim).

A use case for claiming existing composite resources may be slow to provision
resources. Composite resources can be pre-provisioned and a Claim can
Expand All @@ -164,6 +164,10 @@ If a Claim specifies a
{{<hover label="resourceref" line="6">}}resourceRef{{</hover>}} that doesn't
exist, Crossplane doesn't create a composite resource.
If a new Claim specifies a
{{<hover label="resourceref" line="6">}}resourceRef{{</hover>}} of a composite which is already referenced by another existing claim, then the new Claim will fail with a `CompositeAlreadyBoundError`.


{{<hint "note" >}}
All Claims have a
{{<hover label="resourceref" line="6">}}resourceRef{{</hover>}}. Manually
Expand All @@ -174,6 +178,8 @@ isn't required. Crossplane fills in the
with the information from the composite resource created for the Claim.
{{< /hint >}}



## Claim connection secrets

If a Claim expects connection secrets the Claim must define a
Expand Down Expand Up @@ -204,4 +210,4 @@ spec:
name: my-claim-secret
```

For more information on connection secrets read the [Connection Secrets knowledge base article]({{<ref "connection-details">}}).
For more information on connection secrets read the [Connection Secrets knowledge base article]({{<ref "connection-details">}}).

0 comments on commit 6b66b60

Please sign in to comment.