OpenSearch Master Node 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/masterNode

Configures the main stateful set of OpenSearch that takes on all roles not provided by other nodes (dataNode, clientNode).

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 Master Node)

PROPERTIES:

Property	Type	Required	Nullable	Defined by
count	`number`	Optional	cannot be null	Compliant Kubernetes Apps Config
javaOpts	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
storageClass	`string`	Optional	can be null	Compliant Kubernetes Apps Config
storageSize	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
resources	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config
nodeSelector	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config
tolerations	`array`	Optional	cannot be null	Compliant Kubernetes Apps Config
affinity	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config

count¶

count

is optional
Type: number (OpenSearch Master Node Replicas)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

number (OpenSearch Master Node Replicas)

DEFAULTS:

The default value is:

javaOpts¶

Set Java Virtual Machine Options to control the memory allocation of OpenSearch.

As a rule of thumb the minimum allocation -Xms and maximum allocation -Xmx arguments should be the same to be more predictable. Additionally until memory allocation is at 2 GiB and more it is recommended that the memory limit set in Kubernetes is twice the allocation as OpenSearch uses this for cache.

javaOpts

is optional
Type: string (OpenSearch Node Java Options)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string (OpenSearch Node Java Options)

DEFAULTS:

The default value is:

"-Xms512m -Xmx512m"

storageClass¶

Set storage class for OpenSearch.

If set to null, the default storage class will be used to provision the volumes.
If set to -, no storage class will be used to provision the volumes.

storageClass

is optional
Type: string (OpenSearch Node Storage Class)
can be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string (OpenSearch Node Storage Class)

storageSize¶

Configure the requested size of the persistent volume for this OpenSerch node.

storageSize

is optional
Type: string (OpenSearch Node Storage Size)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string (OpenSearch Node Storage Size)

DEFAULTS:

The default value is:

"8Gi"

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: Compliant Kubernetes Apps Config

TYPE:

object (Kubernetes Resource Requirements)

EXAMPLES:

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

nodeSelector¶

Kubernetes node selector

Kubernetes assign pod node

nodeSelector

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

TYPE:

object (Kubernetes Node Selector)

EXAMPLES:

kubernetes.io/os: linux

tolerations¶

Kubernetes Tolerations

Kubernetes taint and toleration

tolerations

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

TYPE:

an array of merged types (Details)

affinity¶

Affinity is a group of affinity scheduling rules.

affinity

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

TYPE:

object (Affinity)

Return to the root config schema

Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main