Struct LeaseManager

pub struct LeaseManager { /* private fields */ }

Available on crate feature lease only.

Manages a Kubernetes Lease

Implementations

impl LeaseManager

pub async fn init(api: Api<Lease>, name: impl ToString) -> Result<Self, Error>

Initialize a lease’s state from the Kubernetes API.

The named lease resource must already have been created, or a 404 error will be returned.

pub fn with_field_manager( self, field_manager: impl Into<Cow<'static, str>>, ) -> Self

Overrides the field manager used when updating the Lease

This is intended to be used immediately following initialization and before ensure_claimed is invoked.

pub async fn claimed(&self) -> Option<Arc<Claim>>

Return the state of the claim without updating it from the API.

pub async fn sync(&self) -> Result<Option<Arc<Claim>>, Error>

Update the state of the claim from the API.

pub async fn ensure_claimed( &self, claimant: &str, params: &ClaimParams, ) -> Result<Arc<Claim>, Error>

Ensures that the lease, if it exists, is claimed.

If these is not currently held, it is claimed by the provided identity. If it is currently held by the provided claimant, it is renewed if it is within the renew grace period.

pub async fn vacate(&self, claimant: &str) -> Result<bool, Error>

Clear out the state of the lease if the claim is currently held by the provided identity.

This is typically used during process shutdown so that another process can potentially claim the lease before the prior lease duration expires.

pub async fn spawn( self, claimant: impl ToString, params: ClaimParams, ) -> Result<(Receiver<Arc<Claim>>, JoinHandle<Result<(), Error>>), Error>

Spawn a task that ensures the lease is claimed.

When the lease becomes unclaimed, the task attempts to claim the lease as claimant and maintains the lease until the task completes or the lease is claimed by another process.

The state of the lease is published via the returned receiver.

When all receivers are dropped, the task completes and the lease is vacated so that another process can claim it.