Skip to content

Latest commit

 

History

History

opensearch-single

README.md

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

Prometheus Operator is necessary since we configure a ServiceMonitor to make some metrics available from OpenSearch on prometheus

Image repository and tag

Configuration

Fury distribution OpenSearch Single is deployed with the following configuration:

  • Single node
  • Listens on port 9200 for client connections
  • Resource limits are 2000m for CPU and 4G for memory
  • Requires 30Gi storage
  • 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 YELLOW state because of the single replica.

License

For license details please see LICENSE