Skip to main content

KubernetesOperatorParameters

@webda/kubernetes

Class: KubernetesOperatorParameters

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

Kubernetes operator parameters

Extends​

  • ServiceParameters

Implements​

Constructors​

Constructor​

new KubernetesOperatorParameters(): KubernetesOperatorParameters

Returns​

KubernetesOperatorParameters

Inherited from​

ServiceParameters.constructor

Properties​

autoStart?​

optional autoStart?: boolean

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

Start reconciling at init, instead of with webda kubernetes operator

Default​

false

concurrency?​

optional concurrency?: number

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

Objects of a model reconciled at the same time

Default​

1

config?​

optional config?: string | K8sConfiguration

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

Kubernetes configuration for the leader election Lease, the pod's service account or the local kubeconfig when unset (the resources are watched with the configuration of their store)

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/operator/operator.service.ts:38

Kubernetes context to use

Implementation of​

KubernetesParameters.context

finalizer?​

optional finalizer?: string

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

Finalizer added to the objects, e.g. myapp.example.com/finalizer: finalize() is called before they are deleted

leaderElection?​

optional leaderElection?: boolean

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

Run only on the replica holding a coordination.k8s.io Lease

Default​

true

leaseDuration?​

optional leaseDuration?: number

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

Milliseconds a Lease is valid without renewal

Default​

15000

leaseName?​

optional leaseName?: string

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

Name of the Lease, default to webda-operator-<service name>

leaseNamespace?​

optional leaseNamespace?: string

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

Namespace of the Lease, default to the namespace of the first model's store

leaseRetryPeriod?​

optional leaseRetryPeriod?: number

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

Milliseconds between two attempts to acquire or renew the Lease

Default​

5000

maxBackoff?​

optional maxBackoff?: number

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

Maximum milliseconds before reconciling again an object that failed

Default​

300000

maxRetries?​

optional maxRetries?: number

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

Attempts of a status or finalizer write on conflicts

Default​

5

models​

models: string[]

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

Models to reconcile, stored in a KubernetesStore and implementing reconcile()

resyncPeriod?​

optional resyncPeriod?: number

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

Milliseconds between two reconciliations of every object

Default​

300000

timeout?​

optional timeout?: number

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

Milliseconds before a request to the Kubernetes API is aborted

Default​

10000

Implementation of​

KubernetesParameters.timeout

type​

type: string

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

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params?): this

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

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this

Overrides​

ServiceParameters.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​

ServiceParameters.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​

ServiceParameters.with