Проверка работоспособности#

KeyCloak.SE имеет встроенную поддержку проверки работоспособности. Реализованы три основные конечные точки (Endpoints) для проверки работоспособности:

  • /health;

  • /health/live;

  • /health/ready.

Результат возвращается в формате JSON и выглядит следующим образом:

{
    "status": "UP",
    "checks": []
}

Проверку работоспособности можно включить с помощью параметра health-enabled:

bin/kc.[sh|bat] build --health-enabled=true

Посмотреть текущую версию Keycloak.SE, Quarkus, время сборки можно по эндпойнту:

http(s)://{host}/(auth)/version.txt

--- Пример ответа --- 

# Platform V IAM KeyCloak.SE

kcse.version={project.version} # текующая версия Keycloak.SE
quarkus.version={quarkus.version} # используемая версия Quarkus 
kc.core.version={kc.core.version} # используемая версия базового Keycloak
buildtime-utc={yyyy-MM-dd HH:mm} # время сборки продукта

Проверка работоспособности при установке из Docker#

  1. Загружен корректный дистрибутив KeyCloak.SE с модулями.

  2. Присутствуют dockerfile, docker-compose.

  3. Перейдите по URL-адресу консоли администратора. Например, для localhost используйте этот URL: [http://localhost:8080/admin](Keycloak Admin Console).

  4. Осуществить вход в консоль администратора супер-администратором, с полными правами на управление всеми частями Keycloak. Эта учетная запись позволит войти в консоль администратора Keycloak с возможностью создавать realms и пользователей, регистрировать приложения, защищенные Keycloak.

Проверка работоспособности установки Standalone#

  1. Загружен корректный дистрибутив KeyCloak.SE с модулями.

  2. Перейдите по URL-адресу консоли администратора.

  3. Осуществить вход в консоль администратора супер-администратором, с полными правами на управление всеми частями Keycloak. Эта учетная запись позволит войти в консоль администратора Keycloak с возможностью создавать realms и пользователей, регистрировать приложения, защищенные Keycloak.

Проверка работоспособности в среде контейнеризации#

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

  2. В директории /config/parameters/*.cfg содержатся все параметры, необходимые для шаблонизации манифестов.

  3. В директории /k8s/base/*.yaml содержаться все файлы манифестов, которые требуется шаблонизировать. Шаблонизация и развертывание производится инструментом CDJE. DEPLOY производится с помощью автоматизированного запуска через Jenkins.

  4. Осуществить вход в консоль администратора супер-администратором, с полными правами на управление всеми частями Keycloak. Эта учетная запись позволит войти в консоль администратора Keycloak с возможностью создавать realms и пользователей, регистрировать приложения, защищенные Keycloak.

Проверка работоспособности интеграций#

VAULT#

Проверка работоспособности с VAULT описана в Руководстве по интеграции с Secret Management System (SecMan)

Аудит#

Для проверки интеграции с Аудитом необходимо:

  1. Перейти на стенд, где подключена интеграция с Аудитом.

    1. Login

  2. Ввести валидные логин (Имя пользователя) и пароль.

  3. Открыть новый сеанс браузера и зайти в АРМ администратора Platform V Audit.

    1. Audit

  4. Ввести логин/пароль пользователя Аудит

  5. Нажать на кнопку "Поиск событий аудита".

    1. Audit

  6. Вбить в строку поиска "Аутентификация пользователя" и нажать кнопку "Найти".

    1. Audit

  7. Найдены события, среди которых минимум 2, отправленных провайдером идентификации, с названием «Аутентификация пользователя» об успешной аутентификации (в поле «Подробно» указаны типы событий «LOGIN». и «CODE_TO_TOKEN»).

ОСА#

Проверка подключения к ОСА описана в разделе Настройка интеграции с ОСА`

КриптоПРО#

Проверка подразумевает аутентификацию через ЕСИА, которая настроена через КриптоПРО и описана в разделе Проверка аутентификации в ЕСИА Настройка указана в разделе Настройка провайдера cryptopro-keystore

ЕСИА#

Проверка подключения к ЕСИА описана в разделе Проверка аутентификации в ЕСИА

Identity Providers#

VK#

Проверка подключения к ВКонтакте описана в разделе Проверка подключения

Yandex#

Проверка подключения к Яндекс описана в разделе Проверка подключения

Mail#

Проверка подключения к Mail описана в разделе Проверка подключения

Одноклассники#

Проверка подключения к Одноклассники описана в разделе Проверка подключения