salt '*' test.ping
Работа с модулем инвентаризации
Модуль инвентаризации (lcm-inventory) предназначен для сбора и хранения данных о пользователях
и устройствах компании, а также для работы с группами (коллекциями) автоматизированных рабочих
мест (далее — АРМ), которые могут быть сформированы по различным признакам.
Коллекция АРМ — это множество АРМ, которое формируется в результате фильтрации всех АРМ по атрибутам самих АРМ и атрибутам пользователей, ассоциированных с ними.
Подробнее о создании и обновлении коллекций АРМ см. в разделе «Создание и обновление коллекций АРМ».
Модуль инвентаризации обеспечивает следующие способы загрузки атрибутов в коллекции АРМ:
Импорт данных из SaltStack по аппаратной конфигурации АРМ
Модуль инвентаризации позволяет импортировать следующие технические характеристики АРМ с платформы SaltStack:
-
актуальные данные по аппаратной конфигурации АРМ;
-
актуальные данные системного ПО АРМ;
-
список фактически развернутого прикладного и системного ПО на АРМ.
Данные поступают от Миньонов с помощью механизма Grains на узел Мастер согласно расписанию, заданному в конфигурации Salt.
Мастер публикует их в виде события в канале REST endpoint Events, который прослушивается LCM.
Каждое из таких событий содержит технические характеристики по одному из Миньонов, которые актуализируются в БД модуля инвентаризации:
| Параметр в АРМ из ответа SALT | Параметр в LCM БД | Описание |
|---|---|---|
|
|
Идентификатор Миньона Salt |
|
|
Короткое имя АРМ (NetBIOS name) |
|
|
Полное доменное имя АРМ |
|
|
Набор доменных адресов IPv4 |
|
|
Имя домена |
|
|
Количество ядер процессора |
|
|
Модель процессора |
|
|
Архитектура процессора |
|
|
Объем ОЗУ |
|
|
Общий физический размер свопинга |
|
|
Физические адреса сетевого оборудования (MAC) |
|
|
Шлюз Ipv4 |
|
|
Сетевые интерфейсы IPv4 |
|
|
Сетевые интерфейсы IPv6 |
|
|
Диски SSD |
|
|
Диски HDD |
|
|
Серийный номер устройства |
|
|
Ядро ОС |
|
|
Релиз ядра ОС |
|
|
Код дистрибутива ОС |
|
|
Описание версии ОС |
|
|
Код версии ОС |
|
|
Архитектура ОС |
|
|
Полное наименование ОС |
|
|
Мажорная версия релиза ОС |
|
|
Версия релиза ОС |
|
|
Версия Salt на Миньоне |
|
|
Имя Мастера Salt |
|
|
Версия Python для Salt на Миньоне |
|
|
Дата и время актуализации характеристик |
Импорт данных по учётным записям пользователей c сервера LDAP
Импорт учетных данных пользователей сервера LDAP выполняется согласно расписанию, которое задается в конфигурационных параметрах.
После синхронизации в БД для модуля инвентаризации (lcm-inventory) в таблицах users и user_groups
появляется информация о пользователях домена и их группах:
| Параметр на LDAP-сервере | Параметр в БД LCM | Описание |
|---|---|---|
objectGUID |
users.id |
Уникальный идентификатор пользователя |
sAMAccountName |
users.login |
Имя пользователя для входа в систему (Логин) |
userPrincipalName |
users.domain_full_name |
Полное доменное имя пользователя (например |
userPrincipalName (подстрока) |
users.domain |
Имя домена в короткой форме записи (например |
users.email |
Адрес электронной почты |
|
cn |
users.common_name |
Общее имя пользователя |
name |
users.first_name |
Короткое имя пользователя |
givenName |
users.given_name |
Имя пользователя |
sn |
users.last_name |
Фамилия пользователя |
displayName |
users.display_name |
Отображаемое имя пользователя |
title |
users.title |
Должность пользователя |
department |
users.department |
Отдел, в котором работает пользователь |
company |
users.company |
Подразделение, в котором работает пользователь |
memberOf |
user_groups.group_name |
Группы пользователя, связь один к многим |
Расписание выполнения синхронизации пользователей
Синхронизация происходит с помощью встроенного в продукт планировщика задач по расписанию.
Управление расписанием осуществляется с помощью параметра в файле application.properties:
lcm.inventory.job.sync-users.cron.expr=*/5 * * * * ?Значением данного параметра выступает выражение cron-like.
Значение параметра по умолчанию 0 0 12 * * ? соответствует ежедневному запуску задания в 00:00:00.
Для выключения задания синхронизации используется значение указанного параметра off:
lcm.inventory.job.sync-users.cron.expr=offСинхронизация пользователей может быть осуществлена из нескольких доменов LDAP-сервера и выполняется последовательно.
Для задания параметров подключения к каждому из доменов заполните следующий набор параметров
группы lcm.inventory.ldap.datasource[i] в файле application.properties:
# максимальное количество пользователей для одной итерации синхронизации
lcm.inventory.ldap.search-page-size=500
# Блок параметров подключения к домену номер #1 (нумерация с 0)
# условное обозначение домена
lcm.inventory.ldap.datasource[0].name=domain_alias1
# IP адрес или сетевое имя контроллера домена
lcm.inventory.ldap.datasource[0].host=192.168.0.1
# Порт для соединения по протоколу LDAP. Опционален, по умолчанию имеет значение `389`.
# Для LDAP over SSL обычно используют порт 636
lcm.inventory.ldap.datasource[0].port=636
# Имя пользователя, которое будет использовано для подключения к домену MS AD.
# Может иметь следующие форматы
# 1) <имя_пользователя>@<имя домена>, например ivanov@INNO
# 2) Пользователь в формате LDAP, например CN=ivanov,CN=Users,DC=inno,DC=local
lcm.inventory.ldap.datasource[0].username=username1@domain1_name
# Пароль пользователя для подключения к домену MS AD.
lcm.inventory.ldap.datasource[0].password=user_password
# Параметр отвечающий за соединение по протоколу LDAP over SSL (LDAPS).
# Возможные значения:
# 1) false - соответствует выключенному протоколу LDAPS, используется обычный LDAP
# 2) true - соответствует включенному протоколу LDAPS, требует наличие файла с сертификатом для SSL соединения (задается отдельным параметром)
# 3) trust-all - соответствует включенному протоколу LDAPS, принимает любые сертификаты без подтверждения
# Опционален, по умолчанию имеет значение `false`
lcm.inventory.ldap.datasource[0].ssl=true
# Относительный или абсолютный путь к файлу с сертификатом для подключения через LDAPS.
# Опционален, по умолчанию имеет значение `certificate.pem`
# Формат файла с сертификатом SSL и способ его получения описаны ниже
lcm.inventory.ldap.datasource[0].ssl-certificate=/home/username/cert1.pem
# Базовое имя домена для поиска пользователей в формате записи LDAP
lcm.inventory.ldap.datasource[0].base-dn=DC=domain_name1,DC=local
# Максимальная длительность подключения к LDAP серверу в миллисекундах. Значение `0` означает бесконечное ожидание.
# Опционален, по умолчанию имеет значение `10000`
lcm.inventory.ldap.datasource[0].connect-timeout-millis
# Максимальная длительность выполнения запроса к LDAP серверу в миллисекундах. Значение `0` означает бесконечное ожидание.
# Опционален, по умолчанию имеет значение `10000`
lcm.inventory.ldap.datasource[0].response-timeout
# Параметр отвечает за освобождение соединения в случае превышения максимальной длительности ожидания запроса.
# Возможные значения `true` и `false`
# Опционален, по умолчанию имеет значение `true`
lcm.inventory.ldap.datasource[0].abandon-on-timeout
# Указывает, разрешать ли использование экземпляра фабрики сокетов (который может совместно использоваться несколькими соединениями)
# для одновременного создания нескольких сокетов. Как правило, реализации фабрики сокетов являются потокобезопасными
# и могут создавать несколько соединений одновременно в отдельных потоках, но известно, что это не так в некоторых
# реализациях виртуальных машин (например, фабрики сокетов SSL в IBM JVM). Этот параметр может использоваться, чтобы указать,
# следует ли разрешить одновременные попытки создания сокета (что может обеспечить лучшую и более стабильную производительность,
# особенно в случаях, когда попытка подключения не удалась из-за тайм-аута) или предотвратить (что может быть необходимо для
# непотокового реализации фабрики сокетов)
# Возможные значения `true` и `false`
# Опционален, по умолчанию имеет значение `true`
lcm.inventory.ldap.datasource[0].allow-concurrent-socket-factory-use
# Блок параметров подключения к домену номер #2
lcm.inventory.ldap.datasource[1].name=domain_alias2
lcm.inventory.ldap.datasource[1].host=192.168.0.2
lcm.inventory.ldap.datasource[1].port=389
lcm.inventory.ldap.datasource[1].username=username2@domain2_name
lcm.inventory.ldap.datasource[1].ssl=false
lcm.inventory.ldap.datasource[1].base-dn=DC=domain_name2,DC=local
# Блок параметров подключения к домену номер #3
lcm.inventory.ldap.datasource[2].name=domain_alias2
#...Импорт данных о связи пользователей и устройств из CSV-файла
Модуль инвентаризации позволяет импортировать в БД LCM информацию о связи пользователей
и устройств посредством загрузки данных из CSV-файла через
пользовательский интерфейс администратора (см. документ «Руководство администратора»).
CSV-файл должен быть определенного формата: содержать 3 столбца и в качестве разделителя
использовать точку с запятой ; определенного формата:
<operation>;<user_name>@<user_domain>;<fqdn>
Где:
-
Параметр первого столбца
operationдолжен содержать одну из следующих команд (перечислены в порядке приоритета выполнения):-
R— (от англ.: remove) удалить связь между пользователем и устройством. -
RA— (от англ.: remove all) удалить все связи, существующие по указанному пользователю/устройству. Требуется заполнить илилогин@доменпользователя, или полное доменное имя машины. -
A— (от англ.: add) создать или обновить связь между пользователем и устройством.
-
-
Параметр второго столбца
user_nameдолжен содержать логин пользователя в указанном домене. Например,aspushkinилиfmdostoevskiy. -
Параметр второго столбца
user_domainдолжен содержать домен пользователя и соответствовать полному имени домена пользователя, выгруженному с сервера LDAP. Например,inno.techилиsaratov.vtb.ru. -
Парамер третьего столбца
fqdnдолжен содержать полное доменное имя АРМ, выгруженного из SaltStack, например:kassa256.vtb.ru.
Пример заполнения файла CSV:
A;username1@domain.name;notebook1.domain.name A;username1@domain.name;notebook2.domain.name A;username2@domain.name;notebook1.domain.name RA;username1@domain.name; RA;username2@domain.name; RA;;notebook1.domain.name R;username2@domain.name;notebook2.domain.name
Строки, не соответствующие описанному формату записи, будут проигнорированы.
Записи в файле обрабатываются пакетами (батчами) по очереди и последовательно с группировкой по типу операции. Записи группируются по типам в следующем порядке:
-
Удаление конкретного пользователя с конкретного АРМ.
-
Удаление связок по идентификатору пользователя.
-
Удаление связок по идентификатору АРМ.
-
Добавление связок.
После завершения импорта список проигнорированных строк и количество успешно загруженных будут возвращены на пользовательский интерфейс администратора.
Создание и обновление коллекций АРМ
| При создании коллекции АРМ имя коллекции должно быть уникально. |
Список АРМ обновляется только при создании или вручную. Для создания/обновления коллекции администратор выполняет SQL-запрос к базе данных через пользовательский интерфейс (подробнее см. Руководство администратора).
SQL-запрос должен иметь тип select и в списке извлекаемых колонок содержать столбец minion_id.
|
При создании SQL-запроса нельзя использовать следующие операторы:
|
Шаблоны SQL-запросов
-
Запрос с использованием базовой информации по пользователям и устройствам:
select m.minion_id from users u join user_machine_mappings umm on umm.user_fdn = u.full_domain_name join machines m on m.fqdn = umm.machine_fqdn where <...>
-
Запрос с использованием подробной информации по устройствам:
select m.minion_id from machines m left join machine_disks md on md.minion_id = m.minion_id left join machine_networks mn on mn.minion_id = m.minion_id where <...>
-
Запрос с использованием всей информации, доступной в инвентаризации:
select m.minion_id from users u join user_machine_mappings umm on umm.user_fdn = u.full_domain_name join machines m on m.fqdn = umm.machine_fqdn left join machine_disks md on md.minion_id = m.minion_id left join machine_networks mn on mn.minion_id = m.minion_id where <...>
Рекомендации по сбору и предоставлению информации о проблеме/ошибке
В случае возникновения проблемы/ошибки в работе продукта «Служба управления конфигурациями» (LCM):
-
Предоставьте максимально детальное описание того, в чем заключается проблема/ошибка и в каких условиях она возникла:
-
какие действия выполнялись перед возникновением проблемы/ошибки;
-
какой результат ожидалось получить;
-
к какому фактическому результату привели выполненные действия;
-
если проблема возникла при использовании пользовательского интерфейса, если есть техническая возможность, сделайте скриншот/видеозапись экрана, на котором видно некорректное поведение приложения.
-
-
Попробуйте воспроизвести проблему/ошибку по составленному описанию.
-
Если проблема/ошибка возникла один раз и более не воспроизводилась, предоставьте логи на момент возникновения проблемы/ошибки, а также за 30 минут до и после ее возникновения без изменения существующего уровня логирования (см. раздел «Снятие логов»).
-
Направьте всю собранную информацию контактному лицу.
Снятие логов
Логи для продукта снимаются отдельно:
Сбор логов пользовательского интерфейса
При некорректной работе пользовательского интерфейса LCM соберите консольные и HAR-логи (логи взаимодействия браузера и сервера во время загрузки веб-страницы) в браузере.
Пример сбора логов для Яндекс Браузера:
-
Нажмите F12 на клавиатуре, чтобы открыть окно инструментов разработчика.
-
Перейдите на вкладку Сеть.
-
Нажмите на кнопку Запись сетевого журнала.
-
Воспроизведите проблему.
-
Нажмите на кнопку Остановить запись сетевого журнала.
-
Нажмите на правую кнопку мыши в сетевой таблице и выберите Сохранить все как HAR с контентом.
-
Выберите папку для сохранения логов и нажмите на кнопку Сохранить.
HAR-логи будут собраны и сохранены в указанной папке.
-
Нажмите F12 на клавиатуре, чтобы открыть окно инструментов разработчика.
-
Перейдите на вкладку Консоль.
-
Нажмите правой кнопкой мыши на любой строке и выберите в контекстном меню Сохранить страницу как.
-
Выберите папку для сохранения логов и нажмите на кнопку Сохранить.
Консольные логи будут собраны и сохранены в указанной папке.
Пример сбора логов для Chrome:
-
Нажмите F12 на клавиатуре, чтобы открыть окно инструментов разработчика.
-
Перейдите на вкладку Network.
-
Нажмите на кнопку
, чтобы очистить сетевой журнал. -
Выберите чек-боксы Preserve log и Disable cache.
-
Воспроизведите проблему.
-
Нажмите
, чтобы сохранить HAR-логи. -
Выберите папку для сохранения логов и нажмите на кнопку Сохранить.
HAR-логи будут собраны и сохранены в указанной папке.
-
Нажмите F12 на клавиатуре, чтобы открыть окно инструментов разработчика.
-
Перейдите на вкладку Console.
-
Нажмите правой кнопкой мыши в любой области окна и выберите в контекстном меню Save as.
-
Выберите папку для сохранения логов и нажмите на кнопку Сохранить.
Консольные логи будут собраны и сохранены в указанной папке.
Пример сбора логов для Firefox:
-
Нажмите F12 на клавиатуре, чтобы открыть окно инструментов разработчика.
-
Перейдите на вкладку Сеть.
-
Воспроизведите проблему.
-
Нажмите на правую кнопку мыши в сетевой таблице после воспроизведения проблемы и выберите Сохранить все как HAR.
-
Выберите папку для сохранения логов и нажмите на кнопку Сохранить.
HAR-логи будут собраны и сохранены в указанной папке.
-
Нажмите F12 на клавиатуре, чтобы открыть окно инструментов разработчика.
-
Перейдите на вкладку Консоль.
-
Нажмите правой кнопкой мыши на любой строке и выберите в контекстном меню Экспортировать видимые сообщения в и выберите Файл.
-
Выберите папку для сохранения логов и нажмите на кнопку Сохранить.
Консольные логи будут собраны и сохранены в указанной папке.
Сбор логов серверной части
Сбор логов серверной части включает сбор логов бэкенда продукта и логов внешних подсистем (например, SaltStack, LDAP-сервер, MS Active Directory). Подробнее о сборе логов внешних подсистем см. в официальной документации.
При некорректной работе серверной части LCM соберите логи из лог-файла, путь к которому задается
в параметре quarkus.log.file.path.
Путь к файлу: path/application.log (Подробнее см.
руководство по установке раздел «Параметры конфигурации бэкенда продукта»).