Руководство прикладного разработчика#
Системные требования#
Требования к окружению для использования компонента приведены в документе Руководство по установке в разделе «Системные требования».
Подключение и конфигурирование#
Подключение#
Для подключения компонента используется публичное api. Более детально можно ознакомиться в документе apis.
Конфигурация параметров#
Конфигурация параметров запуска#
Описание параметров:
Параметр |
Краткое описание |
Тип |
|---|---|---|
product360.starter.client.app-api.url |
URL до REST-API APP-API |
STRING |
keycloak.auth-server-url |
Адрес до сервера keycloak |
STRING |
spring.datasource.jdbcUrl |
Адрес мастера БД |
STRING |
standin.datasource.jdbcUrl: |
Адрес стенда БД |
STRING |
spring.profiles.active: |
Активные профиля для запуска |
STRING |
extend.keycloak.proxy: |
Прокси адрес сервера keycloak |
STRING |
keycloak.enabled: |
Необходимость авторизовываться в опциональном компоненте KeyCloak.SE (KCSE) продукта Platform V IAM SE (IAM) |
STRING |
spring.datasource.username: |
Имя пользователя БД |
STRING |
standin.datasource.driver-class-name: |
Драйвер БД для подключения |
STRING |
extend.clipas.tech.user: |
ТУЗ для работы |
STRING |
SSL_KEYSTORE_LOCATION: |
Путь до кейстора кафки |
STRING |
SSL_TRUSTSTRE_LOCATION: |
Путь до трансфера кафки |
STRING |
standin.module.id |
Имя модуля в ПЖ |
STRING |
module.id: |
Имя модуля в системе логгирования |
STRING |
standin.cloud.client.zone-id: |
Зона ПЖ |
STRING |
standin.cloud.client.stub: |
Флаг заглушки ПЖ |
STRING |
standin.cloud.client.kafka.bootstrapServers: |
Адреса серверов кафки ПЖ |
STRING |
AUDIT_HOST |
URL API аудита |
STRING |
AUDIT_USER |
Пользователь для отправки в аудит |
STRING |
SSL_IDENTIFICATION_ALGORITHM |
Алгоритм идентификации для кафки ПЖ |
STRING |
product360.starter.client.auth-api.url |
URL до REST-API APP-API |
STRING |
Конфигурация кеша#
Описание параметров:
Параметр |
Краткое описание |
Тип |
|---|---|---|
ufsdictionary.module.cache.ttl |
Время жизни кеша платформенного модуля |
LONG |
Конфигурация мониторинга#
Описание параметров:
Название метрики |
Точка мониторинга |
Тип метрики |
Название сервиса |
|---|---|---|---|
system_load_average_1m |
Загрузка системы за последнюю минуту |
Состояние |
App-api |
jvm_memory_used_bytes |
Использованная ОЗУ в байтах |
Состояние |
App-api |
hikaricp_connections_active |
Количество активных подключений к БД |
Состояние |
App-api |
process_uptime_seconds |
Общее время работы пода |
Состояние |
App-api |
process_cpu_usage |
Загрузка ЦПУ |
Состояние |
App-api |
jvm_threads_states_threads |
Количество активных тредов |
Состояние |
App-api |
select_product_offers_getAll_seconds_max |
Общее время получения списка оферов |
Состояние |
App-api |
select_product_offers_getAll_seconds_count |
Количество оферов получаемых за секунду |
Состояние |
App-api |
http_server_requests_seconds_count |
Количество выполняемых запросов в секунду |
Состояние |
App-api |
process_files_open_files |
Количество открытых файлов |
Состояние |
App-api |
select_product_specifications_view_siblings_seconds_count |
Количество продуктовых спецификаций |
Состояние |
App-api |
cache_gets_total |
Объем кеша |
Состояние |
App-api |
Миграция на текущую версию#
Миграция на текущую версию представляет собой ее подключение в соответствии с пунктом Подключение и конфигурирование настоящего руководства.
Для миграции БД создан отдельный скрипт в Jenkins. Скрипт параметризирован и при запуске попросит следующие параметры:
gitSshUrl — в качестве переменной необходимо указать адрес репозитория в Gitlab (CE);
gitBranchSource — ветка, в которой лежат миграции, это может быть как отдельная ветка, содержащая в себе только миграции, так и папка в репозитории проекта;
dbStand — стенд, на котором будет производиться установка миграций. В данный момент ПЖ не позволяет устанавливать StandIN с помощью api. Установка производится вручную через UI, поэтому данная строка ожидается к заполнению пользователем, чтобы избежать наката на мастер стенд.
Миграции допускаются в любом совместимом с liquibase формате.
Быстрый старт#
Убедитесь, что выполнены все условия указанные в руководстве по установке компонента Product360 (PD36) продукта Platform V Product360 (Р36) в разделе Системные требования.
Развернута и настроена DB PostgreSQL.
На сервере развернуто необходимое программное обеспечение (клиент OC, клиент для работы с PostgreSQL, Docker, система оркестрации контейнеризированных приложений).
Созданы docker-образы.
Выделен проект системы оркестрации контейнеризированных приложений.
Произведена настройка проекта системы оркестрации контейнеризированных приложений.
Выделена VM с DB PostgreSQL.
Произведена первоначальная настройка DB PostgreSQL.
Выпущены сертификаты клиентские/серверные для:
Istio (ingress, egress) при использовании;
сертификаты для подключения к PostgreSQL по SSL при необходимости;
сертификат для ОТТ при необходимости.
Произведен Deploy в системе оркестрации контейнеризированных приложений;
Подготовлено окружение в соответствии с типовой инструкцией по настройке Job (Deploy, Service) при установке через Installer.
Разработка первого приложения с использованием программного продукта#
После подключения компонента в соответствии с пунктом Подключение и конфигурирование настоящего руководства необходимо получить у администратора публичный ключ Руководство оператора пункт Пользователи API.
Использование программного компонента#
Примеры использования API:
App-api:
https://\<stand-url\>/app-api/swagger-ui.html
Auth-api:
https://\<stand-url\>/auth-api/swagger-ui.html
Datamart-api:
https://\<stand-url\>/datamart-api/swagger-ui.html
Inner-connector-api:
https://\<stand-url\>/inner-connector-api/swagger-ui.html
<stand-url> для Вашего домена можно уточнить у команды разработки.
Часто встречающиеся проблемы и пути их устранения#
При ошибке получения от компонента целевого контура канала, в который должен быть перенаправлен пользователь, проверьте корректность и работоспособность настройки, наличие сетевого доступа и сверьтесь со страничкой сваггера приложения, все ли требуемые параметры заполнены корректно и в соответствии со сваггером.
В случае получения 401-403 ошибок проверьте корректность логина и пароля, а так же наличие их в системе авторизации (компонент KeyCloak.SE (KCSE) продукта Platform V IAM SE (IAM)).