Skip to main content

KubernetesClusterServiceParameters

@webda/kubernetes

Class: KubernetesClusterServiceParameters

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

KubernetesClusterService parameters

Extends​

  • ClusterServiceParameters

Implements​

Constructors​

Constructor​

new KubernetesClusterServiceParameters(): KubernetesClusterServiceParameters

Returns​

KubernetesClusterServiceParameters

Inherited from​

ClusterServiceParameters.constructor

Properties​

config?​

optional config?: string | K8sConfiguration

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

Kubernetes configuration, the pod's service account or the local kubeconfig when unset

Can be encrypted with webda config encrypt

Secret​

users.token,users.password,users.keyData,users.authProvider

Implementation of​

KubernetesParameters.config

context?​

optional context?: string

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

Kubernetes context to use

Implementation of​

KubernetesParameters.context

instanceId?​

optional instanceId?: string

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

Identity of this instance, unique per process: defaults to <HOSTNAME or hostname()>-<pid>-<random>

Inherited from​

ClusterServiceParameters.instanceId

leaseDuration​

leaseDuration: number

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

Milliseconds a lease is valid without renewal

Default​

15000

Inherited from​

ClusterServiceParameters.leaseDuration

leaseName​

leaseName: string

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

Name of the lease

Default​

"leader"

Inherited from​

ClusterServiceParameters.leaseName

namespace?​

optional namespace?: string

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

Namespace of the Lease, defaults to POD_NAMESPACE, else the namespace of the pod's service account, else default

renewInterval​

renewInterval: number

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

Milliseconds between two attempts to acquire or renew the lease, lower than leaseDuration

Default​

5000

Inherited from​

ClusterServiceParameters.renewInterval

timeout?​

optional timeout?: number

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

Milliseconds before a request to the Kubernetes API is aborted, no timeout when unset

Implementation of​

KubernetesParameters.timeout

type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

ClusterServiceParameters.type

Methods​

load()​

load(params?): this

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

Load operation

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this

Overrides​

ClusterServiceParameters.load

update()​

update(params, delta): this

Defined in: core/lib/application/parameters.d.ts:21

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ClusterServiceParameters.update

with()​

with(callback): this

Defined in: core/lib/application/parameters.d.ts:27

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ClusterServiceParameters.with