Графический интерфейс

Вход в платформу, навигация.

Требования к браузерам #

Рекомендуемое разрешение монитора: 1498×906.

Корректная работа графического интерфейса поддерживается в браузерах:

Браузеры, из которых интерфейс недоступен: IE, Opera Mini, UC Browser for Android, QQ Browser, Baidu Browser, KaiOS Browser.

Доступ #

Графический интерфейс платформы доступен по URL кластера управления (например, https://shturval.<домен-кластера>). Вход выполняется с учётными данными из подключённого LDAP-каталога или внешнего OIDC-провайдера.

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

Навигация #

Примечание: Графический интерфейс перестраивается в зависимости от разрешений пользователя: отображаются только те разделы и действия, к которым у пользователя есть доступ.

На стартовой странице веб-интерфейса доступны основные разделы:

• Кластер — работа с кластером управления, клиентскими кластерами и тенантами;
• Платформа — работа с правами доступа и инфраструктурой кластеров;
• О системе — сведения о лицензии, количестве узлов, версии платформы, используемых Open-Source компонентах; переход в Service Desk (Enterprise) или Telegram-канал (Community Edition), запуск Swagger.

Платформа #

На странице «Платформа» размещена основная информация:

• Доступ к платформе — количество системных и кастомных наборов доступа, подключение LDAP и внешних провайдеров аутентификации, активные сессии; назначение прав доступа;
• Провайдеры инфраструктуры — количество подключённых экземпляров провайдеров (VMware vSphere, oVirt, OpenStack, Shturval v2, Yandex Cloud, vCloud Director, Basis Dynamix);
• Пулы IP-адресов — количество пулов и свободных адресов;
• Счётчики кластеров управления и клиентских кластеров, узлов;
• Отчёты о ресурсах кластеров, анализе образов, политиках безопасности;
• Переход в Grafana (если включены shturval-dashboards и shturval-monitoring).

Внутри кластера #

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

На странице Неймспейсы список по умолчанию разделён на системные и несистемные неймспейсы. Переключатель в правом верхнем углу позволяет показать все неймспейсы на одной вкладке. Выбранный режим сохраняется.

Блоки можно раскрывать и сворачивать; всю боковую панель можно свернуть, чтобы освободить место для рабочей области.

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

Внутри неймспейса #

После выбора неймспейса в кластере доступны ресурсы, ограниченные этим неймспейсом:

Индикация состояния объектов #

В графическом интерфейсе доступна индикация состояния объектов. Индикатор предупреждения ⚠ отображается там, где есть счётчики объектов: в таблицах или на вкладках. Если среди объектов есть хотя бы один не в состоянии Ready, рядом со счётчиком появится индикатор.

Вкладка «Манифест» #

Для большинства объектов в графическом интерфейсе реализована вкладка Манифест, позволяющая просматривать и редактировать манифест объекта в формате YAML. Вкладка доступна на странице просмотра объекта (Pod, Deployment, Secret, ConfigMap, кастомный ресурс и др.). После внесения изменений выполните проверку (запуск dry-run) и сохраните манифест.

Импорт манифестов #

Импорт манифестов позволяет загружать YAML-манифесты объектов Kubernetes и кастомных ресурсов платформы (ShturvalServicePatch, VMRule, VMAlert и др.) без использования kubectl.

Где: иконка импорта слева от имени пользователя на любой странице кластера.

Требования: чтобы пользователь увидел иконку импорта манифестов, у него должно быть разрешение на создание хотя бы одного типа объекта в кластере. Пользователь сможет успешно импортировать только те манифесты, к добавлению ресурсов которых у него есть разрешения.

Как использовать #

1. Нажмите иконку импорта.
2. Введите манифест вручную, выберите файл или перетащите его в окно.
3. Для нескольких манифестов — разместите их в одном файле с разделителем ---.
4. Нажмите Проверить — выполнится DRY RUN (server) для проверки синтаксиса и валидности.
5. После успешной проверки нажмите Сохранить для применения (выполняется kubectl apply).

Манифесты проверяются автоматически. Результат отображается справа: успех или описание ошибки. Кнопка «Сохранить» доступна только после успешной проверки.

Таблицы #

Настройка отображения таблиц #

Работая в графическом интерфейсе, вы можете настроить отображение колонок под свои задачи. В правом углу таблиц есть иконка шестеренки. Нажатие на иконку открывает список доступных колонок в этой таблице. Выберите те колонки, которые необходимы для работы именно вам. Настройки будут сохранены при переходе между страницами.

Если часть колонок скрыта, рядом с иконкой шестеренки отображается индикатор в формате «видимые колонки / все доступные колонки».

Фильтры в таблицах #

В таблицах графического интерфейса доступны фильтрация и сортировка. Для удобства использования фильтры и сортировка вынесены в отдельный блок Фильтры над таблицей. По умолчанию блок свёрнут. Чтобы изменить режим отображения по умолчанию, измените настройку Фильтры в таблицах на странице Настройки пользователя.

В каждой таблице доступен поиск по тексту. Дополнительно предусмотрена сортировка по возрастанию/убыванию, в алфавитном порядке. Встречаются также фильтры с закрытыми списками по типовым значениям параметров, например, статусам.

Фильтрация и поиск по колонкам выполняются только для видимых колонок. В блоке Фильтры можно отфильтровать объекты по лейблам с помощью совпадающих лейблов и выражений. Такой фильтр доступен, только если в таблице отображается колонка “Лейблы”.

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

Нажмите “Очистить все фильтры”, если работа с фильтрами завершена.

Настройки пользователя #

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

Доступны настройки:

• Цветовая схема — светлая или тёмная. По умолчанию используется светлая цветовая схема.
• Компактное меню навигации — при включении боковое меню отображается в свёрнутом виде, а список страниц раздела раскрывается при наведении на значок раздела. При отключении меню отображается развёрнутым со списком разделов.
• Аккордеонное раскрытие меню навигации — при включении раскрытым остаётся только один список страниц раздела меню.
• Язык интерфейса — русский, английский или казахский.
• Фильтры в таблицах — свёрнуты или раскрыты.

Уведомления об ошибках #

В графическом интерфейсе всплывающие уведомления об ошибках отображаются некоторое время (30 сек). При необходимости вы можете скопировать текст ошибки и/или скрыть уведомление, нажав на его область.