OpenSearch Dashboards Schema¶

Note

This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.

https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/opensearch/properties/dashboards

Configures the Dashboards deployment of OpenSearch providing the UI to view and query logs.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Forbidden	none	config/schemas/config.yaml*

TYPE:

object (OpenSearch Dashboards)

PROPERTIES:

Property	Type	Required	Nullable	Defined by
subdomain	`string`	Optional	cannot be null	Welkin Apps Config
resources	`object`	Optional	cannot be null	Welkin Apps Config
tolerations	`array`	Optional	cannot be null	Welkin Apps Config
topologySpreadConstraints	`array`	Optional	cannot be null	Welkin Apps Config
nodeSelector	`object`	Optional	cannot be null	Welkin Apps Config
affinity	`object`	Optional	cannot be null	Welkin Apps Config
cookieTtl	`integer`	Optional	cannot be null	Welkin Apps Config
sessionTtl	`integer`	Optional	cannot be null	Welkin Apps Config
sessionKeepalive	`boolean`	Optional	cannot be null	Welkin Apps Config

subdomain¶

Subdomain of baseDomain that the Ingress to OpenSearch Dashboards will be created with.

Note

Must be set for both service and workload cluster.

subdomain

is optional
Type: string (OpenSearch Dashboards Subdomain)
cannot be null
defined in: Welkin Apps Config

TYPE:

string (OpenSearch Dashboards Subdomain)

DEFAULTS:

The default value is:

"opensearch"

resources¶

Resource requests are used by the kube-scheduler to pick a node to schedule pods on.

Limits are enforced. Resources are commonly 'cpu' and 'memory'.

resources

is optional
Type: object (Kubernetes Resource Requirements)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Kubernetes Resource Requirements)

EXAMPLES:

requests:
  memory: 128Mi
  cpu: 100m
limits:
  memory: 256Mi
  cpu: 250m

tolerations¶

Kubernetes Tolerations

Kubernetes taint and toleration

tolerations

is optional
Type: an array of merged types (Details)
cannot be null
defined in: Welkin Apps Config

TYPE:

an array of merged types (Details)

topologySpreadConstraints¶

TopologySpreadConstraints describes how pods should spread across topology domains.

topologySpreadConstraints

is optional
Type: an array of merged types (Details)
cannot be null
defined in: Welkin Apps Config

TYPE:

an array of merged types (Details)

nodeSelector¶

Kubernetes node selector

Kubernetes assign pod node

nodeSelector

is optional
Type: object (Kubernetes Node Selector)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Kubernetes Node Selector)

EXAMPLES:

kubernetes.io/os: linux

affinity¶

Affinity is a group of affinity scheduling rules.

affinity

is optional
Type: object (Affinity)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Affinity)

cookieTtl¶

Time-to-live for the session cookie in milliseconds. Overrides OpenSearch Dashboards internal default if set.

cookieTtl

is optional
Type: integer (OpenSearch Dashboards Cookie TTL)
cannot be null
defined in: Welkin Apps Config

TYPE:

integer (OpenSearch Dashboards Cookie TTL)

sessionTtl¶

Time-to-live for the session itself in milliseconds. Overrides OpenSearch Dashboards internal default if set.

sessionTtl

is optional
Type: integer (OpenSearch Dashboards Session TTL)
cannot be null
defined in: Welkin Apps Config

TYPE:

integer (OpenSearch Dashboards Session TTL)

sessionKeepalive¶

Whether the session TTL should be extended upon user activity. Overrides OpenSearch Dashboards internal default if set.

sessionKeepalive

is optional
Type: boolean (OpenSearch Dashboards Session Keepalive)
cannot be null
defined in: Welkin Apps Config

TYPE:

boolean (OpenSearch Dashboards Session Keepalive)

Return to the root config schema

Generated Thu Jun 19 08:36:53 UTC 2025 from elastisys/compliantkubernetes-apps@main