KubernetesOperator

@webda/kubernetes

---

Class: KubernetesOperator<T>

Defined in: kubernetes/src/operator/operator.service.ts:134

Reconcile models stored as Kubernetes custom resources

For each model, the operator watches its resources and calls reconcile() of the objects whose spec changed, on resync and after a failure (exponential backoff); it writes status.observedGeneration and a Ready condition. With a finalizer, finalize() is called before an object is deleted. With leader election, only the replica holding the Lease reconciles.

Exposes the webda kubernetes operator command

Webda Modda

Extends

• Service<T>

Type Parameters

T

T extends KubernetesOperatorParameters = KubernetesOperatorParameters

Constructors

Constructor

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

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

Service

Parameters

name

string

The name of the service

params

T

The parameters block define in the configuration file

Returns

KubernetesOperator<T>

Inherited from

Service<T>.constructor

Properties

_compiledCapabilities

protected _compiledCapabilities: Record<string, any>

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

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

Service._compiledCapabilities

---

[WEBDA_EVENTS]

[WEBDA_EVENTS]: object

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

Set the Webda events here

Inherited from

Service.[WEBDA_EVENTS]

---

controllers

protected controllers: ModelController[] = []

Defined in: kubernetes/src/operator/operator.service.ts:137

---

elector?

protected optional elector?: LeaderElector

Defined in: kubernetes/src/operator/operator.service.ts:138

---

logger

protected logger: Logger

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

Logger with class context

Inherited from

Service.logger

---

metrics

metrics: object

Defined in: kubernetes/src/operator/operator.service.ts:139

Get metrics

queue_depth

queue_depth: Gauge

reconcile_duration

reconcile_duration: Histogram

reconcile_total

reconcile_total: Counter

Overrides

KubeRunner.metrics

---

name

readonly name: string

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

Inherited from

Service.name

---

parameters

readonly parameters: T

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

Inherited from

Service.parameters

---

createConfiguration?

static optional createConfiguration?: (params) => any

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

Create configuration set by the application on load

Parameters

params

any

Returns

any

Inherited from

Service.createConfiguration

---

filterConfiguration?

static optional filterConfiguration?: (params) => any

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

Create configuration set by the application on load

Parameters

params

any

Returns

any

Inherited from

Service.filterConfiguration

---

Parameters

static Parameters: typeof ServiceParameters

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

Service parameters

Inherited from

Service.Parameters

Methods

__clean()

abstract __clean(): Promise<void>

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

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

Returns

Promise<void>

Inherited from

Service.__clean

---

addListener()

addListener<Key>(eventName, listener): this

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

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

Service.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

Service.addRoute

---

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

Service.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

Service.computeParameters

---

createControllers()

protected createControllers(): ModelController[]

Defined in: kubernetes/src/operator/operator.service.ts:193

Controllers of the models

Returns

ModelController[]

one controller per model

Throws

Error when a model is not reconcilable

---

emit()

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

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

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

Service.emit

---

getCapabilities()

getCapabilities(): Record<string, any>

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

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

Service.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

Service.getClientEvents

---

getLeaseName()

getLeaseName(): string

Defined in: kubernetes/src/operator/operator.service.ts:218

Returns

string

the name of the leader election Lease

---

getLeaseNamespace()

getLeaseNamespace(): string

Defined in: kubernetes/src/operator/operator.service.ts:225

Returns

string

the namespace of the leader election Lease: the parameter, else the namespace of the first model's store

---

getMaxListeners()

getMaxListeners(): number

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

Returns

number

Inherited from

Service.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

Service.getMetric

---

getName()

getName(): string

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

Get service name

Returns

string

the result string

Inherited from

Service.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

Service.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

Service.getOperationId

---

getParameters()

getParameters(): T

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

Get the service parameters

Returns

T

the result

Inherited from

Service.getParameters

---

getRbacGrants()

getRbacGrants(): RbacGrant[]

Defined in: kubernetes/src/operator/operator.service.ts:237

Rights the operator needs besides the ones of the stores of its models

Returns

RbacGrant[]

the rights on the leader election Lease

---

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

Service.getService

---

getState()

getState(): ServiceStates

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

Get the current state

Returns

ServiceStates

the result

Inherited from

Service.getState

---

getStore()

protected getStore(model): KubernetesStore

Defined in: kubernetes/src/operator/operator.service.ts:171

Store of a model: the KubernetesStore handling it closest

Parameters

model

ModelClass

the model

Returns

KubernetesStore

the store

Throws

Error when no KubernetesStore stores the model

---

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

Service.getUrl

---

init()

init(): Promise<KubernetesOperator<T>>

Defined in: kubernetes/src/operator/operator.service.ts:248

Returns

Promise<KubernetesOperator<T>>

Overrides

Service.init

---

initMetrics()

initMetrics(): void

Defined in: kubernetes/src/operator/operator.service.ts:146

Returns

void

Overrides

Service.initMetrics

---

initOperations()

initOperations(): void

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

Init the operations from

Returns

void

Operation

decorators on this service

Inherited from

Service.initOperations

---

listeners()

listeners(eventName): Function[]

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

Get all listeners for an event

Parameters

eventName

never

the event name

Returns

Function[]

the list of results

Inherited from

Service.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

Service.loadCapabilities

---

log()

log(level, ...args): void

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

Parameters

level

WorkerLogLevel

to log

args

...any[]

additional arguments

Returns

void

Inherited from

Service.log

---

off()

off<Key>(eventName, listener): this

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

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

Service.off

---

on()

on<Key>(eventName, listener): this

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

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

Service.on

---

once()

once<Key>(eventName, listener): this

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

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

Service.once

---

operator()

operator(): CancelablePromise<void>

Defined in: kubernetes/src/operator/operator.service.ts:322

Run the operator until stopped

Returns

CancelablePromise<void>

a cancelable promise

---

removeAllListeners()

removeAllListeners<Key>(eventName?): this

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

Type Parameters

Key

Key extends never

Parameters

eventName?

Key

the event name

Returns

this

this for chaining

See

EventEmitter.removeAllListeners

Inherited from

Service.removeAllListeners

---

removeListener()

removeListener<Key>(eventName, listener): this

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

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

Service.removeListener

---

resolve()

resolve(): this

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

Resolve parameters and load metadata. @Route-declared routes are scanned and registered by Router.discoverRoutes(services) from Core.init() once every service has resolved — nothing to do per-service here.

Returns

this

the result

Inherited from

Service.resolve

---

setMaxListeners()

setMaxListeners(n): this

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

Parameters

n

number

Returns

this

Inherited from

Service.setMaxListeners

---

start()

start(): Promise<void>

Defined in: kubernetes/src/operator/operator.service.ts:260

Start reconciling, on the leader only with leader election

Returns

Promise<void>

once the controllers started, or the candidate made its first attempt

---

startControllers()

protected startControllers(): Promise<void>

Defined in: kubernetes/src/operator/operator.service.ts:306

Start every controller

Returns

Promise<void>

---

stop()

stop(): Promise<void>

Defined in: kubernetes/src/operator/operator.service.ts:294

Stop reconciling and release the Lease

Returns

Promise<void>

Overrides

Service.stop

---

stopControllers()

protected stopControllers(): Promise<void>

Defined in: kubernetes/src/operator/operator.service.ts:313

Stop every controller

Returns

Promise<void>

---

toJSON()

toJSON(): string

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

Prevent service to be serialized

Returns

string

the result

Inherited from

Service.toJSON

---

toString()

toString(): string

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

Return service representation

Returns

string

the result

Inherited from

Service.toString