OpenSearch Single
OpenSearch is an open-source distributed search and analytics engine used for log analytics. This package deploys a single node OpenSearch cluster on Kubernetes.
â ī¸ Please note that the OpenSearch Single variant is not intended for production use. Please use opensearch-triple, the high-availability version, for production.
Requirementsâ
- Kubernetes >= 1.24.0
- Kustomize = v3.10.0
- prometheus-operator
Prometheus Operator is necessary since we configure a
ServiceMonitorto make some metrics available fromOpenSearchon prometheus
Image repository and tagâ
- OpenSearch image: opensearchproject/opensearch:2.12.0
- OpenSearch repo: OpenSearch on Github
- OpenSearch documentation: OpenSearch Homepage
Configurationâ
Fury distribution OpenSearch Single is deployed with the following configuration:
- Single node
- Listens on port 9200for client connections
- Resource limits are 2000mfor CPU and4Gfor memory
- Requires 30Gistorage
- Prometheus exporter to expose OpenSearch metrics
- Metrics are scraped by Prometheus every 30s
Deploymentâ
You can deploy OpenSearch Single by running the following command in the root of the project:
kustomize build | kubectl apply -f -
Alertsâ
Since we are configuring a ServiceMonitor in this package, the following Prometheus alerts are already defined:
| Alert | Description | Severity | Interval | 
|---|---|---|---|
| OpenSearchClusterRed | This alert fires when the health of the opensearch cluster is RED | critical | 30m | 
| OpenSearchYellow | This alert fires when the health of the opensearch cluster is YELLOW | warning | 30m | 
| OpenSearchOfRelocationShards | This alert fires when there are relocating shards for 30 minutes | warning | 30m | 
| OpenSearchOfInitializingShards | This alert fires when there are initializing shards for 30 minutes | warning | 30m | 
| OpenSearchOfUnassignedShards | This alert fires when there are unassigned shards for 30 minutes | warning | 30m | 
| OpenSearchOfPendingTasks | This alert fires when there pending task for 30 minutes | warning | 30m | 
âšī¸ when using the OpenSearch single variant, the cluster will be in
YELLOWstate because of the single replica.