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

Данный раздел описывает процесс работы с секретами в системе. Работа осуществляется в разделе Ресурсы → Секреты веб-интерфейса системы.

Раздел доступен администраторам, пользователям, которые имеют соответствующее разрешение в составе своих ролей, а также учетным записям со статусом Суперадминистратор.

О секретах

Секрет — это компонент системы, который обеспечивает безопасное хранение чувствительных данных, таких как учетные данные, токены, строки подключения, сертификаты, приватные ключи. Секреты позволяют ссылаться на эти данные и использовать их без явного указания в различных объектах системы.

Секреты можно использовать в конфигурации конвейера для подключения к источникам данных в точках входа и/или внешним системам в конечных точках.

Конвейеры по умолчанию используют те данные секрета, с которыми была установлена их конфигурация. Если в параметры секрета были внесены изменения, то для их принятия на том или ином конвейере необходимо переустановить его конфигурацию.

Интерфейс раздела

Панель инструментов раздела включает в себя следующие компоненты:

Кнопка Создать () позволяет создать новый секрет.
Поле Поиск предназначено для быстрого поиска секретов в отображаемом списке по названию.
Кнопка Фильтр () позволяет открыть в правой части рабочей области панель для настройки фильтрации списка секретов.

В рабочей области отображается таблица имеющихся секретов. Таблица содержит следующие столбцы:

Название — имя секрета, используемое для его идентификации в системе.
Организация — организация, к которой принадлежит секрет.
Описание — краткое описание функциональности секрета.
Тип — тип информации, хранящейся в секрете.
Статус — текущий статус секрета: Включен или Выключен.
Дата создания — дата и время создания секрета.
Дата изменения — дата и время последнего изменения секрета.

При работе с таблицей секретов доступны следующие операции:

Поиск секретов по полю Название.
Фильтрация секретов по полям Статус и Тип. Статус и тип выбираются из выпадающих списков.
Сортировка секретов по полям Название, Дата создания и Дата изменения.
Настройка отображения таблицы.

При выборе конкретного секрета в правой части рабочей области отображается его карточка с детальной информацией.

Работа с секретом

Доступные операции над секретами:

Создание секрета
Просмотр секрета
Включение секрета
Изменение секрета
Удаление секрета

Создание секрета

Чтобы создать секрет:

Перейдите в раздел Ресурсы → Секреты. Система отобразит сведения об имеющихся секретах.
Нажмите на кнопку Создать (). Отобразится окно создания секрета.
Введите название секрета.
При необходимости введите описание секрета.
Выберите организацию, к которой должен принадлежать секрет.

Выберите из выпадающего списка Тип секрета тип информации, которая будет храниться в секрете, и задайте настройки выбранного типа:

Учетные данные — укажите имя пользователя и пароль.
Токен — укажите токен.

Строка подключения — введите строку подключения.

Строка подключения используется в точках входа AMQP и Database. Формат строки отличается в зависимости от типа и настроек точки.

Сертификат — загрузите файл сертификата. Допустимые форматы: DER, PEM (X.509).
Контейнер PKCS — контейнер представляет собой архив, в котором хранятся файл сертификата и файл приватного ключа. Чтобы настроить контейнер PKCS:
- Загрузите файл сертификата. Допустимые форматы: DER, PEM (X.509).
- Загрузите файл приватного ключа. Допустимые форматы: DER, PEM (PKCS#8).
- При необходимости укажите пароль для приватного ключа.
Контейнер PKCS#12 — контейнер представляет собой архив, в котором хранится файл сертификата с уже включенным в него приватным ключом. Чтобы настроить контейнер PKCS#12:
- Загрузите файл сертификата. Допустимый формат: PKCS#12.
- При необходимости укажите пароль для приватного ключа.
NATS Key — секрет предназначен для подключения к брокеру сообщений NATS с помощью приватного и публичного ключей. Чтобы настроить NATS Key, введите приватный ключ NKey Seed и публичный ключ NKey User.

Нажмите на кнопку Создать. Система создаст секрет и отобразит соответствующее уведомление. Новый секрет появится в списке раздела Ресурсы → Секреты.

Просмотр секрета

Чтобы просмотреть секрет:

Перейдите в раздел Ресурсы → Секреты. Система отобразит сведения об имеющихся секретах.
Нажмите на строку секрета в списке. Система отобразит в правой части экрана карточку этого секрета с подробной информацией о нем.

В верхней части карточки отображается название секрета.

Чтобы изменить ширину карточки, наведите курсор на ее левую границу. Курсор примет вид двунаправленной стрелки. Перетащите левую границу карточки в нужном направлении.

Карточка содержит следующие поля:

ID — уникальный идентификационный код секрета, генерируемый автоматически при его создании.
Название — имя секрета, используемое для его идентификации в системе.
ID тенанта — уникальный идентификационный код тенанта, к которому относится секрет.
Статус — текущий статус секрета: Включен или Выключен.
Описание — краткое описание функциональности секрета.
Организация — организация, к которой принадлежит секрет.
Тип секрета — тип информации, хранящейся в секрете.
Дата создания — дата и время создания секрета.
Создал — пользователь, инициировавший создание секрета.
Дата изменения — дата и время последнего изменения секрета.
Изменил — пользователь, выполнивший последнее изменение секрета.

Можно экспортировать секрет из объектного хранилища NATS Object Store.

Включение секрета

Для того чтобы использовать секрет в системе, его нужно включить.

Чтобы включить секрет:

Перейдите в раздел Ресурсы → Секреты. Система отобразит сведения об имеющихся секретах.
Нажмите на строку секрета в списке. Система отобразит в правой части экрана карточку этого секрета с подробной информацией о нем.
Установите переключатель состояния секрета в верхней части карточки в активное положение. Отобразится окно подтверждения включения секрета.
Нажмите на кнопку Включить. Система включит секрет и отобразит соответствующее уведомление. Секрет станет доступен для добавления в объекты системы.

Если при включении секрета возникли ошибки, система отобразит сообщение об этом. Для просмотра списка ошибок нажмите на кнопку Показать.

Чтобы выключить активный секрет:

Перейдите в раздел Ресурсы → Секреты. Система отобразит сведения об имеющихся секретах.
Нажмите на строку секрета в списке. Система отобразит в правой части экрана карточку этого секрета с подробной информацией о нем.
Установите переключатель состояния секрета в верхней части карточки в неактивное положение. Отобразится окно подтверждения выключения секрета.

Нажмите на кнопку Выключить. Система выключит секрет и отобразит соответствующее уведомление. Секрет перестанет быть доступным для добавления в объекты системы.

Объекты, использующие секрет, продолжат его использовать даже после выключения. Выключение секрета запрещает только его новое добавление в объекты системы.

Изменение секрета

Вы можете изменить секрет следующими способами:

через меню действий в карточке секрета;
через изменение полей в карточке секрета.

После изменения секрета связанные с ним сущности не обновляют данные автоматически. Чтобы применить новые параметры секрета в требуемой сущности, необходимо выполнить ручные действия:

переустановить конфигурации конвейеров;
остановить и повторно запустить шлюзы;
повторно выбрать публичный ключ вендора и ключи инсталляции для агентов.

Удаление секрета

Вы можете удалить секрет через меню действий в его карточке.

Удаление недоступно для секретов, используемых на конвейерах.

Была ли полезна эта страница?

Обратная связь