Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Harvey Xia <[email protected]>
  • Loading branch information
colinodell and harveyxia authored Nov 21, 2024
1 parent 96bcb77 commit 40cd94e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/sdk-claim-claimed-reconcilers.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ It's desirable for the `claim` object to be namespace scoped for one of the foll
1. Note (April 17th, 2024) that the `achilles-sdk` hasn't implemented this decoupling pattern yet because no concrete use cases have required it.

The `achilles-sdk` creates two independent reconcilers for the `claim` and `claimed` objects.
The `claim` reconciler is entirely managed by the sdk and does not require any work on the user's part ([ref](https://github.com/reddit/achilles-sdk/blob/main/pkg/fsm/internal/reconciler_claim.go#L43)).
The `claim` reconciler is entirely managed by the sdk and does not require any work on the user's part ([ref](https://github.com/reddit/achilles-sdk/blob/4fe0f620d71a1a988cd05629df5ea4502b5ff2ea/pkg/fsm/internal/reconciler_claim.go#L45)).
The `claim` reconciler is responsible for creating the `claimed` object if it does not exist and cascading a delete call when the `claim` object is deleted.
The developer is responsible for implementing the `claimed` reconciler using the exposed [FSM semantics]({{< ref "dev/sdk/sdk-fsm-reconciler" >}}).
2 changes: 1 addition & 1 deletion docs/sdk-finalizers.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ var finalizerState = &state{
### Finalizer for claim/claimed reconciler

For the claim/claimed reconciler, the sdk automatically adds a finalizer to the `claim` object.
This is to ensure the sdk is able to delete the `claimed` object when the `claim` object is deleted ([ref](https://github.com/reddit/achilles-sdk/blob/main/pkg/fsm/internal/reconciler_claim.go)).
This is to ensure the sdk is able to delete the `claimed` object when the `claim` object is deleted ([ref](https://github.com/reddit/achilles-sdk/blob/4fe0f620d71a1a988cd05629df5ea4502b5ff2ea/pkg/fsm/internal/reconciler_claim.go#L24)).
The behaviour of the finalizer on the `claimed` object is controlled by the `finalizerState` provided to the controller as explained above

0 comments on commit 40cd94e

Please sign in to comment.