Установка Шерлока

По умолчанию установка Шерлока предполагает использование СУБД, хранилищ и SSL-сертификатов, которые поставляются вместе с дистрибутивом.

Возможно использование собственных СУБД и хранилищ, сертификатов. Подробнее об этом написано в соответствующих разделах документации.

Базовая установка Шерлока

1. Убедитесь, что выполнены все условия, описанные в разделе Программно-аппаратные требования.

2. Скопируйте архив с дистрибутивом Шерлока в рабочую директорию. Далее будем использовать <sherlock_folder_name>.

3. Распакуйте архив с дистрибутивом Шерлока, используя команду:

   tar -xf <sherlock-distro-archive-name.tar.gz>

4. Сгенерируйте JWT Secret. Для этого можно использовать команду:

   openssl rand -hex 32

   Полученное значение запишите в параметр JWT_SECRET файла <sherlock_folder_name>/services/orion/config.env.

5. Сгенерируйте JIRA Secret. Для этого можно использовать команду:

   openssl rand -hex 32

   Полученное значение запишите в параметр JIRA_SECRET файла <sherlock_folder_name>/services/orion/config.env.

6. Запустите Шерлока, используя команды <sherlock_folder_name>/bin/install и <sherlock_folder_name>/bin/up.

7. После запуска контейнеров web-интерфейс Шерлока будет доступен по URL, соответствующему URL рабочей станции, на которой он был установлен.

   Локальный вход

   

   AD

   

8. Для прохождения аутентификации выберите вариант "Локальный вход" и используйте стандартные учетные данные: system/system.

   к сведению

   После успешной аутентификации рекомендуется сменить пароль учетной записи system или заблокировать ее, предварительно создав административную учетную запись.

   Подробнее о работе с локальными пользователями написано в разделе Управление пользователями.

9. Настройка доменной аутентификации описана в разделе LDAP.

Использование внешних СУБД и хранилищ

1. Для использования внешних СУБД и хранилища необходимо внести изменения в файл <sherlock_folder_name>/services/orion/config.env.

   Перечень параметров для изменения

   Переменная	Назначение
   CLICKHOUSE_HOST	IP-адрес/FQDN рабочей станции, на которой работает ClickHouse
   CLICKHOUSE_PORT	Порт для взаимодействия с ClickHouse
   CLICKHOUSE_DATABASE	Наименование базы данных в ClickHouse
   CLICKHOUSE_USERNAME	Пользователь, из-под которого будут совершаться действия в ClickHouse
   CLICKHOUSE_PASSWORD	Пароль пользователя, из-под которого будут совершаться действия в ClickHouse
   S3_HOST	IP-адрес/FQDN рабочей станции, на которой работает S3
   S3_PORT	Порт для взаимодействия с S3
   S3_ACCESS_KEY	Ключ доступа для работы с S3
   S3_SECRET_KEY	Секретный (закрытый) ключ для работы с S3
   S3_BUCKET	Наименование bucket в S3
   MONGO_DB_HOST	IP-адрес/FQDN рабочей станции, на которой работает MongoDB
   MONGO_DB_PORT	Порт для взаимодействия с MongoDB
   MONGO_DB_DATABASE	Наименование базы данных в MongoDB
   MONGO_DB_USERNAME	Пользователь, из-под которого будут совершаться действия в MongoDB
   MONGO_DB_PASSWORD	Пароль пользователя, из-под которого будут совершаться действия в MongoDB
   POSTGRES_HOST	IP-адрес/FQDN рабочей станции, на которой работает PostgreSQL
   POSTGRES_PORT	Порт для взаимодействия с PostgreSQL
   POSTGRES_DATABASE	Наименование базы данных в PostgreSQL
   POSTGRES_USERNAME	Пользователь, из-под которого будут совершаться действия в PostgreSQL
   POSTGRES_PASSWORD	Пароль пользователя, из-под которого будут совершаться действия в PostgreSQL

Использование самоподписанных сертификатов

1. Поместите сертификат в формате crt и закрытый ключ в формате key в папку <sherlock_folder_name>/services/apigw/ssl.

2. Внесите изменения в конфигурация Nginx. Укажите наименования файлов сертификата и ключа в файле <sherlock_folder_name>/services/apigw/nginx.conf:

   server {
       listen 80;
       listen 443 ssl;
   
       ssl_certificate /etc/nginx/ssl/cert.crt #заменить имя на предоставленный файл
       ssl_certificate_key /etc/nginx/ssl/key.key #заменить имя на предоставленный файл
   }

3. Перезапустите Шерлока, используя команды <sherlock_folder_name>/bin/down и <sherlock_folder_name>/bin/up.