OpenSearch Curator Retention 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/curator/properties/retention/items
Configures the retention of indices 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 Curator Retention)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| pattern | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| ageDays | number |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| sizeGB | number |
Optional | cannot be null | Compliant Kubernetes Apps Config |
pattern¶
pattern
-
is optional
-
Type:
string(OpenSearch Curator Index Pattern) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (OpenSearch Curator Index Pattern)
ageDays¶
ageDays
-
is optional
-
Type:
number(OpenSearch Curator Index Age Days) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
number (OpenSearch Curator Index Age Days)
sizeGB¶
Note
This is evaluated against the entire index pattern.
sizeGB
-
is optional
-
Type:
number(OpenSearch Curator Index Pattern Size GB) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
number (OpenSearch Curator Index Pattern Size GB)
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main