Skip to main content
Skip to main content
🚧 Work in Progress

Elasticsearch

Deploy Elasticsearch instances in Zerops with flexible scaling options, from standalone nodes to highly available clusters.

Supported Versions​

Currently supported Elasticsearch versions:

  • 8.16

Import configuration version:

  • elasticsearch@8.16
 MinimumMaximum
CPU cores18
RAM0.25 GB48 GB
Disk1 GB250 GB

Connection Details​

  • Port: 9200
  • Protocol: HTTP only
  • Internal Access: http://{hostname}:9200
Note

When accessing from another service within the same project, use the service hostname as the connection address.

Configuration Options​

Plugin Management​

You can configure Elasticsearch plugins using a comma-separated list in your environment secrets:

envSecrets:
PLUGINS: "analysis-icu,ingest-attachment"

Plugin Configuration Details:

  • Defines plugins to install at service startup
  • Format: plugin1,plugin2,...
  • Service automatically installs specified plugins during initialization
  • Removing a plugin from this list triggers uninstallation on service restart

JVM Heap Allocation​

Control the JVM heap size as a percentage of container memory:

envSecrets:
HEAP_PERCENT: "75"

Heap Configuration Details:

  • Value represents the percentage of container memory allocated to JVM heap
  • Default: 50% of available container memory
  • Valid range: 1-100
  • To increase available memory, adjust the service's RAM allocation in scaling configuration
Requires Restart

Changes to HEAP_PERCENT require a service restart to take effect.

Backup​

Elasticsearch backups are created using elasticdump:

  • Format: .gz (per index/component dump)
  • Tooling: elasticdump
  • Compression: Gzip compressed JSON data

For backup configuration, scheduling, retention policies, and management options, see the Zerops Backups documentation.

Restoring Backups​

To restore an Elasticsearch backup:

  1. Download the backup file (.gz) from the Zerops UI
  2. Extract the compressed files to access the JSON data
  3. Prepare your target environment (clean existing indices or use a new instance)
  4. Restore using either:
    • elasticdump tool: Use the same tool that created the backup for restoration via Zerops VPN or during deployment
    • Elasticsearch API: Import the data through REST API calls

For assistance with the restoration process, contact Zerops support.

Example Configuration​

services:
- hostname: elasticsearch
type: elasticsearch@8.16
mode: HA
envSecrets:
PLUGINS: "analysis-icu,ingest-attachment"
HEAP_PERCENT: "75"