Описание интерфейса

При первом запуске доступны варианты быстрого запуска, заданные workspace, например установка Citeck с демонстрационными данными (a) или без них (b), а также создание нового пространства имён (namespace) для разворачивания Citeck (с):

../../../_images/namespaces.png

После успешного запуска отображается рабочее пространство (1) и список доступных в нем namespace (4):

../../../_images/namespaces_1.png
  • (1) - выбор и создание рабочего пространства

  • (2) - принудительное обновление рабочего пространства

  • (3) - конфигурация рабочего пространства

../../../_images/ws_config.png
  • (4) - список namespace выбранного рабочего пространства

  • (5) - выбор языка интерфейса

  • (6) - выбор светлой/темной темы интерфейса

Для namespace доступны следующие действия:

../../../_images/namespaces_2.png

При выборе namespace доступна актуальная информация о микросервисах и приложениях в его составе, а также действия:

../../../_images/overview.png

Микросервисы и приложения

  1. Запускаемые микросервисы и приложения: микросервисы ядра, приложения Citeck, сторонние — с указанием статуса и потребляемых ресурсов CPU и оперативной памяти. Доступные действия:

    • 1a — остановить/запустить;

    • 1b — лог микросервиса;

    • 1c — ручная настройка микросервиса/приложения:

    Левый клик — редактировать конфигурацию Docker-приложения:

    ../../../_images/setting_left.png

    Правый клик — редактировать файлы томов:

    ../../../_images/setting_right.png

    Синий маркер означает, что у приложения есть ручная конфигурация, которая не управляется Launcher. Чтобы сбросить ручные изменения, откройте редактор и нажмите «Сброс».

    Правый клик по микросервису/приложению — открывает подробную информацию и контекстное меню с действиями:

    ../../../_images/ms_info.png
  2. Обновить/запустить все микросервисы и приложения. При клике правой кнопкой мыши доступно действие Force Update And Start — принудительное обновление данных из git-репозиториев с конфигурацией рабочего пространства и bundle (китов):

    ../../../_images/force_update.png
  3. Остановка всех микросервисов и приложений.

Статус и ресурсы

  1. Актуальный статус процесса разворачивания.

  2. Общие потребляемые ресурсы CPU/RAM.

Доступ и сопутствующие сервисы

  1. Открыть Citeck в браузере (только при статусе Running).

  2. Доступ к сопутствующим сервисам — открываются в браузере в отдельной вкладке:

    • Keycloak Admin — интерфейс управления Keycloak (система управления идентификацией и авторизацией). Отображается, если при настройке пространства имён выбран тип авторизации Keycloak. Логин / пароль: admin / admin

    • Spring Boot Admin — интерфейс для мониторинга и администрирования Spring Boot-приложений: просмотр состояния, метрик, логов и управление приложениями.

    • PG Admin — интерфейс для администрирования и управления базами данных PostgreSQL. Логин / пароль: admin@admin.com / admin. Пароль для БД: postgres

    • Mailpit — инструмент для тестирования и отладки электронной почты во время разработки: перехватывает письма и отображает их в веб-интерфейсе без реальной отправки.

    • RabbitMQ — интерфейс брокера сообщений (message broker), который обеспечивает асинхронный обмен данными между компонентами распределённых систем. Логин / пароль: admin / admin

  3. Документация по платформе Citeck:

    • Documentation — переход на ресурс, содержащий документацию по платформе.

    • AI Documentation Bot — переход в Telegram-бот.

Инструменты Launcher

  1. Переход в директорию лаунчера (папка с логами, данными конфигурации, рабочими пространствами).

  2. Открыть лог лаунчера:

    ../../../_images/log.png

    Данные лога можно отфильтровать по типу (1), в нём доступен поиск (2), а также возможность скопировать, очистить или выгрузить лог (3).

  3. Список томов, которые используются. Их можно очистить или сделать снэпшот данных:

    ../../../_images/volumes.png

Настройки и секреты

  1. Работа с секретами, используемыми в Launcher. Для сохранения пользовательских учётных данных необходимо задать мастер-пароль, а для доступа к заблокированному хранилищу — ввести его:

    ../../../_images/secrets.png

    См. подробно о работе с секретами.

  2. Экспорт информации о системе — диагностический архив Launcher со сведениями о системе и сборке, включая дамп goroutine процесса Launcher. Дамп Java-потоков отдельного микросервиса получают отдельно.

  3. Настройки пространства имён. См. подробно о настройках пространства имён (namespace).

    ../../../_images/namespace_settings.png
  4. Список namespace:

    ../../../_images/namespace_list.png

Действия в трее

../../../_images/tray_actions.png
  • Открыть

  • Экспорт информации о системе

  • Переход в директорию лаунчера

  • DevTools

  • Выйти