Установка Elasticsearch. Краткое руководство для Windows

Для работы Comindware Platform требуется сервер Elasticsearch. См. системные требования.

В случае установки Comindware Platform версии 5.0 в Windows Утилита администрирования устанавливает службу Elasticsearch в папку C:\Program Files\Elasticsearch\elasticsearch-8.1.0\. Эта служба имеет базовую конфигурацию и доступна по адресу localhost:9200.

Вы можете использовать имеющуюся службу Elasticsearch или развернуть её на отдельном сервере.

В этой статье представлены требования к конфигурации компьютера для сервера Elasticsearch, инструкции по установке и настройке конфигурации сервера и службы Elasticsearch в ОС Windows, а также приведен пример типового файла конфигурации. Инструкции представлены для версии 8.10.2, для других версий содержимое файлов конфигурации и порядок установки могут быть иными.

Только после того, как служба Elasticsearch запущена, можно приступать к развертыванию Comindware Platform, указав путь к серверу Elasticsearch.

1. Требования к компьютеру

Сервер Elasticsearch создает значительную нагрузку на вычислительные ресурсы компьютера, поэтому рекомендуется:

• использовать отдельный SSD-диск для хранения журналов и данных сервера Elasticsearch;
• осуществлять мониторинг свободного места на диске, так как сервер перестает записывать данные, если на диске мало свободного места;
• использовать высокопроизводительный компьютер с достаточным объемом ОЗУ и количеством ядер ЦП, так как для обработки каждого индекса создается отдельный поток, а индексов может быть много.

2. Установка Elasticsearch

Для установки Elasticsearch необходимо распаковать исполняемые файлы из ZIP-архива, а затем настроить переменные среды, службу Elasticsearch и конфигурацию сервера.

В процессе установки и настройки Elasticsearch все команды следует выполнять от имени администратора.

2.1. Скачайте файл elasticsearch-<8.XX.X>-windows-x86_64.zip c дистрибутивом Elasticsearch. Здесь <8.XX.X> — номер версии Elasticsearch.

2.2. Распакуйте архив в целевую папку, например: C:\Program Files\Elastic\Elasticsearch\elasticsearch-<8.XX.X>

Последующие инструкции подразумевают, что сервер Elasticsearch установлен в эту папку.

2.3. Настройте переменные среды, как указано ниже.

• Путь к исполняемым файлам Elasticsearch: ES_HOME: C:\Program Files\Elasticsearch\elasticsearch\elasticsearch-<8.XX.X>
• Путь к JDK (требуется версия, совместимая с текущей версией Elasticsearch): ES_JAVA_HOME: C:\Program Files\Elasticsearch\elasticsearch-<8.XX.X>\jdk
• Папка с файлами конфигурации: ES_PATH_CONF: C:\Program Files\Elasticsearch\elasticsearch-<8.XX.X>\config
• Папка с файлами журналов: SERVICE_LOG_DIR: C:\ProgramData\Elasticsearch\elasticsearch-<8.XX.X>\logs
• Директива для автоматического запуска службы: ES_START_TYPE: auto

2.4. Настройте службу Elasticsearch с помощью файла конфигурации elasticsearch.yml

Можно скопировать его содержимое из раздела «Пример типового файла конфигурации Elasticsearch».

2.5. Зарегистрируйте службу Elasticsearch, выполнив следующую команду: "C:\Program Files\Elasticsearch\elasticsearch-<8.XX.X>\bin\elasticsearch-service.bat" install

2.6. Запустите службу Elasticsearch, выполнив следующую команду: "C:\Program Files\Elasticsearch\elasticsearch-<8.XX.X>\bin\elasticsearch-service.bat" start

2.7. Сформируйте пароль для пользователя Elasticsearch с помощью следующей команды: "C:\Program Files\Elasticsearch\elasticsearch-<8.XX.X>\bin\elasticsearch-reset-password.bat" –u elastic

2.8. Сохраните пароль, который отобразится на экране. 

2.9. Убедитесь, что служба Elasticsearch успешно зарегистрирована и работает с помощью приложения «Службы» (services.msc):

2.10. Если служба Elasticsearch не запустилась:

• проверьте ошибки конфигурации в журнале Elasticsearch по пути C:\ProgramData\Elasticsearch\elasticsearch-<8.XX.X>\logs (указанном в переменной окружения среды SERVICE_LOG_DIR).
• устраните ошибки, запустите службу и проверьте работоспособность службы, как указано в параграфе 8.

3. Подключение к Elasticsearch при развертывании экземпляра продукта

3.1. Перед созданием экземпляра продукта укажите адрес сервера Elasticsearch, который будет использоваться по умолчанию для новых экземпляров продукта, в конфигурации Утилиты администрирования Comindware. См. документ «Утилита администрирования Comindware. Установка и использование».

3.2. Если не указать адрес сервера Elasticsearch в конфигурации Утилиты администрирования, то его потребуется указать при развертывании экземпляра продукта.

3.3. Укажите адрес сервера и префикс индекса Elasticsearch для данного экземпляра Comindware Platform.

3.4. После развертывания экземпляра продукта в разделе «Администрирование системы» — «Подключения» будет отображаться настроенное подключение к Elasticsearch.

3.5. Чтобы изменить свойства подключения к Elasticsearch, дважды нажмите его строку в списке подключений.

3.6. Отобразится окно «Свойства подключения: Elasticsearch».

3.7. При необходимости измените свойства подключения, проверьте соединение и нажмите кнопку «Сохранить».

3.8. После изменения свойств сервера Elasticsearch перезапустите экземпляр продукта с помощью Утилиты администрирования Comindware. См. документ «Утилита администрирования Comindware. Установка и использование».

4. Пример типового файла конфигурации Elasticsearch

Ниже приведен пример файла elasticsearch.yml для следующей конфигурации сервера:

• сервер Elasticsearch состоит из единственного узла;
• служба работает в локальной сети;
• включена аутентификация;
• служба доступна через порт 9201;
• адрес сервера http://testhost:9201;
• путь к файлу конфигурации: C:\Program Files\Elastic\Elasticsearch\<8.XX.X>\config\elasticsearch.yml

#Начало файла конфигурации 
#Разрешить свопинг памяти 
bootstrap.memory_lock: false 

#Название кластера 
cluster.name: cmw 

#Максимальное возможное количество шардов в кластере 
#Система создает отдельный индекс для каждого объекта мониторинга, поэтому рекомендуется увеличить количество шардов до 3000 
cluster.max_shards_per_node: 3000 

#Стандартный номер порта 9200 изменен по соображениям безопасности 
http.port: 9201 

#Сетевые параметры 
#Если доступ по сети не требуется, то закомментируйте строки #network.host и discovery.seed_hosts 
#Замените имя компьютера — testhost — на реальное имя 
network.host: testhost 
discovery.seed_hosts: 
  - testhost 

#Простейшая конфигурация с одним узлом 
discovery.type: single-node 

#Название узла 
node.name: cmw 

#Путь к папке с данными 
path.data: d:\ProgramData\Elasticsearch\elasticsearch-<8.XX.X>\data 

#Путь к папке с журналами 
path.logs: d:\ProgramData\Elasticsearch\elasticsearch-<8.XX.X>\logs 

#Путь к папке с резервными копиями 
#Путь должен указывать на существующий диск 
#Резервные копии должны храниться на отдельном диске отдельно от #основных данных 
#Раскомментируйте директиву path.repo, если требуется создавать резервные копии 
#path.repo: d:elastic_backup 

#Обычная лицензия 
xpack.license.self_generated.type: basic 

#Аутентификация включена 
xpack.security.enabled: true 

#Этот флаг требуется для записи данных в индексы 
indices.id_field_data.enabled: true 

#отключить геолокацию  
ingest.geoip.downloader.enabled: false