Это многостраничный печатный вид этого раздела. Нажмите что бы печатать.

Вернуться к обычному просмотру страницы.

Установка OpenSearch Dashboards

OpenSearch Dashboards предоставляет полностью интегрированное решение для визуального изучения, обнаружения и запроса ваших данных наблюдаемости.

OpenSearch Dashboards предоставляет полностью интегрированное решение для визуального изучения, обнаружения и запроса ваших данных наблюдаемости. Вы можете установить OpenSearch Dashboards с помощью одного из следующих вариантов:

  • Docker
  • Tarball
  • RPM
  • Debian
  • Helm
  • Windows

Совместимость с браузерами

OpenSearch Dashboards поддерживает следующие веб-браузеры:

  • Chrome
  • Firefox
  • Safari
  • Edge (Chromium)

Другие браузеры на основе Chromium также могут работать. Internet Explorer и Microsoft Edge Legacy не поддерживаются.

Совместимость с Node.js

OpenSearch Dashboards требует бинарный файл среды выполнения Node.js для работы. Один из них включен в дистрибутивные пакеты, доступные на странице загрузок OpenSearch.

OpenSearch Dashboards версии 2.8.0 и новее могут использовать версии Node.js 14, 16 и 18. Дистрибутивные пакеты для OpenSearch Dashboards версии 2.10.0 и новее включают Node.js 18 и 14 (для обратной совместимости).

Чтобы использовать бинарный файл среды выполнения Node.js, отличный от включенных в дистрибутивные пакеты, выполните следующие шаги:

  1. Скачайте и установите Node.js; совместимые версии: >=14.20.1 <19.

  2. Установите путь установки в переменные окружения NODE_HOME или NODE_OSD_HOME.

    • На UNIX, если Node.js установлен в /usr/local/nodejs, а бинарный файл среды выполнения находится по пути /usr/local/nodejs/bin/node:

      export NODE_HOME=/usr/local/nodejs

    • Если Node.js установлен с помощью NVM, а бинарный файл среды выполнения находится по пути /Users/user/.nvm/versions/node/v18.19.0/bin/node:

      export NODE_HOME=/Users/user/.nvm/versions/node/v18.19.0
# или, если NODE_HOME используется для чего-то другого:
export NODE_OSD_HOME=/Users/user/.nvm/versions/node/v18.19.0

    • На Windows, если Node.js установлен в C:\Program Files\nodejs, а бинарный файл среды выполнения находится по пути C:\Program Files\nodejs\node.exe:

      set "NODE_HOME=C:\Program Files\nodejs"
# или с использованием PowerShell:
$Env:NODE_HOME = 'C:\Program Files\nodejs'

  3. Ознакомьтесь с документацией вашей операционной системы, чтобы внести постоянные изменения в переменные окружения.

Скрипт запуска OpenSearch Dashboards, bin/opensearch-dashboards, ищет бинарный файл среды выполнения Node.js, используя NODE_OSD_HOME, затем NODE_HOME, прежде чем использовать бинарные файлы, включенные в дистрибутивные пакеты. Если подходящий бинарный файл среды выполнения Node.js не найден, скрипт запуска попытается найти его в системном PATH, прежде чем завершить работу с ошибкой.

Конфигурация

Чтобы узнать, как настроить TLS для OpenSearch Dashboards, смотрите раздел Настройка TLS.

1 - Запуск OpenSearch Dashboards с использованием Docker

“Вы можете запустить OpenSearch Dashboards с помощью команды docker run после создания сети Docker и запуска OpenSearch, но процесс подключения OpenSearch Dashboards к OpenSearch значительно проще с использованием файла Docker Compose.”

  1. Выполните команду для загрузки образа OpenSearch Dashboards:

    docker pull opensearchproject/opensearch-dashboards:2

  2. Создайте файл docker-compose.yml, соответствующий вашей среде. Пример файла, который включает OpenSearch Dashboards, доступен на странице установки OpenSearch Docker.

  3. Так же, как и для opensearch.yml, вы можете передать пользовательский файл opensearch_dashboards.yml в контейнер в файле Docker Compose.

  4. Запустите команду:

    docker compose up

  5. Подождите, пока контейнеры запустятся. Затем ознакомьтесь с документацией OpenSearch Dashboards.

  6. Когда закончите, выполните команду:

    docker compose down

2 - Установка OpenSearch Dashboards (Debian)

Установка OpenSearch Dashboards с использованием менеджера пакетов Advanced Packaging Tool (APT)

Установка OpenSearch Dashboards с использованием менеджера пакетов Advanced Packaging Tool (APT) значительно упрощает процесс по сравнению с методом Tarball. Например, менеджер пакетов обрабатывает несколько технических аспектов, таких как путь установки, расположение конфигурационных файлов и создание службы, управляемой systemd.

Перед установкой OpenSearch Dashboards необходимо настроить кластер OpenSearch. Обратитесь к руководству по установке OpenSearch для Debian для получения инструкций.

Данное руководство предполагает, что вы уверенно работаете с интерфейсом командной строки (CLI) Linux. Вы должны понимать, как вводить команды, перемещаться между директориями и редактировать текстовые файлы. Некоторые примеры команд ссылаются на текстовый редактор vi, но вы можете использовать любой доступный текстовый редактор.

Установка OpenSearch Dashboards из пакета

  1. Скачайте пакет Debian для нужной версии непосредственно с страницы загрузок OpenSearch. Пакет Debian доступен для архитектур x64 и arm64.

  2. Установите пакет с помощью dpkg из командной строки:

    • Для x64:

      sudo dpkg -i opensearch-dashboards-3.1.0-linux-x64.deb

    • Для arm64:

      sudo dpkg -i opensearch-dashboards-3.1.0-linux-arm64.deb

  3. После завершения установки перезагрузите конфигурацию менеджера systemd:

    sudo systemctl daemon-reload

  4. Включите OpenSearch как службу:

    sudo systemctl enable opensearch-dashboards

  5. Запустите службу OpenSearch:

    sudo systemctl start opensearch-dashboards

  6. Проверьте, что OpenSearch запустился корректно:

    sudo systemctl status opensearch-dashboards

Проверка подписи

Пакет Debian не подписан. Если вы хотите проверить подпись, проект OpenSearch предоставляет файл .sig, а также .deb пакет для использования с GNU Privacy Guard (GPG).

  1. Скачайте нужный пакет Debian:

    curl -SLO https://artifacts.opensearch.org/releases/bundle/opensearch-dashboards/3.1.0/opensearch-dashboards-3.1.0-linux-x64.deb

  2. Скачайте соответствующий файл подписи:

    curl -SLO https://artifacts.opensearch.org/releases/bundle/opensearch-dashboards/3.1.0/opensearch-dashboards-3.1.0-linux-x64.deb.sig

  3. Скачайте и импортируйте GPG-ключ:

    curl -o- https://artifacts.opensearch.org/publickeys/opensearch-release.pgp | gpg --import -

  4. Проверьте подпись:

    gpg --verify opensearch-dashboards-3.1.0-linux-x64.deb.sig opensearch-dashboards-3.1.0-linux-x64.deb

Установка OpenSearch Dashboards из репозитория APT

APT, основной инструмент управления пакетами для операционных систем на базе Debian, позволяет загружать и устанавливать пакет Debian из репозитория APT.

  1. Установите необходимые пакеты:

    sudo apt-get update && sudo apt-get -y install lsb-release ca-certificates curl gnupg2

  2. Импортируйте публичный GPG-ключ. Этот ключ используется для проверки подписи репозитория APT:

    curl -o- https://artifacts.opensearch.org/publickeys/opensearch-release.pgp | sudo gpg --dearmor --batch --yes -o /usr/share/keyrings/opensearch-release-keyring

  3. Создайте репозиторий APT для OpenSearch:

    echo "deb [signed-by=/usr/share/keyrings/opensearch-release-keyring] https://artifacts.opensearch.org/releases/bundle/opensearch-dashboards/3.x/apt stable main" | sudo tee /etc/apt/sources.list.d/opensearch-dashboards-3.x.list

  4. Проверьте, что репозиторий был успешно создан:

    sudo apt-get update

  5. С добавленной информацией о репозитории, перечислите все доступные версии OpenSearch:

    sudo apt list -a opensearch-dashboards

  6. Выберите версию OpenSearch, которую хотите установить:

    • Если не указано иное, будет установлена последняя доступная версия OpenSearch:

      sudo apt-get install opensearch-dashboards

    • Чтобы установить конкретную версию OpenSearch Dashboards, укажите номер версии после имени пакета:

      # Укажите версию вручную с помощью opensearch=<version>
sudo apt-get install opensearch-dashboards=3.1.0

  7. После завершения установки включите OpenSearch:

    sudo systemctl enable opensearch-dashboards

  8. Запустите OpenSearch:

    sudo systemctl start opensearch-dashboards

  9. Проверьте, что OpenSearch запустился корректно:

    sudo systemctl status opensearch-dashboards

Изучение OpenSearch Dashboards

По умолчанию OpenSearch Dashboards, как и OpenSearch, связывается с localhost при первоначальной установке. В результате OpenSearch Dashboards недоступен с удаленного хоста, если конфигурация не обновлена.

  1. Откройте файл opensearch_dashboards.yml:

    sudo vi /etc/opensearch-dashboards/opensearch_dashboards.yml

  2. Укажите сетевой интерфейс, к которому должен связываться OpenSearch Dashboards:

    # Используйте 0.0.0.0, чтобы связаться с любым доступным интерфейсом.
server.host: 0.0.0.0

  3. Сохраните изменения и выйдите из редактора.

  4. Перезапустите OpenSearch Dashboards, чтобы применить изменения конфигурации:

    sudo systemctl restart opensearch-dashboards

  5. В веб-браузере перейдите к OpenSearch Dashboards. Порт по умолчанию — 5601.

  6. Войдите с использованием имени пользователя admin и пароля admin. (Для OpenSearch 2.12 и новее пароль должен быть пользовательским паролем администратора.)

  7. Посетите раздел “Начало работы с OpenSearch Dashboards”, чтобы узнать больше.

Обновление до новой версии

Экземпляры OpenSearch Dashboards, установленные с помощью dpkg или apt-get, можно легко обновить до новой версии.

Ручное обновление с помощью DPKG

  1. Скачайте пакет Debian для желаемой версии обновления непосредственно со страницы загрузок проекта OpenSearch.

  2. Перейдите в директорию, содержащую дистрибутив, и выполните следующую команду:

    sudo dpkg -i opensearch-dashboards-3.1.0-linux-x64.deb

Обновление с помощью APT-GET

Чтобы обновить до последней версии OpenSearch Dashboards с помощью apt-get, выполните следующую команду:

sudo apt-get upgrade opensearch-dashboards

Вы также можете обновить до конкретной версии OpenSearch Dashboards, указав номер версии:

sudo apt-get upgrade opensearch-dashboards=<version>

Автоматический перезапуск службы после обновления пакета (2.13.0+)

Чтобы автоматически перезапустить OpenSearch Dashboards после обновления пакета, включите службу opensearch-dashboards.service через systemd:

sudo systemctl enable opensearch-dashboards.service

3 - Настройка TLS для OpenSearch Dashboards

По умолчанию, для упрощения тестирования и начала работы, OpenSearch Dashboards работает по протоколу HTTP. Чтобы включить TLS для HTTPS, обновите следующие настройки в файле opensearch_dashboards.yml.
Настройка Описание
server.ssl.enabled Включает SSL-соединение между сервером OpenSearch Dashboards и веб-браузером пользователя. Установите значение true для HTTPS или false для HTTP.
server.ssl.supportedProtocols Указывает массив поддерживаемых протоколов TLS. Возможные значения: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3. По умолчанию: ['TLSv1.1', 'TLSv1.2', 'TLSv1.3'].
server.ssl.cipherSuites Указывает массив шифров TLS. Необязательная настройка.
server.ssl.certificate Если server.ssl.enabled установлено в true, указывает полный путь к действительному сертификату сервера Privacy Enhanced Mail (PEM) для OpenSearch Dashboards. Вы можете сгенерировать свой сертификат или получить его у центра сертификации (CA).
server.ssl.key Если server.ssl.enabled установлено в true, указывает полный путь к ключу для вашего серверного сертификата, например, /usr/share/opensearch-dashboards-1.0.0/config/my-client-cert-key.pem. Вы можете сгенерировать свой сертификат или получить его у CA.
server.ssl.keyPassphrase Устанавливает пароль для ключа. Удалите эту настройку, если у ключа нет пароля. Необязательная настройка.
server.ssl.keystore.path Использует файл JKS (Java KeyStore) или PKCS12/PFX (Public-Key Cryptography Standards) вместо сертификата и ключа PEM.
server.ssl.keystore.password Устанавливает пароль для хранилища ключей. Обязательная настройка.
server.ssl.clientAuthentication Указывает режим аутентификации клиента TLS. Может быть одним из следующих: none, optional или required. Если установлено в required, ваш веб-браузер должен отправить действительный клиентский сертификат, подписанный CA, настроенным в server.ssl.certificateAuthorities. По умолчанию: none.
server.ssl.certificateAuthorities Указывает полный путь к одному или нескольким сертификатам CA в массиве, которые выдают сертификат, используемый для аутентификации клиента. Обязательная настройка, если server.ssl.clientAuthentication установлено в optional или required.
server.ssl.truststore.path Использует файл JKS или PKCS12/PFX trust store вместо сертификатов CA PEM.
server.ssl.truststore.password Устанавливает пароль для trust store. Обязательная настройка.
opensearch.ssl.verificationMode Устанавливает связь между OpenSearch и OpenSearch Dashboards. Допустимые значения: full, certificate или none. Рекомендуется использовать full, если TLS включен, что включает проверку имени хоста. certificate проверяет сертификат, но не имя хоста. none не выполняет никаких проверок (подходит для HTTP). По умолчанию: full.
opensearch.ssl.certificateAuthorities Если opensearch.ssl.verificationMode установлено в full или certificate, указывает полный путь к одному или нескольким сертификатам CA в массиве, которые составляют доверенную цепочку для кластера OpenSearch. Например, вам может потребоваться включить корневой CA и промежуточный CA, если вы использовали промежуточный CA для выдачи ваших сертификатов администратора, клиента и узла.
opensearch.ssl.truststore.path Использует файл trust store JKS или PKCS12/PFX вместо сертификатов CA PEM.
opensearch.ssl.truststore.password Устанавливает пароль для trust store. Обязательная настройка.
opensearch.ssl.alwaysPresentCertificate Отправляет клиентский сертификат в кластер OpenSearch, если установлено значение true, что необходимо, когда mTLS включен в OpenSearch. По умолчанию: false.
opensearch.ssl.certificate Если opensearch.ssl.alwaysPresentCertificate установлено в true, указывает полный путь к действительному клиентскому сертификату для кластера OpenSearch. Вы можете сгенерировать свой сертификат или получить его у CA.
opensearch.ssl.key Если opensearch.ssl.alwaysPresentCertificate установлено в true, указывает полный путь к ключу для клиентского сертификата. Вы можете сгенерировать свой сертификат или получить его у CA.
opensearch.ssl.keyPassphrase Устанавливает пароль для ключа. Удалите эту настройку, если у ключа нет пароля. Необязательная настройка.
opensearch.ssl.keystore.path Использует файл хранилища ключей JKS или PKCS12/PFX вместо сертификата и ключа PEM.
opensearch.ssl.keystore.password Устанавливает пароль для хранилища ключей. Обязательная настройка.
opensearch_security.cookie.secure Если TLS включен для OpenSearch Dashboards, измените эту настройку на true. Для HTTP установите значение false.

Пример конфигурации opensearch_dashboards.yml

Следующая конфигурация opensearch_dashboards.yml показывает, как OpenSearch и OpenSearch Dashboards могут работать на одной машине с демонстрационной конфигурацией:

server.host: '0.0.0.0'
server.ssl.enabled: true
server.ssl.certificate: /usr/share/opensearch-dashboards/config/client-cert.pem
server.ssl.key: /usr/share/opensearch-dashboards/config/client-cert-key.pem
opensearch.hosts: ["https://localhost:9200"]
opensearch.ssl.verificationMode: full
opensearch.ssl.certificateAuthorities: [ "/usr/share/opensearch-dashboards/config/root-ca.pem", "/usr/share/opensearch-dashboards/config/intermediate-ca.pem" ]
opensearch.username: "kibanaserver"
opensearch.password: "kibanaserver"
opensearch.requestHeadersAllowlist: [ authorization,securitytenant ]
opensearch_security.multitenancy.enabled: true
opensearch_security.multitenancy.tenants.preferred: ["Private", "Global"]
opensearch_security.readonly_mode.roles: ["kibana_read_only"]
opensearch_security.cookie.secure: true

Если вы используете опцию установки через Docker, вы можете передать пользовательский файл opensearch_dashboards.yml в контейнер. Чтобы узнать больше, посетите страницу установки Docker.

После включения этих настроек и запуска приложения вы можете подключиться к OpenSearch Dashboards по адресу https://localhost:5601. Возможно, вам потребуется подтвердить предупреждение браузера, если ваши сертификаты самоподписанные. Чтобы избежать такого предупреждения (или полной несовместимости с браузером), рекомендуется использовать сертификаты от доверенного центра сертификации (CA).