Запуск из распакованного архива#

Архив с CedrusData Catalog доступен по ссылке.

Данный документ описывает структуру архива CedrusData Catalog и особенности процедуры запуска продукта из распакованного архива.

Структура архива#

Архив CedrusData Catalog имеет следующую структуру:

  • /bin — директория с исполняемыми файлами

  • /bin/launcher — утилита для запуска продукта

  • /bin/catalog — утилита командной строки для работы с каталогом

  • /etc — конфигурация по умолчанию

  • /lib — библиотеки ядра продукта

  • /plugin — подключаемые плагины

Запуск и остановка#

Убедитесь, что у вас установлена Java 21 (или более поздняя версия) и Python.

Запуск и остановка CedrusData Catalog происходит с помощью команды bin/launcher <операция>. Возможные операции:

  • run — запустить каталог

  • start — запустить каталог в фоновом режиме

  • restart — перезапустить каталог в фоновом режиме

  • stop — остановить каталог

  • kill — принудительно остановить каталог

  • status — получить статус каталога (запущен или нет)

Примечание

Для корректной работы данных команд рабочая директория должна оставаться постоянной, так как она содержит информацию о текущем запущенном процессе каталога. Например, если вы запустите каталог с одним значением рабочей директории, а потом попробуете вызвать stop с другим, каталог не будет остановлен, и команда stop вернет ошибку.

Команда bin/launcher имеет несколько важных опций:

  • --data-dir — путь к рабочей директории каталога

  • --etc-dir — путь к директории с конфигурацией. Используйте данный параметр, чтобы запускать каталог с конфигурацией, находящейся вне распакованного архива. Значение по умолчанию: директория etc/ внутри распакованного архива каталога

  • --plugin-dir — путь к директории с плагинами. Используйте данный параметр, чтобы изменить набор плагинов, с которыми будет запущен продукт. Например, если вы хотите отключить плагин hdfs, вы можете скопировать директорию plugin/ из распакованного архива в другое место, удалить оттуда директорию hdfs и запустить каталог с новой директорией плагинов. Значение по умолчанию: директория plugin/ внутри распакованного архива каталога

Ознакомиться с другими аргументами можно с помощью опции --help

Рабочая директория#

Рабочая директория содержит различные файлы, необходимые для работы каталога:

  • <data-dir>/etc — symlink на директорию с конфигурацией, указанную при запуске каталога

  • <data-dir>/plugin — symlink на директорию с плагинами, указанную при запуске каталога

  • <data-dir>/var/log — содержит логи каталога

  • <data-dir>/var/run — сохраняет идентификатор (PID) текущего процесса каталога. Эта информация нужна для определения текущего статуса каталога при вызове bin/launcher.

<data-dir> является текущей директорией процесса каталога. Таким образом, разрешение всех относительных путей к файлам, указанных в конфигурации каталога, происходит относительно <data-dir>.

Кроме этого, рабочая директория может содержать различные дополнительные файлы и директории, например:

  • Директория с файлами ресурсов. В основном используется для конфигурации файловой системы HDFS. Значение по умолчанию — <data-dir>/resource. Можно переопределить параметром конфигурации resource-dir

  • Начальный постоянный токен доступа администратора. Значение по умолчанию — <data-dir>/catalog-admin-access-token. Можно переопределить параметром конфигурации admin-access-token-file-path

  • Файлы СУБД SQLite при использовании SQLite в качестве СУБД. По умолчанию — <data-dir>/catalog-store. Можно переопределить параметром конфигурации store.sqlite.path

Разрешение значения <data-dir> происходит следующим образом:

  • Если задана опция --data-dir, будет использовано ее значение

  • В противном случае будет использовано значение параметра конфигурации data-dir

  • Если параметр конфигурации data-dir не задан, запуск каталога будет остановлен с ошибкой

Примеры#

Запустить каталог с рабочей директорией data и конфигурацией по умолчанию:

cedrusdata-catalog-server-458-18/bin/launcher start --data-dir data

Запустить каталог с рабочей директорией data и конфигурацией в отдельной директории prod:

cedrusdata-catalog-server-458-18/bin/launcher start --data-dir data --etc-dir prod