Доступно в редакциях: Open/CE, BE, SE, SE+, Ultimate/EE, Core, Certified Core/CSE Lite (1.73), Certified Pro/CSE Pro (1.73)
Стадия жизненного цикла модуля: General Availability
Веб-интерфейсы, связанные с модулем: documentation
Модуль documentation создаёт веб-интерфейс с документацией той версии Deckhouse Platform, которая запущена в кластере, и документацией доступных модулей.
Чтобы получить адрес веб-интерфейса, замените ключ %s на documentation в шаблоне publicDomainTemplate глобального параметра конфигурации Deckhouse Platform. Например, если publicDomainTemplate установлен как %s-kube.company.my, веб-интерфейс документации будет доступен по адресу documentation-kube.company.my.
Основные возможности
Модуль предоставляет следующие возможности:
- документация версии Deckhouse Platform, запущенной в кластере, без доступа в интернет;
- документация модулей из всех ModuleSource кластера, включённых и нет;
- поиск по документации платформы и модулей;
- страницы в формате Markdown, индекс
llms.txtи файлcorpus.jsonдля AI-инструментов; - аутентификация через модуль
user-authn, внешний сервис аутентификации или базовая аутентификация со сгенерированным паролем, примеры настройки аутентификации; - хранение подготовленных версий в системном хранилище S3 или в своём хранилище S3, а также режим отказоустойчивости с двумя репликами.
Как работает модуль
Документация версии Deckhouse Platform, в состав которой входит модуль, встроена в модуль.
Документация конкретной версии модуля готовится по требованию и кешируется:
- Пользователь открывает страницу версии модуля, которая ещё не подготовлена.
- Модуль скачивает документацию из образа версии в хранилище образов контейнеров и собирает её страницы.
- Подготовленная версия хранится на томе пода документации. Если включено хранение версий в S3, версия хранится также в S3, и после перезапуска пода модуль открывает её без повторной подготовки.
- Одна версия каждого модуля хранится всегда. У включённого модуля это установленная версия. У остальных модулей это версия самого стабильного канала: stable, если он есть. Из этих версий собираются индекс поиска и файлы AI-инструментов (
llms.txt,corpus.json) всех модулей.
Если для модуля есть ModuleRelease в фазе Pending, модуль готовит документацию этой версии заранее. Модуль читает список версий из хранилища образов контейнеров раз в 30 минут. Версия, которую опубликовали позже, появляется в списке не позднее чем через 30 минут.
Ограничения
Каждый под документации хранит подготовленные версии на томе 4 ГиБ, в двух частях по 2 ГиБ:
| Часть | Содержимое | Вместимость | Удаление |
|---|---|---|---|
| Версии, которые открывают пользователи | Версия занимает около 1,3 МБ | Около 1500 версий | Сверх 2 ГиБ модуль первой удаляет версию, которую открывали раньше других. Версию, которую не открывали 7 дней, модуль удаляет в любом случае и готовит заново при открытии |
| Версии для поиска | Одна версия каждого модуля с её файлами поиска и AI, около 3,5 МБ каждая | Около 600 версий | Не удаляются. Если они займут больше 2 ГиБ, срабатывает алерт D8DocumentationPinnedVersionsTooLarge |