Skip to main content

KubernetesStoreParameters

@webda/kubernetes

Class: KubernetesStoreParameters

Defined in: kubernetes/src/stores/kubernetesstore.service.ts:33

Kubernetes store parameters

Extends​

  • StoreParameters

Implements​

Constructors​

Constructor​

new KubernetesStoreParameters(): KubernetesStoreParameters

Returns​

KubernetesStoreParameters

Inherited from​

StoreParameters.constructor

Properties​

aggregationFallback?​

optional aggregationFallback?: "allow" | "warn" | "deny"

Defined in: core/lib/stores/store.d.ts:239

What to do when an aggregation on this store cannot run natively and must stream every matching object through memory

Default​

"warn"

Inherited from​

StoreParameters.aggregationFallback

config?​

optional config?: string | K8sConfiguration

Defined in: kubernetes/src/stores/kubernetesstore.service.ts:40

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/stores/kubernetesstore.service.ts:44

Kubernetes context to use

Implementation of​

KubernetesParameters.context

group​

group: string

Defined in: kubernetes/src/stores/kubernetesstore.service.ts:53

API group of the custom resources, e.g. myapp.example.com

installCrds?​

optional installCrds?: boolean

Defined in: kubernetes/src/stores/kubernetesstore.service.ts:82

Create or update the CustomResourceDefinitions at init, needs the rights on customresourcedefinitions.apiextensions.k8s.io

Default​

false

labelFields?​

optional labelFields?: Record<string, string[]>

Defined in: kubernetes/src/stores/kubernetesstore.service.ts:72

Fields mirrored as labels, by model identifier: queries with = or IN on them are filtered by the API server

maxGroups?​

optional maxGroups?: number

Defined in: core/lib/stores/store.d.ts:246

Maximum number of groups an aggregation may produce without LIMIT (or in memory)

Minimum​

1

Default​

10000

Inherited from​

StoreParameters.maxGroups

maxRetries?​

optional maxRetries?: number

Defined in: kubernetes/src/stores/kubernetesstore.service.ts:87

Attempts of a read-modify-write before giving up on conflicts

Default​

5

models?​

optional models?: string[]

Defined in: core/lib/stores/store.d.ts:204

Models managed by this Store.

Default​

["Webda/RegistryEntry"]

Inherited from​

StoreParameters.models

namespace?​

optional namespace?: string

Defined in: kubernetes/src/stores/kubernetesstore.service.ts:63

Namespace of the custom resources, ignored when the scope is Cluster

Default​

"default"

noCache?​

optional noCache?: boolean

Defined in: core/lib/stores/store.d.ts:265

Disable default memory cache

Inherited from​

StoreParameters.noCache

scope?​

optional scope?: "Namespaced" | "Cluster"

Defined in: kubernetes/src/stores/kubernetesstore.service.ts:68

Scope of the custom resources

Default​

"Namespaced"

slowQueryLogLevel?​

optional slowQueryLogLevel?: WorkerLogLevel

Defined in: core/lib/stores/store.d.ts:226

Log level used for slow queries

Default​

"WARN"

Inherited from​

StoreParameters.slowQueryLogLevel

slowQueryMaxLength?​

optional slowQueryMaxLength?: number

Defined in: core/lib/stores/store.d.ts:232

Maximum length of the query string written to logs / events (longer queries are truncated)

Default​

1024

Inherited from​

StoreParameters.slowQueryMaxLength

slowQueryThreshold?​

optional slowQueryThreshold?: number

Defined in: core/lib/stores/store.d.ts:220

Duration in ms above which a query is considered slow. Set to 0 to disable slow query detection.

Default​

30000

Inherited from​

StoreParameters.slowQueryThreshold

statusFields?​

optional statusFields?: Record<string, string[]>

Defined in: kubernetes/src/stores/kubernetesstore.service.ts:76

Fields stored in the status, by model identifier: written through the status subresource

strict?​

optional strict?: boolean

Defined in: core/lib/stores/store.d.ts:213

Allow to load object that does not have the type data

If set to true, then the Store will only managed the defined _model and no model extending this one

Default​

false

Inherited from​

StoreParameters.strict

timeout?​

optional timeout?: number

Defined in: kubernetes/src/stores/kubernetesstore.service.ts:49

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​

StoreParameters.type

typeCheck?​

optional typeCheck?: object

Defined in: core/lib/stores/store.d.ts:250

Startup check of the stored types: one WARN listing the legacy, untyped and unknown types found

enabled?​

optional enabled?: boolean

Default​
true

maxRows?​

optional maxRows?: number

Rows scanned at most by stores without a native count; beyond, the counts are "at least"

Default​
10000

Inherited from​

StoreParameters.typeCheck

version?​

optional version?: string

Defined in: kubernetes/src/stores/kubernetesstore.service.ts:58

API version of the custom resources

Default​

"v1"

watch?​

optional watch?: boolean

Defined in: kubernetes/src/stores/kubernetesstore.service.ts:93

Watch the resources and emit the repository events (Created, Updated, Deleted) of the changes made by others than this process: kubectl, GitOps, another replica

Default​

false

Methods​

load()​

load(params?): this

Defined in: kubernetes/src/stores/kubernetesstore.service.ts:100

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this

Overrides​

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

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

StoreParameters.with