OpenSearch Prometheus Index Alert 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/promIndexAlerts/items
Configures the index alert monitoring the function of index state management.
| 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 Prometheus Index Alert)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| prefix | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| alertSizeMB | number |
Optional | cannot be null | Compliant Kubernetes Apps Config |
prefix¶
prefix
-
is optional
-
Type:
string(OpenSearch Index Prefix) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (OpenSearch Index Prefix)
alertSizeMB¶
alertSizeMB
-
is optional
-
Type:
number(OpenSearch Index Alert Size) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
number (OpenSearch Index Alert Size)
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main