Elasticsearch

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

Connection

• Port: 9200
• Protocol: HTTP only
• Internal Access: http://hostname:9200
• Note: When accessing from another service within the same project, use the service hostname

Configuration

How to install/uninstall plugins

Configure Elasticsearch plugins using a comma-separated list:

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

• Description: Defines plugins to install at startup
• Format: plugin1,plugin2,...
• Note: Removing a plugin from this list triggers uninstallation on service restart

How to adjust JVM heap allocation

Control JVM heap size as a percentage of container memory:

envSecrets:
  HEAP_PERCENT: "75"

• Description: Percentage of container memory allocated to JVM heap
• Default: 50
• Range: 1-100
• Note: To increase available memory, adjust the service's RAM allocation in scaling configuration
• Important: 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"

Related Resources

• Elasticsearch Official Documentation
• Available Elasticsearch Plugins