Skip to content

OpenSearch Node Schema

Note

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

Return to the root config schema

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

Definitions for OpenSearch nodes.

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

TYPE:

object (OpenSearch Node)

PROPERTIES:

Property Type Required Nullable Defined by
javaOpts string Optional cannot be null Welkin Apps Config
storageClass string Optional can be null Welkin Apps Config
storageSize string Optional cannot be null Welkin Apps Config

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

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

TYPE:

string (OpenSearch Node Storage Class)

storageSize

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

storageSize

TYPE:

string (OpenSearch Node Storage Size)

Return to the root config schema

Generated Sun Nov 17 03:51:36 UTC 2024 from elastisys/compliantkubernetes-apps@main