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/v0.41.0/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 | Compliant Kubernetes Apps Config |
storageClass | string |
Optional | can be null | Compliant Kubernetes Apps Config |
storageSize | string |
Optional | cannot be null | Compliant Kubernetes 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
-
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)
Return to the root config schema
Generated Thu Nov 14 16:21:55 UTC 2024 from elastisys/compliantkubernetes-apps@v0.41.0