KubernetesLeaseOptionsType

Defined in: src/coordination/leases/KubernetesLeaseOptions.ts:13

K8s-specific additions to the common lease options. 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.

Extends

• LeaseOptionsType

Properties

acquireRetries?

readonly optional acquireRetries?: number

Defined in: src/coordination/LeaseOptions.ts:20

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

Inherited from

LeaseOptionsType.acquireRetries

---

acquireRetryDelayMs?

readonly optional acquireRetryDelayMs?: number

Defined in: src/coordination/LeaseOptions.ts:22

Delay between acquire retries.

Inherited from

LeaseOptionsType.acquireRetryDelayMs

---

apiServerUrl?

readonly optional apiServerUrl?: string

Defined in: src/coordination/leases/KubernetesLeaseOptions.ts:17

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

---

authToken?

readonly optional authToken?: string

Defined in: src/coordination/leases/KubernetesLeaseOptions.ts:19

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

---

caCert?

readonly optional caCert?: string

Defined in: src/coordination/leases/KubernetesLeaseOptions.ts:21

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

---

client?

readonly optional client?: K8sFetchClient

Defined in: src/coordination/leases/KubernetesLeaseOptions.ts:23

Test seam — inject a fake fetch client.

---

name

readonly name: string

Defined in: src/coordination/LeaseOptions.ts:12

Lease name — unique identifier within the namespace.

Inherited from

LeaseOptionsType.name

---

namespace

readonly namespace: string

Defined in: src/coordination/leases/KubernetesLeaseOptions.ts:15

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

---

owner

readonly owner: string

Defined in: src/coordination/LeaseOptions.ts:14

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

Inherited from

LeaseOptionsType.owner

---

renewalIntervalMs?

readonly optional renewalIntervalMs?: number

Defined in: src/coordination/LeaseOptions.ts:18

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

Inherited from

LeaseOptionsType.renewalIntervalMs

---

ttlMs

readonly ttlMs: number

Defined in: src/coordination/LeaseOptions.ts:16

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

Inherited from

LeaseOptionsType.ttlMs