[DOCS] Add custom lease documentation #7388
Conversation
docs/articles/utilities/lease.md
Outdated
| @@ -0,0 +1,105 @@ | |||
| --- | |||
| uid: lease | |||
| title: Lease | |||
There was a problem hiding this comment.
"Distributed Locks with Akka.Coordination" would be better
docs/articles/utilities/lease.md
Outdated
|
|
||
| ## General Definition | ||
|
|
||
| A **lease-based access control system** is a distributed coordination mechanism in which access to a resource is granted by issuing a lease, or token, that represents temporary permission to access a resource. The lease must be acquired by any process intending to interact with the resource. This mechanism often involves the following elements: |
There was a problem hiding this comment.
It'd simplify this to say Akka.Coordination provides a generalized "distributed lock" implementation called a Lease that uses a unique resource identifier inside a backing store (such as Azure Blob Storage or Kubernetes Custom Resource Definitions) to only allow one current "holder" of the lease to perform an action at any given time.
Akka.NET uses leases internally inside Split Brain Resolvers (link), Cluster.Sharding, and Cluster Singletons for this purpose - and in this document you can learn how to call and create leases in your own Akka.NET applications if needed.
| * **Lease Name**: A unique identifier for the lease, which specifies the resource to be protected. | ||
| * **Owner Name**: A unique identifier for the entity (usually an actor or node) that is attempting to acquire the lease. | ||
| * **Lease Timeout**: A duration parameter that specifies how long the lease should last. Leases may be renewed or revoked depending on the implementation. | ||
|
|
There was a problem hiding this comment.
Add a section here on "available lease implementations" and link to the appropriate docs in the Akka.Management repo
Aaronontheweb
added
docs
akka-coordination
No description provided.