OpenSearch/Elasticsearch — Installation and Configuration

OpenSearch Installation

# Ubuntu/Debian
wget -qO - https://artifacts.opensearch.org/publickeys/opensearch.pgp | sudo apt-key add -
sudo add-apt-repository https://artifacts.opensearch.org/releases/bundle/opensearch/2.x/apt
sudo apt update
sudo apt install opensearch

# Start service
sudo systemctl start opensearch
sudo systemctl enable opensearch

Elasticsearch Installation

# Ubuntu/Debian
wget -qO - https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add -
sudo add-apt-repository https://artifacts.elastic.co/packages/8.x/apt
sudo apt update
sudo apt install elasticsearch

# Start service
sudo systemctl start elasticsearch
sudo systemctl enable elasticsearch

Default Configuration

# /etc/opensearch/opensearch.yml
cluster.name: magento-search
node.name: node-1
network.host: 0.0.0.0
http.port: 9200
discovery.type: single-node

Verify Installation

# Test connection
curl -X GET "http://localhost:9200"

# Check cluster health
curl -X GET "http://localhost:9200/_cluster/health"

env.php Configuration

return [
    'catalog' => [
        'search' => [
            'engine' => 'elasticsearch8',
            'engine_config' => [
                'host' => 'localhost',
                'port' => '9200',
                'index' => 'magento2'
            ]
        ]
    ]
];

CLI Setup

php bin/magento setup:config:set \
    --search-engine=elasticsearch8 \
    --elasticsearch-host=localhost \
    --elasticsearch-port=9200 \
    --elasticsearch-index-prefix=magento2

Connection Test

# Test connection from Magento
php bin/magento search-engine:test

# Check search engine status
php bin/magento search-engine:status

Multiple Search Engines

// env.php for different environments
'catalog' => [
    'search' => [
        'engine' => 'elasticsearch8',
        'engine_config' => [
            'host' => env('ES_HOST', 'localhost'),
            'port' => env('ES_PORT', '9200'),
            'index' => env('ES_INDEX', 'magento2')
        ]
    ]
]

Create Search Index

# Create index
php bin/magento search-engine:create

# Delete index
php bin/magento search-engine:delete

# Reindex
php bin/magento indexer:reindex catalogsearch_fulltext

Index Structure

{
  "magento2_product_1": {
    "mappings": {
      "properties": {
        "sku": { "type": "text" },
        "name": { "type": "text" },
        "description": { "type": "text" },
        "category_ids": { "type": "integer" },
        "price": { "type": "float" }
      }
    }
  }
}

Index Aliases

# Check aliases
curl -X GET "http://localhost:9200/_aliases"

# Create alias
curl -X POST "http://localhost:9200/_aliases" -H 'Content-Type: application/json' -d '{
  "actions": [{ "add": { "index": "magento2_product_1", "alias": "magento2_product" }}]
}'

Index Monitoring

# Check index stats
curl -X GET "http://localhost:9200/_stats"

# Check index size
curl -X GET "http://localhost:9200/_cat/indices?v"

# Check index health
curl -X GET "http://localhost:9200/_cat/health?v"

JVM Settings

# /etc/opensearch/jvm.options
-Xms2g  # Min heap (set to 50% of RAM, max 32g)
-Xmx2g  # Max heap

System Settings

# Increase file descriptors
sudo sysctl -w vm.max_map_count=262144

# Persist setting
echo "vm.max_map_count=262144" | sudo tee -a /etc/sysctl.conf

Index Settings

{
  "settings": {
    "number_of_shards": 3,
    "number_of_replicas": 1,
    "refresh_interval": "1s"
  }
}

Query Performance

// Magento search settings
'search' => [
    'max_execution_time' => 3,
    'minimum_should_match' => '75%',
    'fuzziness' => 'AUTO'
]

Monitoring

# Cluster health
curl -X GET "http://localhost:9200/_cluster/health?pretty"

# Node stats
curl -X GET "http://localhost:9200/_nodes/stats?pretty"

# Index stats
curl -X GET "http://localhost:9200/_stats?pretty"