OpenSearch Index State Management 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/properties/ism
Configures index state management in OpenSearch.
| 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 Index State Management)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| defaultPolicies | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| overwritePolicies | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| additionalPolicies | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| rolloverAgeDays | number |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| rolloverSizeGB | number |
Optional | cannot be null | Compliant Kubernetes Apps Config |
defaultPolicies¶
When enabled OpenSearch will be configured with the default index state management policies for:
authlogkubeauditkubernetesother
defaultPolicies
-
is optional
-
Type:
boolean(OpenSearch Default Policies) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (OpenSearch Default Policies)
DEFAULTS:
The default value is:
true
overwritePolicies¶
When set OpenSearch can be configured with index state management policies via additionalPolicies that overwrite the ones configured via defaultPolicies.
overwritePolicies
-
is optional
-
Type:
boolean(OpenSearch Overwrite Policies) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (OpenSearch Overwrite Policies)
DEFAULTS:
The default value is:
true
additionalPolicies¶
When set OpenSearch will be configured with additional index state management policies.
The keys will be used as the name of the index state management policy.
Note
See the upstream documentation for reference.
additionalPolicies
-
is optional
-
Type:
object(OpenSearch Additional Policies) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (OpenSearch Additional Policies)
rolloverAgeDays¶
Configures the age a write index must reach before it is rolled over to a new one.
rolloverAgeDays
-
is optional
-
Type:
number(OpenSearch Rollover Age Days) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
number (OpenSearch Rollover Age Days)
DEFAULTS:
The default value is:
1
rolloverSizeGB¶
Configures the size a write index must reach before it is rolled over to a new one.
rolloverSizeGB
-
is optional
-
Type:
number(OpenSearch Rollover Size GB) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
number (OpenSearch Rollover Size GB)
DEFAULTS:
The default value is:
1
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main