Skip to content

KubernetesLeaseSettings

Defined in: src/coordination/leases/KubernetesLease.ts:22

K8s-specific additions to the common lease settings. When apiServerUrl, authToken, or caCert are omitted the adapter probes the standard ServiceAccount mount points (/var/run/secrets/kubernetes.io/...).

client is a test seam — pass a fake K8sFetchClient to drive the lease without a real API server.

readonly optional acquireRetries?: number

Defined in: src/coordination/Lease.ts:40

Max attempts for a single acquire() before returning false.

LeaseSettings.acquireRetries


readonly optional acquireRetryDelayMs?: number

Defined in: src/coordination/Lease.ts:42

Delay between acquire retries.

LeaseSettings.acquireRetryDelayMs


readonly optional apiServerUrl?: string

Defined in: src/coordination/leases/KubernetesLease.ts:26

API-server URL. Defaults to the in-cluster service or https://kubernetes.default.svc.


readonly optional authToken?: string

Defined in: src/coordination/leases/KubernetesLease.ts:28

Bearer token for the ServiceAccount. Reads /var/run/... if omitted.


readonly optional caCert?: string

Defined in: src/coordination/leases/KubernetesLease.ts:30

PEM-encoded CA cert for the API server. Reads /var/run/... if omitted.


readonly optional client?: K8sFetchClient

Defined in: src/coordination/leases/KubernetesLease.ts:32

Test seam — inject a fake fetch client.


readonly name: string

Defined in: src/coordination/Lease.ts:32

Lease name — unique identifier within the namespace.

LeaseSettings.name


readonly namespace: string

Defined in: src/coordination/leases/KubernetesLease.ts:24

Kubernetes namespace that owns the coordination.k8s.io/v1/Lease object.


readonly owner: string

Defined in: src/coordination/Lease.ts:34

Identifier of the holder (pod name / host name / uuid).

LeaseSettings.owner


readonly optional renewalIntervalMs?: number

Defined in: src/coordination/Lease.ts:38

How often to renew (< ttlMs — typically ttl/3).

LeaseSettings.renewalIntervalMs


readonly ttlMs: number

Defined in: src/coordination/Lease.ts:36

Time-to-live in ms — the backend auto-expires if we fail to renew.

LeaseSettings.ttlMs