KubeRunner

@webda/kubernetes

---

Class: KubeRunner<T>

Defined in: kubernetes/src/services/kuberunner.service.ts:75

Run a Job on a Kubernetes cluster

Webda Modda

Extends

• Runner<T>

Type Parameters

T

T extends KubeRunnerParameters = KubeRunnerParameters

Constructors

Constructor

new KubeRunner<T>(name, params): KubeRunner<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

KubeRunner<T>

Inherited from

Runner<T>.constructor

Properties

_compiledCapabilities

protected _compiledCapabilities: Record<string, any>

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

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

Runner._compiledCapabilities

---

[WEBDA_EVENTS]

[WEBDA_EVENTS]: object

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

Set the Webda events here

Inherited from

Runner.[WEBDA_EVENTS]

---

client

client: KubernetesObjectApi

Defined in: kubernetes/src/services/kuberunner.service.ts:76

---

logger

protected logger: Logger

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

Logger with class context

Inherited from

Runner.logger

---

metrics?

protected optional metrics?: object

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

Get metrics

Inherited from

Runner.metrics

---

name

readonly name: string

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

Inherited from

Runner.name

---

parameters

readonly parameters: T

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

Inherited from

Runner.parameters

---

createConfiguration?

static optional createConfiguration?: (params) => any

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

Create configuration set by the application on load

Parameters

params

any

Returns

any

Inherited from

Runner.createConfiguration

---

filterConfiguration?

static optional filterConfiguration?: (params) => any

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

Create configuration set by the application on load

Parameters

params

any

Returns

any

Inherited from

Runner.filterConfiguration

---

Parameters

static Parameters: typeof ServiceParameters

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

Service parameters

Inherited from

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

Runner.__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

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

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

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

Runner.computeParameters

---

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

Runner.emit

---

getCapabilities()

getCapabilities(): Record<string, any>

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

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

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

Runner.getClientEvents

---

getMaxListeners()

getMaxListeners(): number

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

Returns

number

Inherited from

Runner.getMaxListeners

---

getMetric()

getMetric<T>(type, configuration): T

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

Add service name label

Type Parameters

T

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

Parameters

type

CustomConstructor<T, [MetricConfiguration<T>]>

the type to look up

configuration

MetricConfiguration<T>

the configuration

Returns

T

the result

Inherited from

Runner.getMetric

---

getName()

getName(): string

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

Get service name

Returns

string

the result string

Inherited from

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

Runner.getOpenApiReplacements

---

getOperationId()

getOperationId(id): string

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

the result

Inherited from

Runner.getOperationId

---

getParameters()

getParameters(): T

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

Get the service parameters

Returns

T

the result

Inherited from

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

Runner.getService

---

getState()

getState(): ServiceStates

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

Get the current state

Returns

ServiceStates

the result

Inherited from

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

Runner.getUrl

---

handleType()

handleType(type): boolean

Defined in: async/lib/services/runner.service.d.ts:45

Handle this type of action

Parameters

type

string

the action type

Returns

boolean

true if the runner handles it

Inherited from

Runner.handleType

---

init()

abstract init(): Promise<KubeRunner<T>>

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

Will be called after all the Services are created

Returns

Promise<KubeRunner<T>>

Inherited from

Runner.init

---

initMetrics()

initMetrics(): void

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

Init the metrics

Returns

void

Inherited from

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

Runner.initOperations

---

launchAction()

launchAction(_action, info): Promise<KubeJobReference>

Defined in: kubernetes/src/services/kuberunner.service.ts:84

Parameters

_action

AsyncAction

the action to launch

info

JobInfo

the job information

Returns

Promise<KubeJobReference>

the created job reference

Inherit Doc

Overrides

Runner.launchAction

---

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

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

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

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

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

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

Runner.once

---

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

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

Runner.removeListener

---

resolve()

resolve(): this

Defined in: kubernetes/src/services/kuberunner.service.ts:112

Returns

this

this

Inherit Doc

Overrides

Runner.resolve

---

setMaxListeners()

setMaxListeners(n): this

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

Parameters

n

number

Returns

this

Inherited from

Runner.setMaxListeners

---

stop()

stop(): Promise<void>

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

Shutdown the current service if action need to be taken

Returns

Promise<void>

Inherited from

Runner.stop

---

toJSON()

toJSON(): string

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

Prevent service to be serialized

Returns

string

the result

Inherited from

Runner.toJSON

---

toString()

toString(): string

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

Return service representation

Returns

string

the result

Inherited from

Runner.toString

---

getAgentInfo()

static getAgentInfo(): AgentInfo

Defined in: async/lib/services/runner.service.d.ts:50

Return agent information

Returns

AgentInfo

the agent information

Inherited from

Runner.getAgentInfo