Проверка работоспособности#

Проверка авторизации#

Примечание Данная проверка подходит для KeyCloak и Platform V IAM SE.

  1. Откройте браузер и перейдите по ссылке: https://<host_tdm>/.

  2. Пройдите аутентификацию, введя логин и пароль в соответствующие поля на странице.

    Переадресация на главную страницу Platform V Test Data Management свидетельствует об успешной аутентификации.

Проверка доступности базы данных#

Примечание Данная проверка подходит для PostgreSQL и Platform V Pangolin SE.

  1. Откройте командную строку.

  2. Введите следующую команду для подключения к базе данных:

    psql -h {PVWTDM_DATABASE_HOST} -p {PVWTDM_DATABASE_PORT} -U postgres -d postgres

    Успешное подключение к базе и отсутствие ошибок в командной строке свидетельствует о работоспособности базы данных.

Проверка доступности брокера сообщений#

Примечание Данная проверка подходит для Kafka и Platform V Corax.

  1. Установите Kafkacat следующей командой:

    apt-get install kafkacat

  2. Используйте следующую команду для подключения к брокеру сообщений:

    kafkacat -b {PVWTDM_KAFKA_HOST}:{PVWTDM_KAFKA_PORT} -t test-topic

    Если kafkacat сможет установить соединение после выполнения вышеуказанной команды, брокер сообщений считается запущенным.

  3. Список созданных топиков соответствует списку ниже:

    Наименование топика

    Назначение

    Обязательность топика

    Издатель

    Потребитель

    audit-logs

    Для отправки событий аудита

    Обязателен (при наличии интеграции с системой аудита)

    -

    -

    scheduler-tasks

    Для отправки запросов на генерацию

    Обязателен

    orders-service

    scheduler

    scheduler-response

    Для ответа от среды исполнения (например, Jenkins)

    Обязателен

    Среда исполнения

    scheduler

    scheduler-cancel

    Для отправки команды на отмену генерации запроса

    Обязателен

    orders-service

    scheduler

    orders-response

    Для ответа на запрос генерации (сгенерированные данные на АС)

    Обязателен

    scheduler

    orders-service

    orders-status

    Для промежуточных статусов запроса на генерацию (например «Запланировано», «Генерируется»)

    Обязателен

    scheduler

    orders-service

    statistic-event

    Для отправки статистики по генерации

    Обязателен

    orders-service

    statistic-service

    ml_autogen

    Для отправки статистики по заявке с успешной генерацией в сервис, занимающийся обучением модели

    Обязателен

    statistic-service

    ml-service

    index-template

    Для передачи информации по шаблону, которая необходима для индексации данных глобального поиска

    Обязателен при наличии интеграции c OpenSearch или Platform V Search (SRH) и включенной функциональности глобального поиска

    templates-service

    search-service

    ml_summary_request

    Для запроса на получение описания шаблона

    Обязателен при интеграции с GigaChat и включенной функциональности саммаризации

    templates-service

    gigachat-service

    ml_summary_response

    Для ответов на запрос по описанию шаблона (см. топик ml_summary_request)

    Обязателен при интеграции с GigaChat и включенной функциональности санфоризации

    gigachat-service

    templates-service

Проверка доступности SecMan или HashiCorp Vault#

Данный раздел применим, если установка TDMS производилась по инструкции Установка при помощи Helm charts в среде контейнеризации руководства по установке.

С целью проверки интеграции с SecMan или HashiCorp Vault для каждого pod, в котором запущен контейнер Vault-agent, необходимо удостовериться, что Vault подключен.

Пример записи в журнале об успешном подключении:

2024-10-01 08:25:01.387'Z' [INFO]  sink.file: creating file sink: ...
2024-10-01 08:25:01.387'Z' [INFO]  sink.file: file sink configured: ...
2024-10-01 08:25:01.387'Z' [INFO]  Vault agent started! Log data will stream in below:: ...
2024-10-01 08:25:01.387'Z' [INFO]  Vault agent configuration                     Cgo: enabled               Log Level: info                 Version: Vault v01.013.00-137    ...
....

Если данный лог отсутствует, SecMan или HashiCorp Vault был настроен неправильно. Необходимо вернуться к руководству по установке и пройти шаги заново.

Проверка доступности интеграции с LLM GigaChat#

Интеграция с LLM GigaChat реализована посредством взаимодействия через API. Для проверки доступности GigaChat компонент программного компонента gigachat-service должен быть успешно установлен, проверка работоспособности компонентов программного компонента gigachat-service описана в разделе Проверка доступности микросервисов.

Проверка доступности микросервисов#

Используйте точку подключения health-check, который поставляется с каждым микросервисом.

Endpoint health-check принимает запросы по следующему адресу:
https://<Host>:<Port>/api/gateway/<Название микросервиса>/actuator/health.

При успешном вызове точки подключения сервис вернет текущий статус своего состояния, который выглядит следующим образом:
{"status":"UP","groups":["liveness","readiness"]}

"status":"UP" свидетельствует о том, что сервис находится в рабочем состоянии.

Для автоматизации процесса проверки работоспособности сервисов рекомендуется настроить систему мониторинга, которая будет осуществлять опрос сервисов посредством вызова точки подключения health-check и уведомлять администраторов стенда о неисправностях.

Последовательно откройте следующие URL-адреса в браузере и убедитесь, что полученный результат совпадает с ожидаемым. Зафиксируйте результаты в протоколе. Успешное прохождение всех проверок свидетельствует о корректной установке всех элементов компонента.

Сервис

URL для проверки

Ожидаемый результат

Фактический результат
(успешно/с ошибками)

UI администратора (admin-client)

http(s)://{PVWTDM_HOST}/admin

1. Открылось окно с формой авторизации.
Авторизуйтесь, введя логин и пароль.
2. Авторизация прошла успешно,
открылась форма с инструментами администратора

UI клиента (thin-client)

http(s)://{PVWTDM_HOST}

1. Открылось окно с формой авторизации.
Авторизуйтесь, введя логин и пароль.
2. Авторизация прошла успешно,
открылась форма с инструментами клиента

Работа микросервиса
api-gateway

http(s)://{PVWTDM_HOST}/api/gateway/gateway-info

Список доступных микросервисов

Работа микросервиса
generators-service

http(s)://{PVWTDM_HOST}/api/gateway/generators-service/actuator/health

Ответ {"status":"UP"} (сервис запущен)

Работа микросервиса
statistic-service

http(s)://{PVWTDM_HOST}/api/gateway/statistic-service/actuator/health

Ответ {"status":"UP"} (сервис запущен)

Работа микросервиса
nsi-service

http(s)://{PVWTDM_HOST}/api/gateway/nsi-service/actuator/health

Ответ {"status":"UP"} (сервис запущен)

Работа микросервиса
si-service

http(s)://{PVWTDM_HOST}/api/gateway/si-service/actuator/health

Ответ {"status":"UP"} (сервис запущен)

Работа микросервиса
models-service

http(s)://{PVWTDM_HOST}/api/gateway/models-service/actuator/health

Ответ {"status":"UP"} (сервис запущен)

Работа микросервиса
templates-service

http(s)://{PVWTDM_HOST}/api/gateway/templates-service/actuator/health

Ответ {"status":"UP"} (сервис запущен)

Работа микросервиса
notification-service

http(s)://{PVWTDM_HOST}/api/gateway/notification-service/actuator/health

Ответ {"status":"UP"} (сервис запущен)

Работа микросервиса
orders-service

http(s)://{PVWTDM_HOST}/api/gateway/orders-service/actuator/health

Ответ {"status":"UP"} (сервис запущен)

Работа микросервиса
scheduler

http(s)://{PVWTDM_HOST}/api/gateway/scheduler/actuator/health

Ответ {"status":"UP"} (сервис запущен)

Работа микросервиса
executors-service

http(s)://{PVWTDM_HOST}/api/gateway/executors-service/actuator/health

Ответ {"status":"UP"} (сервис запущен)

Работа микросервиса
external-healthcheck-service

http(s)://{PVWTDM_HOST}/api/gateway/external-healthcheck-service/actuator/health

Ответ {"status":"UP"} (сервис запущен)

Работа микросервиса
remote-service

http(s)://{PVWTDM_HOST}/api/gateway/remote-service/actuator/health

Ответ {"status":"UP"} (сервис запущен)

Работа микросервиса
public-api-service

http(s)://{PVWTDM_HOST}/api/gateway/public-api-service/actuator/health

Ответ {"status":"UP"} (сервис запущен)

Работа микросервиса
ticket-service

http(s)://{PVWTDM_HOST}/api/gateway/ticket-service/actuator/health

Ответ {"status":"UP"} (сервис запущен)

Работа микросервиса
user-manager-service

http(s)://{PVWTDM_HOST}/api/gateway/user-manager-service/actuator/health

Ответ {"status":"UP"} (сервис запущен)

Работа микросервиса
ml-service

http(s)://{PVWTDM_HOST}/api/gateway/ml-service/health

Ответ {"success": true} (сервис запущен)

Работа микросервиса
search-service

http(s)://{PVWTDM_HOST}/api/gateway/search-service/actuator/health

Ответ {"success": true} (сервис запущен)

Проверка доступности микросервиса gigachat-service#

Индикатором работоспособности сервиса является успешное создание и запуск пода в средстве контейнеризации и оркестрации:

  • под перешел в состояние Running,

  • все контейнеры в поде находятся в состоянии Ready.

Необходимо проверить логи пода в средстве контейнеризации и оркестрации и убедиться, что в логах отсутствуют критические ошибки (уровень логирования error).

Выполните команду:

curl -XGET https://host:ХХХХХ/_cluster/health \ 
--cacert <Путь до корневого сертификата> \ 
--cert <Путь до серверного сертификата с открытым ключом> \ 
--key <Путь до серверного сертификата с закрытым ключом> \ 
-u {LOGIN}:{PASSWORD}

Пример ответа:

img.png