Skip to main content

KubernetesClusterService

@webda/kubernetes

Class: KubernetesClusterService<T>

Defined in: kubernetes/src/services/cluster.service.ts:55

Leader election on a coordination.k8s.io Lease named leaseName

The service account needs get, create and update on leases in the namespace.

Webda Modda​

Extends​

  • ClusterService<T>

Type Parameters​

T​

T extends KubernetesClusterServiceParameters = KubernetesClusterServiceParameters

Constructors​

Constructor​

new KubernetesClusterService<T>(name, params): KubernetesClusterService<T>

Defined in: core/lib/services/service.d.ts:72

Create a new Service instance

Service

Parameters​

name​

string

The name of the service

params​

T

The parameters block define in the configuration file

Returns​

KubernetesClusterService<T>

Inherited from​

ClusterService<T>.constructor

Properties​

_compiledCapabilities​

protected _compiledCapabilities: Record<string, any>

Defined in: core/lib/services/iservice.d.ts:50

Capabilities detected at compile-time from @WebdaCapability-tagged interfaces.

Populated during Service.resolve by reading the service's entry in webda.module.json. Each key is a capability name (e.g., "request-filter"), and the value is an empty object {} by default. Override getCapabilities to provide capability-specific configuration or to conditionally disable capabilities.

See​

getCapabilities

Inherited from​

ClusterService._compiledCapabilities

[WEBDA_EVENTS]​

[WEBDA_EVENTS]: object

Defined in: core/lib/services/service.d.ts:50

Set the Webda events here

Inherited from​

ClusterService.[WEBDA_EVENTS]

deadlineTimer?​

protected optional deadlineTimer?: Timeout

Defined in: core/lib/services/cluster.service.d.ts:135

Step down when no attempt succeeded before the deadline

Inherited from​

ClusterService.deadlineTimer

elector?​

protected optional elector?: LeaderElector

Defined in: kubernetes/src/services/cluster.service.ts:64

Lease logic, the election loop is the one of ClusterService

leading​

protected leading: boolean

Defined in: core/lib/services/cluster.service.d.ts:129

Whether this instance holds the lease

Inherited from​

ClusterService.leading

logger​

protected logger: Logger

Defined in: core/lib/services/service.d.ts:59

Logger with class context

Inherited from​

ClusterService.logger

metrics?​

protected optional metrics?: object

Defined in: core/lib/services/service.d.ts:63

Get metrics

Inherited from​

KnativeDeployer.metrics

name​

readonly name: string

Defined in: core/lib/services/iservice.d.ts:27

Name

Inherited from​

ClusterService.name

parameters​

readonly parameters: T

Defined in: core/lib/services/iservice.d.ts:31

Parameters

Inherited from​

ClusterService.parameters

registrations​

protected registrations: LeaderRegistrations

Defined in: core/lib/services/cluster.service.d.ts:137

whenLeader registrations

Inherited from​

ClusterService.registrations

running​

protected running: boolean

Defined in: core/lib/services/cluster.service.d.ts:131

Whether the election loop runs

Inherited from​

ClusterService.running

timer?​

protected optional timer?: Timeout

Defined in: core/lib/services/cluster.service.d.ts:133

Next attempt

Inherited from​

ClusterService.timer

createConfiguration?​

static optional createConfiguration?: (params) => any

Defined in: core/lib/services/iservice.d.ts:35

Create configuration set by the application on load

Parameters​

params​

any

Returns​

any

Inherited from​

ClusterService.createConfiguration

filterConfiguration?​

static optional filterConfiguration?: (params) => any

Defined in: core/lib/services/iservice.d.ts:39

Create configuration set by the application on load

Parameters​

params​

any

Returns​

any

Inherited from​

ClusterService.filterConfiguration

Parameters​

static Parameters: typeof KubernetesClusterServiceParameters = KubernetesClusterServiceParameters

Defined in: kubernetes/src/services/cluster.service.ts:61

Parameters

Overrides​

ClusterService.Parameters

Methods​

__clean()​

abstract __clean(): Promise<void>

Defined in: core/lib/services/service.d.ts:224

Clean the service data, can only be used in test mode

Returns​

Promise<void>

Inherited from​

ClusterService.__clean

acquireOrRenew()​

protected acquireOrRenew(): Promise<boolean>

Defined in: kubernetes/src/services/cluster.service.ts:87

Returns​

Promise<boolean>

Overrides​

ClusterService.acquireOrRenew

addListener()​

addListener<Key>(eventName, listener): this

Defined in: core/lib/events/asynceventemitter.d.ts:87

Add listener

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void | Promise<void>

the event listener

Returns​

this

this for chaining

See​

EventEmitter.addListener

Inherited from​

ClusterService.addListener

addRoute()​

protected addRoute(url, methods, executer, openapi?, override?): void

Defined in: core/lib/services/service.d.ts:177

Add a route dynamicaly

Parameters​

url​

string

of the route can contains dynamic part like {uuid}

methods​

HttpMethodType[]

the HTTP methods

executer​

Function

Method to execute for this route

openapi?​

OpenAPIWebdaDefinition

the OpenAPI specification

override?​

boolean

whether to override existing

Returns​

void

Inherited from​

ClusterService.addRoute

attempt()​

protected attempt(): Promise<void>

Defined in: core/lib/services/cluster.service.d.ts:173

Acquire or renew the lease once, then schedule the next attempt

The callbacks are not awaited: a long fn never delays the renewals.

Returns​

Promise<void>

Inherited from​

ClusterService.attempt

authorizeClientEvent()​

authorizeClientEvent(_event, _context): boolean

Defined in: core/lib/services/service.d.ts:153

Authorize a public event subscription

Parameters​

_event​

string

the event name

_context​

OperationContext

the execution context

Returns​

boolean

true if the condition is met

Inherited from​

ClusterService.authorizeClientEvent

computeParameters()​

computeParameters(): void

Defined in: core/lib/services/service.d.ts:77

Used to compute or derivate input parameter to attribute

Returns​

void

Deprecated​

Inherited from​

ClusterService.computeParameters

emit()​

emit<Key>(event, data): Promise<void>

Defined in: core/lib/services/service.d.ts:213

Emit the event with data and wait for Promise to finish if listener returned a Promise

Type Parameters​

Key​

Key extends never

Parameters​

event​

Key

the event name

data​

object[Key]

the data to process

Returns​

Promise<void>

Inherited from​

ClusterService.emit

getCapabilities()​

getCapabilities(): Record<string, any>

Defined in: core/lib/services/iservice.d.ts:72

Return the capabilities of this service.

By default returns capabilities detected at compile-time from

Returns​

Record<string, any>

the result

Webda Capability-tagged​

interfaces in webda.module.json.

Override to disable capabilities based on configuration:

getCapabilities() {
  const caps = super.getCapabilities();
  if (!this.parameters.enabled) delete caps["request-filter"];
  return caps;
}

Inherited from​

ClusterService.getCapabilities

getClientEvents()​

getClientEvents(): string[]

Defined in: core/lib/services/service.d.ts:144

Return the events that an external system can subscribe to

Returns​

string[]

the list of results

Inherited from​

ClusterService.getClientEvents

getElector()​

protected getElector(): LeaderElector

Defined in: kubernetes/src/services/cluster.service.ts:70

Get the elector of the lease

Returns​

LeaderElector

the elector of the lease

getInstanceId()​

getInstanceId(): string

Defined in: core/lib/services/cluster.service.d.ts:153

Returns​

string

Inherited from​

ClusterService.getInstanceId

getLeadingWindow()​

protected getLeadingWindow(): number

Defined in: core/lib/services/cluster.service.d.ts:179

Get milliseconds after the start of a successful attempt during which this instance leads:

Returns​

number

milliseconds after the start of a successful attempt during which this instance leads: (leaseDuration + renewInterval) / 2, between the next attempt and the expiry of the lease

Inherited from​

ClusterService.getLeadingWindow

getMaxListeners()​

getMaxListeners(): number

Defined in: core/lib/events/asynceventemitter.d.ts:91

Returns​

number

Inherited from​

ClusterService.getMaxListeners

getMetric()​

getMetric<T>(type, configuration): T

Defined in: core/lib/services/service.d.ts:138

Add service name label

Type Parameters​

T​

T = Counter<string> | Histogram<string> | Gauge<string>

Parameters​

type​

CustomConstructor<T, [MetricConfiguration<T>]>

the type to look up

configuration​

MetricConfiguration<T>

the configuration

Returns​

T

the result

Inherited from​

ClusterService.getMetric

getName()​

getName(): string

Defined in: core/lib/services/service.d.ts:218

Get service name

Returns​

string

the result string

Inherited from​

ClusterService.getName

getOpenApiReplacements()​

getOpenApiReplacements(): any

Defined in: core/lib/services/service.d.ts:182

Return variables for replacement in openapi

Returns​

any

the result

Inherited from​

ClusterService.getOpenApiReplacements

getOperationId()​

getOperationId(id): string | undefined

Defined in: core/lib/services/service.d.ts:167

If undefined is returned it cancel the operation registration

Parameters​

id​

string

the identifier

Returns​

string | undefined

the result

Inherited from​

ClusterService.getOperationId

getParameters()​

getParameters(): T

Defined in: core/lib/services/service.d.ts:82

Get the service parameters

Returns​

T

the result

Inherited from​

ClusterService.getParameters

getService()​

getService<T>(name): ServicesMap[T]

Defined in: core/lib/services/service.d.ts:131

Get a service by name

Type Parameters​

T​

T extends keyof ServicesMap

Parameters​

name​

T

the name to use

Returns​

ServicesMap[T]

the result map

Deprecated​

Use useService, might reconsider

Inherited from​

ClusterService.getService

getState()​

getState(): ServiceStates

Defined in: core/lib/services/service.d.ts:55

Get the current state

Returns​

ServiceStates

the result

Inherited from​

ClusterService.getState

getUrl()​

getUrl(url, _methods): string

Defined in: core/lib/services/service.d.ts:161

Return the full path url based on parameters

Parameters​

url​

string

relative url to service

_methods​

HttpMethodType[]

in case we need filtering (like Store)

Returns​

string

absolute url or undefined if need to skip the Route

Inherited from​

ClusterService.getUrl

init()​

init(): Promise<KubernetesClusterService<T>>

Defined in: core/lib/services/cluster.service.d.ts:163

Start the election loop

Returns​

Promise<KubernetesClusterService<T>>

once the first attempt is done

Inherited from​

ClusterService.init

initMetrics()​

initMetrics(): void

Defined in: core/lib/services/service.d.ts:124

Init the metrics

Returns​

void

Inherited from​

ClusterService.initMetrics

initOperations()​

initOperations(): void

Defined in: core/lib/services/service.d.ts:195

Init the operations from

Returns​

void

Operation​

decorators on this service

Inherited from​

ClusterService.initOperations

isLeader()​

isLeader(): boolean

Defined in: core/lib/services/cluster.service.d.ts:151

Returns​

boolean

Inherited from​

ClusterService.isLeader

listeners()​

listeners(eventName): Function[]

Defined in: core/lib/events/asynceventemitter.d.ts:151

Get all listeners for an event

Parameters​

eventName​

never

the event name

Returns​

Function[]

the list of results

Inherited from​

ClusterService.listeners

loadCapabilities()​

protected loadCapabilities(): void

Defined in: core/lib/services/service.d.ts:120

Load capabilities from webda.module.json metadata into _compiledCapabilities.

Called during resolve after dependency injection. Reads the service's type name from parameters, looks it up in the application's module metadata (moddas or beans section), and populates _compiledCapabilities with an empty object for each declared capability name.

Fails silently if the application is not available (e.g., in unit tests where services are instantiated without a full application context).

Returns​

void

Example​

// If webda.module.json contains:
// { "moddas": { "MyApp/HawkService": { "capabilities": ["request-filter", "cors-filter"] } } }
// Then after resolve(), this.getCapabilities() returns:
// { "request-filter": {}, "cors-filter": {} }

See​

getCapabilities

Inherited from​

ClusterService.loadCapabilities

log()​

log(level, ...args): void

Defined in: core/lib/services/service.d.ts:236

Log operation

Parameters​

level​

WorkerLogLevel

to log

args​

...any[]

additional arguments

Returns​

void

Inherited from​

ClusterService.log

off()​

off<Key>(eventName, listener): this

Defined in: core/lib/events/asynceventemitter.d.ts:127

Perform off

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.off

Inherited from​

ClusterService.off

on()​

on<Key>(eventName, listener): this

Defined in: core/lib/events/asynceventemitter.d.ts:111

Perform on

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.once

Inherited from​

ClusterService.on

once()​

once<Key>(eventName, listener): this

Defined in: core/lib/events/asynceventemitter.d.ts:103

Perform once

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.once

Inherited from​

ClusterService.once

operationSchemaName()​

protected operationSchemaName(method, side): string

Defined in: core/lib/services/service.d.ts:191

Schema of an operation side: <service name>.<method>.<side> when the application knows it, else the one the build writes, <class>.<method>.<side>, for the class or its nearest ancestor that has it (a service configured under another name than its class)

Parameters​

method​

string

the method name

side​

"input" | "output"

input or output

Returns​

string

the schema name

Inherited from​

ClusterService.operationSchemaName

release()​

protected release(): Promise<void>

Defined in: kubernetes/src/services/cluster.service.ts:92

Returns​

Promise<void>

Overrides​

ClusterService.release

removeAllListeners()​

removeAllListeners<Key>(eventName?): this

Defined in: core/lib/events/asynceventemitter.d.ts:134

Remove all listeners

Type Parameters​

Key​

Key extends never

Parameters​

eventName?​

Key

the event name

Returns​

this

this for chaining

See​

EventEmitter.removeAllListeners

Inherited from​

ClusterService.removeAllListeners

removeListener()​

removeListener<Key>(eventName, listener): this

Defined in: core/lib/events/asynceventemitter.d.ts:119

Remove listener

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.removeListener

Inherited from​

ClusterService.removeListener

resolve()​

resolve(): this

Defined in: core/lib/services/cluster.service.d.ts:158

Adopt the free whenLeader registrations made before this service was created

Returns​

this

this

Inherited from​

ClusterService.resolve

setLeading()​

protected setLeading(leading): Promise<void>

Defined in: core/lib/services/cluster.service.d.ts:191

Change the leadership, running the callbacks of the registrations

Parameters​

leading​

boolean

whether this instance leads

Returns​

Promise<void>

once the callbacks settled

Inherited from​

ClusterService.setLeading

setMaxListeners()​

setMaxListeners(n): this

Defined in: core/lib/events/asynceventemitter.d.ts:95

Parameters​

n​

number

Returns​

this

Inherited from​

ClusterService.setMaxListeners

stop()​

stop(): Promise<void>

Defined in: core/lib/services/cluster.service.d.ts:167

Stop the election loop, release the lease when held and call the deregisteredFns

Returns​

Promise<void>

Inherited from​

ClusterService.stop

toJSON()​

toJSON(): string

Defined in: core/lib/services/service.d.ts:200

Prevent service to be serialized

Returns​

string

the result

Inherited from​

ClusterService.toJSON

toString()​

toString(): string

Defined in: core/lib/services/service.d.ts:91

Return service representation

Returns​

string

the result

Inherited from​

ClusterService.toString

whenLeader()​

whenLeader(fn, deregisteredFn?): () => void

Defined in: core/lib/services/cluster.service.d.ts:149

Parameters​

fn​

LeaderCallback

deregisteredFn?​

LeaderCallback

Returns​

() => void

Inherited from​

ClusterService.whenLeader

withTimeout()​

protected withTimeout<R>(attempt): Promise<R>

Defined in: core/lib/services/cluster.service.d.ts:185

Fail an attempt that does not answer within leaseDuration - renewInterval

Type Parameters​

R​

R

Parameters​

attempt​

Promise<R>

the attempt

Returns​

Promise<R>

its result

Inherited from​

ClusterService.withTimeout