Руководство по системному администрированию продукта Platform V Product 360#
Основные понятия#
В таблице приведены основные аббревиатуры и сокращения:
Аббревиатура, сокращение |
Определение |
|---|---|
API |
Application programming interface |
Kafka |
Компонент Kafka Sber Edition (KFKA) продукта Platform V Corax (KFK) |
SPAS |
Сервис приложений сервиса авторизации |
АС |
Автоматизированная система – совокупность взаимосогласованных компонентов программного, технического, информационного, организационного, методического, правового обеспечения, используемая для автоматизации заданных бизнес-функций. Через прикладной интерфейс АС пользователь получает доступ к информационным ресурсам |
ОЗУ |
Оперативное запоминающее устройство |
ИФТ |
Интеграционное-функциональное тестирование |
СУДИР |
Система управления доступом и ресурсами |
Платформа |
Platform V |
Продукт |
PD36 Platform V Product 360 |
ФП |
Функциональная подсистема – дополнительный к АС объект управления в ИТ-процессах, представляющий собой совокупность компонентов программного обеспечения, реализующую логически связанное подмножество функциональности АС |
ЦПУ |
Центральное обрабатывающее устройство |
Сценарии администрирования#
Администратору рекомендуется регулярно выполнять:
контроль состояния работы Продукта;
мониторинг производительности Продукта;
контроль свободного места на жестких дисках всех серверов Продукта, а также в файловой системе.
При выявлении нештатных ситуаций необходимо:
проверить работоспособность всех сервисов Продукта;
проверить логи на наличие ошибок.
В рамках выполнения требований безопасной работы Продукта Администратор выполняет следующие функции:
осуществляет контроль использования средств защиты информации;
осуществляет контроль доступа к обрабатываемым данным пользователями, согласно с их правами доступа к АС;
несет ответственность за качество проводимых им работ.
Доступ к АС должны иметь только те сотрудники, которым он необходим в соответствии с их должностными обязанностями. Доступ должен ограничиваться минимально необходимым объемом данных. Должны разделяться среды разработки, тестирования и эксплуатации, при этом, необходимо производить разделение обязанностей между разработчиками АС, тестирующим персоналом и сотрудниками, непосредственно эксплуатирующими уже введенные в промышленную эксплуатацию Продукта. Специалисты, занимающиеся администрированием компонента "Управление параметрами", должны обладать следующими навыками:
развертывание и администрирование приложений в OSE;
настройка сервера NGINX;
работа с СУБД PostgreSQL.
Резервное копирование данных обеспечивается штатными средствами инфраструктуры, в которой разворачивается продукт, в соответствии с эксплуатационной документацией на аппаратные и программные средства, входящие в состав программно-технического комплекса, на котором размещается продукт.
Продукт не нуждается в специальном администрировании, влияющем безопасность данных. Настройки безопасности осуществляются за пределами конфигурации приложения (см. Руководство по безопасности продукта).
Продукт не нуждается в специальном администрировании, влияющем на безопасность данных. Настройки безопасности осуществляются за пределами конфигурации приложения (см. Руководство по безопасности продукта).
Рекомендации по механизмам настройки аутентификации и авторизации отражены в руководстве по безопасности компонента «Управление параметрами» в разделах «Аутентификация» и «Авторизация». Сценарии администрирования, выполняемые системным администратором при установке дистрибутива, приведены в документе Руководство по установке продукта Platform V Product 360 (P36).
Рекомендации по заданию стойких паролей#
Пароль для входа в АС считается стойким, если он удовлетворяет следующим условиям:
длина пароля составляет не менее 8 символов;
в качестве пароля не используется имя учетной записи;
пароль образован из цифр, строчных и прописных букв;
в пароле используется минимум 6 разных символов.
Функции#
В таблице представлены основные функции продукта:
Таблица – Функции продукта
Группа |
Наименование |
Внешняя доступность |
Описание |
|---|---|---|---|
Онбординг |
Импорт данных |
Нет |
Выполняется проверка корректности загружаемого содержимого, формируется журнал результатов. Осуществляется дополнительный контроль списка модифицируемых загрузкой сущностей |
Pull-коннекторы |
Нет |
Коннекторы помогают организовать процесс автоматического импорта данных из различных каналов |
|
Сводка |
Нет |
Позволяет следить за состоянием каталога. Вся важная информация на одной странице: статусы черновиков, задачи на ревью изменений |
|
API управления информацией о продукте |
Да |
API для каталога продуктов, предполагает создание характеристик, спецификаций и офферов |
|
Пользовательский интерфейс управления информацией о продукте |
Управление характеристиками |
Нет |
Возможность определять структуру продукта, который может состоять как из простых характеристик (строка, число), так и из сложных (одиночный или множественный выбор из списков опций, файл или изображение).Возможна настройка валидации характеристик |
Карточки продуктов |
Нет |
Функциональность наполнения продуктов контентом и данными. Стандартизованная структура продуктового предложения. Структурирование характеристик по разделам. Гибкая настройка доступа пользователей к разделам |
|
Управление данными в каналах |
Нет |
Возможность настраивать состав каналов и значения характеристик в зависимости от канала продаж |
|
Управление каталогами продуктов |
Представление продуктовой линейки в виде древовидного каталога категорий, настройка прав доступа к каждой категории. Назначение для каждой категории группы владельцев, группы редакторов и группы просмотрщиков |
||
Управление версиями |
Нет |
Возможность восстановить продукт к предыдущей версии, а также просмотреть всю историю изменений. Версионирование продуктовых спецификаций |
|
Управление отношениями между продуктами |
Нет |
Возможность объединять продуктовые предложения в пакетные предложения. При необходимости можно расширять наборы связей между продуктами. Создание произвольного вида отношений (бандл, опция и т.д.) |
|
Управление ценами и вариантами |
Для управления ценами реализованы разовые, периодические начисления. Предусмотрена возможность расширения видов начислений и настройка вариантов продуктовых предложений |
||
Аудит и безопасность |
Настройка уровней доступа к характеристикам |
Нет |
Характеристики объединяются в группы по бизнес-смыслу.Пользователи группируются в бизнес-группы. Возможна настройка прав на просмотр или редактирование сгруппированных характеристик для бизнес-групп |
Настройка уровней доступа к каталогам и категориям |
Нет |
Продуктовую линейку можно разделить на древовидный каталог категорий. Можно настроить права доступа к каждой категории различным группам пользователей независимо. Каждой категории могут быть назначены группы-владельцы, группы-редакторы и группы-просмотрщики |
|
Контроль полноты и корректности заполнения |
Контролировать процент заполнения продуктовых данных в различных каналах можно с помощью продуктовых спецификаций. Отслеживать заполненность комплексно можно на основе сводки |
||
Публикации |
Push-коннекторы |
Нет |
Коннекторы помогают организовать процесс автоматического экспорта данных в различные каналы |
Экспорт данных |
Нет |
Выполняется проверка корректности выгружаемого содержимого, формируется журнал результатов |
|
API опубликованных предложений |
Да |
API на получение и фильтрацию опубликованных предложений |
Общий порядок регистрации пользователей#
Добавление учетных записей пользователей (Информация для внутренних пользователей)#
Запуск сеанса работы SPAS#
Для распределения прав доступа к данным модуля в разработческой среде/контуре используется подсистема доступа SPAS. Для распределения прав доступа к данным модуля ПРОМ применяется СУДИР.
Последовательность создания и назначения пользователям прав в SPAS (пункты 1-4 выполняются только при настройке/обновлении модуля):
Войдите в SPAS под ролью Администратор по ссылке: https://<хост>:<номер порта>/spas/admin.
Зарегистрируйте модуль какой модуль (наименование) в меню SPAS (Модули → Подключить модуль).
Загрузите (обновите) права/роли для модуля какой модуль (наименование).
Создайте пользователя, предоставив ему соответствующие права и роли. Через меню Пользователи → Создать.
Для работы пользователь прежде всего должен быть создан в СУДИР. Пользователь, заведенный в СУДИР может иметь следующие роли:
системный администратор всех тенантов;
бизнес-администратор тенанта;
бизнес-пользователь тенанта.
Создание пользователя в SPAS#
Для того чтобы создать пользователя в SPAS:
Авторизуйтесь под ролью Бизнес Администратор.
В меню выберите вкладку Пользователи и нажмите на кнопку Создать.
Откроется окно Создание пользователя.
Заполните необходимые параметры и нажмите на кнопку Создать. Выйдет информационное окно об успешном создании пользователя.
Перечень всех прав/ролей для бизнес-пользователей:
Название роли |
Доступные действия |
|---|---|
Бизнес-администратор Тенанта |
Добавление пользователя в тенант. Исключение пользователя из тенанта. Изменение доступов пользователя в тенанте |
Бизнес-пользователь Тенанта |
Доступ к работе с: продуктовым предложением; характеристиками; группами характеристик; категориями |
Системный администратор (менеджер тенантов) |
Редактирование параметров тенантов. Формирование нового тенанта. Переключать режим работы в существующих тенантах. Добавлять пользователя в Тенант (без указания роли) |
Ограничение деятельности пользователей#
Блокировка учетной записи пользователя#
При необходимости ограничить доступ пользователю к продукту (например, при увольнении сотрудника из организации или прекращении его деятельности в Продукте), следует заблокировать или удалить учетную запись пользователя из списка пользователей Продукта. В результате возможность запускать сеанс работы с каким-либо модулем Продукта и выполнять какие-либо действия в Продукте станут пользователю недоступными.
Блокировка учетной записи пользователя выполняется в SPAS.
При блокировке учетной записи пользователя документы и присоединенные к ним файлы, связанные с указанной учетной записью, не будут заблокированы. Они останутся в БД Системы и будут доступны для поиска и дальнейшей обработки, пользователями, входящими в тот же тенант, что и заблокированный пользователь.
Если пользователь числится в нескольких подразделениях организации или в нескольких группах пользователей, после блокировки его учетной записи из БД Системы подразделения пользователя и группы пользователя не будут заблокированы.
Для того чтобы заблокировать учетную запись пользователя:
Авторизуйтесь под ролью Администратор.
В меню выберите вкладку Пользователи, в рабочей области в списке пользователей выделите строки с учетными записями пользователей, которые следует заблокировать.
На верхней рабочей панели нажмите на кнопку Заблокировать. Откроется окно с сообщением о подтверждении блокировки учетных записей.
Также блокировка учетной записи возможна в результате:
изменения ролей в SPAS;
изменения состава прав текущей роли пользователя;
установки пользователю хотя бы одной роли, которая для него заблокирована (не сочетается со SPAS-ролью).
Удаление учетной записи пользователя#
Удаление учетной записи пользователя из списка пользователей осуществляющих работу в Продукте выполняется в SPAS.
При удалении учетной записи пользователя документы и присоединенные к ним файлы, связанные с указанной учетной записью, удалены не будут. Они останутся в БД Продукта и будут доступны для поиска и дальнейшей обработки.
Если пользователь числится в нескольких подразделениях организации или в нескольких группах пользователей, после удаления его учетной записи из БД Продукта подразделения пользователя и группы пользователя удалены не будут.
После удаления учетной записи из БД Продукта, разрываются все связи учетной записи с документами и задачами. Если впоследствии будет зарегистрирован новый пользователь с таким же регистрационным именем, он будет рассматриваться в СПродукте как другой пользователь, и не унаследует связи удаленной учетной записи.
Для того чтобы удалить учетные записи пользователей из списка пользователей Продукта:
Авторизуйтесь под ролью Администратор.
В меню выберите вкладку Пользователи, в рабочей области в списке пользователей выделите строки с учетными записями пользователей, которые следует удалить.
Нажмите на кнопку Удалить. Откроется окно с сообщением о подтверждении удаления учетных записей.
Для того чтобы удалить учетную запись пользователя, нажмите на кнопку Да. Строки с учетной записью пользователей будут удалены из списка пользователей. Для того чтобы отменить удаление учетных записей, нажмите на кнопку Нет.
Администратор Продукта не имеет возможности удалить самого себя, поскольку не допускается удаление пользователя, пока он не завершит сеанс работы в Продукте.
Назначение ролей#
Наделение пользователя ролями в Продукте выполняется в SPAS.
Для того чтобы пользователь обладал определённой ролью.
Авторизуйтесь под ролью Администратор.
В меню выберите вкладку Пользователи, в рабочей области в списке пользователей выделите строку с учетной записью пользователя, которому нужно назначить роль.
Нажмите на кнопку Роли, откроется окно Роли пользователя.
Далее нажмите на кнопку Добавить, откроется список доступных ролей.
Выберите нужную роль и нажмите на кнопку
в результате роль из списка доступных ролей будет перемещена в добавленные роли.Нажмите на кнопку Добавить. Роль будет отображаться в окне Роли пользователя.
Нажмите на кнопку Сохранить. Пользователю будет присвоена выбранная роль.
Снятие ролей#
Для того чтобы снять назначение пользователю роли:
Авторизуйтесь под ролью Администратор.
В меню выберите вкладку Пользователи, в рабочей области в списке пользователей выделите строку с учетной записью пользователя, которому нужно назначить роль.
Нажмите на кнопку Роли, откроется окно Роли пользователя.
Далее нажмите на кнопку Добавить, откроется список доступных ролей.
В окне Добавленные роли выберите роль назначение которой нужно снять и нажмите на кнопку
. Роль из окна Добавленные роли будет перемещена в окно Список допустимых ролей.Нажмите на кнопкуДобавить, в результате в окне Роли пользователя данная роль будет отсутствовать. Нажмите на кнопку Сохранить.
Удаление роли пользователя#
Для того чтобы удалить роль пользователя:
Авторизуйтесь под ролью Администратор.
В меню выберите вкладку Пользователи, в рабочей области в списке пользователей выделите строку с учетной записью пользователя, которому нужно назначить роль.
Нажмите на кнопку Роли, откроется окно Роли пользователя.
Выделите строку с ролью пользователя, которую нужно удалить, далее нажмите на кнопку Удалить.
Роль пользователя будет удалена.
События системного журнала#
В продукте реализован механизм логирования с использованием инструментов компонента Журналирование (LOGA) продукта Platform V Monitor.
Для системного журнала используются следующие приоритеты:
ERROR:
Ошибки вызова сервисов платформы, кроме отправки метрик в компонент объединенный мониторинг Unimon продукта Platform V Monitor.
Ошибки интеграционных вызовов.
WARNING:
Ошибки отправки метрик в компонент "Прикладной мониторинг Platform V Monitor".
Некритичные ошибки, кроме ошибок отправки метрик в "Прикладной мониторинг Platform V Monitor"
INFO: сообщения о вызове и возврате из вызова интеграционного адаптера.
DEBUG:
Все входные и выходные параметры операций FG, CG, BS, DA, сервисов.
Все входные и выходные параметры вызовов интеграционных адаптеров.
Ниже представлена таблица с ошибками:
Класс |
Сообщение |
Причина возникновения |
|---|---|---|
JobLaunchesService |
Exception during launches processing |
Возникает при невозможности запустить экспорт импорт |
TenantService |
Error checksum {} tenant {} . Try repeat 2 hours |
Возникает при ошибке синхронизации витрины и сигнализирует о попытке синхронизации витрины на 2 часа назад |
TenantService |
Error checksum {} tenant {} . Try repeat from begin |
Возникает при ошибке синхронизации витрины и сигнализирует о попытке синхронизации витрины с нуля |
TenantService |
Error checksum. Need clear tenant {}. |
Возникает при ошибке синхронизации витрины и сигнализирует о невозможности синхронизировать витрину автоматически |
JournalClientImp |
lREPLICATION FAILED: Unable to handle journal |
Недоступность прикладного журнала |
GlobalExceptionHandler |
stepName null launchType IMPORT |
Запущен импорт пустого файла данных |
AjKafkaAvailabilityCheckerImpl |
[bootstrap.servers =]Ошибка при проверке доступности kafka |
Недоступна кафка |
EntityNotFoundException |
User was not found |
Пользователь, под которым вы пытаетесь авторизоваться отсутствует в каких-то тенантах |
GlobalExceptionHandler) |
could not extract ResultSet; SQL [n/a]; nested exception is org.hibernate.exception.SQLGrammarException: |
Миграции не установлены |
SpasAuthenticationInterceptor |
Error text: User login not specified in request |
Пользователь из системы авторизации пришел некорректно(отсутствуют права или кука с логином) |
События мониторинга#
В продукте реализован мониторинг событий с использованием инструментов компонента Прикладной мониторинг продукта Platform V Monitor.
Метрики компонента приведены в таблице.
Название метрики |
Точка мониторинга |
Тип метрики |
Название сервиса |
|---|---|---|---|
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 |
Часто встречающиеся проблемы и пути их устранения#
Продукт использует репликатор для обеспечения безотказного функционирования рабочего состояния БД в случае сбоев или отказов.
Если произошел сбой БД, запустите репликацию Stand-In и убедиться, что все данные были реплицированы в восстановленную БД.
При ошибке получения топологии из Stand-In проверьте корректность настройки baseurl ФП Stand-In в ФП Stand-In и работоспособность самой ФП Stand-In.
При отсутствии доступных компонентов убедитесь, что:
пользователю назначена роль бизнес Администратора;
в продукте настроена привязка привилегий к узлам топологии.
При ошибке получения привилегий пользователя проверьте корректность настроек.
Список наиболее часто встречающихся проблем при работе с продуктом у пользователей, при которых необходимо обратиться к администратору приведены в таблице ниже:
Возможные варианты возникновения проблем |
Изображение на экране |
Варианты решения проблемы |
|---|---|---|
Пользователь не заведен в SPAS. Пользователь заведен в SPAS, но НЕ имеет право на P360 в SPAS |
Окно авторизации |
1. Создать пользователя в SPAS. 2. Проверить правильность назначения роли в SPAS |
Пользователь не привязан к Тенанту в Product 360 |
|
1. Администратор должен добавить пользователя в Product360. 2.Если пользователя не удается добавить – проверить есть ли пользователь в SPAS и назначены ли пользователю необходимые роли |
Пользователь добавлен в Тенант, но ему еще не присвоена Роль. Пользователь добавлен в Тенант и ему присвоена роль, в которой не выдано ни одного разрешения |
|
1. Назначить роль пользователю. 2. Добавить необходимые полномочия роли, при их отсутствии |
Пользователь добавлен в Тенант и ему присвоена роль, в которой выдано несколько прав. Но пользователь попал на страницу, к которой не имеет доступа |
|
Отредактировать роль пользователя, добавить недостающие полномочия |
Пользователь: есть в SPAS и в СУДИР; имеет право на P360 в SPAS; не призван к Тенанту в P360, хотя по SPAS-роли может туда обращаться (например, пользователя еще не добавили в Тенант или уже удалили из него) |
|
Администратор должен добавить пользователя в Product360 |
Пользователь есть в SPAS и в СУДИР и имеет право на P360 в SPAS: не присвоена роль; ему присвоена роль, в которой не выдано ни одного разрешения |
|
1. Назначить роль пользователю. 2. Добавить необходимые полномочия роли, при их отсутствии |
Пользователь попал на страницу, к которой не имеет доступа |
|
Отредактировать роль пользователя, добавить недостающие полномочия |
Перечень приведенных проблем напрямую оказывает влияние на обеспечение доступности информации. Во избежание негативных последствий связанных с недоступностью информации, рекомендуется после создания роли (пользователя) и выдачи ей прав/редактирования прав, уже созданных ролей (пользователей), проводить проверку функционирования системы разграничения доступа путем пробных попыток доступа к тем или иным функциональным возможностям продукта.