Доступно в редакциях: Open/CE, BE, SE, SE+, Ultimate/EE, Core, Certified Core/CSE Lite (1.73), Certified Pro/CSE Pro (1.73)
Стадия жизненного цикла модуля: General Availability
У модуля нет обязательных настроек.
В модуле реализовано 9 алертов.
Модуль включен по умолчанию в наборах модулей: Default, Managed.
Модуль выключен по умолчанию в наборе модулей Minimal.
Параметры
Версия схемы: 1
- объектsettings
- объектsettings.auth
Опции, связанные с аутентификацией и авторизацией доступа к веб-интерфейсу документации.
- массив строкsettings.auth.allowedUserEmails
Массив адресов электронной почты, пользователям которых разрешён доступ к веб-интерфейсу.
Используется, если включён модуль
user-authnили задан параметрexternalAuthentication. - массив строкsettings.auth.allowedUserGroups
Массив групп, пользователям которых разрешён доступ к просмотру документации.
Используется, если включён модуль
user-authnили задан параметрexternalAuthentication.Внимание. Если модуль работает вместе с модулем
user-authn, добавьте разрешённые группы в настройки DexProvider.По умолчанию:
[]Примеры:
allowedUserGroups: - admin - usersallowedUserGroups: [] - объектsettings.auth.externalAuthentication
Параметры внешней аутентификации. Используется механизм Ingress NGINX external-auth на основе модуля Nginx auth_request.
Внешняя аутентификация включается автоматически, если включён модуль user-authn.
- строкаsettings.auth.externalAuthentication.authSignInURL
URL, куда будет перенаправлен пользователь для прохождения аутентификации (если сервис аутентификации вернул код ответа HTTP, отличный от 200).
По умолчанию:
Пример:
authSignInURL: https://$host/dex-authenticator/sign_in - строкаsettings.auth.externalAuthentication.authURL
URL сервиса аутентификации.
Если пользователь прошёл аутентификацию, сервис должен возвращать код ответа HTTP 200.
По умолчанию:
Пример:
authURL: https://documentation-dex-authenticator.d8-system.svc.cluster.local/dex-authenticator/auth
- булевыйsettings.highAvailability
Ручное управление режимом отказоустойчивости.
По умолчанию режим отказоустойчивости определяется автоматически. Подробнее про режим отказоустойчивости.
В режиме отказоустойчивости документация работает в двух репликах на разных узлах. Требования к узлам и роль S3 описаны в разделе «Режим отказоустойчивости» на странице примеров конфигурации модуля.
Примеры:
highAvailability: truehighAvailability: false - объектsettings.https
Тип используемого сертификата.
При использовании этого параметра полностью переопределяются глобальные настройки
global.modules.https.Примеры:
https: mode: Disabledhttps: mode: OnlyInURIhttps: mode: CustomCertificate customCertificate: secretName: foobarhttps: mode: CertManager certManager: clusterIssuerName: letsencrypt- объектsettings.https.certManager
Настройки для certmanager.
- строкаsettings.https.certManager.clusterIssuerName
ClusterIssuer, используемый для заказа SSL-сертификата (доступны
letsencrypt,letsencrypt-staging,selfsigned, но можно определить свои).По умолчанию:
letsencryptПример:
clusterIssuerName: letsencrypt
- объектsettings.https.customCertificate
Настройки пользовательского сертификата.
- строкаsettings.https.customCertificate.secretName
Имя Secret в неймспейсе
d8-system, который будет использоваться для веб-интерфейса документации.Secret должен быть в формате kubernetes.io/tls.
- строкаsettings.https.mode
Режим работы HTTPS:
CertManager— доступ по HTTPS с заказом сертификата согласно ClusterIssuer, заданному в параметреcertManager.clusterIssuerName.CustomCertificate— доступ по HTTPS с использованием сертификата из неймспейсаd8-system.Disabled— доступ только по HTTP.OnlyInURI— доступ по HTTP с внешним HTTPS-балансировщиком. Балансировщик терминирует HTTPS, и все ссылки в user-authn генерируются с HTTPS-схемой. Балансировщик должен обеспечивать перенаправление с HTTP на HTTPS.
По умолчанию:
CertManagerДопустимые значения:
Disabled,CertManager,CustomCertificate,OnlyInURI
- строкаsettings.ingressClass
Класс Ingress-контроллера веб-интерфейса документации.
Опциональный параметр, по умолчанию используется глобальное значение
modules.ingressClass.Шаблон:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ - объектsettings.moduleStorage
Хранение документации версий модулей, которая готовится при первом открытии версии.
- объектsettings.moduleStorage.s3
Где хранится подготовленная документация версий модулей, кроме кеша пода документации.
- объектsettings.moduleStorage.s3.external
Ваше хранилище S3 для
type: External. Модуль берёт настройки подключения и ключи из Secret. Список ключей Secret описан в разделе «Своё хранилище S3» на странице примеров конфигурации модуля.- строкаsettings.moduleStorage.s3.external.prefix
Часть бакета, которую использует модуль: ключи всех объектов, которые он читает, записывает и удаляет, начинаются с этого префикса. Остальные объекты бакета модуль не трогает, поэтому бакет можно делить с другими.
По умолчанию:
documentation/Шаблон:
^([A-Za-z0-9][A-Za-z0-9._-]*/)+$Примеры:
prefix: documentation/prefix: clusters/main/documentation/ - объектsettings.moduleStorage.s3.external.secretRef
Обязательный параметр
Secret с подключением и ключами хранилища S3, в любом неймспейсе.
Deckhouse Platform копирует его в Secret
documentation-s3-connectionвd8-system. Этот Secret использует под документации. После того как вы создадите или измените Secret, под документации перезапустится в течение 5 минут. Пока Secret не создан, версии хранятся только в поде.- строкаsettings.moduleStorage.s3.external.secretRef.name
Обязательный параметр
Имя Secret.
Шаблон:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$Максимальная длина:
253Пример:
name: documentation-s3 - строкаsettings.moduleStorage.s3.external.secretRef.namespace
Обязательный параметр
Неймспейс Secret.
Шаблон:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$Максимальная длина:
63Примеры:
namespace: d8-systemnamespace: documentation-storage
- строкаsettings.moduleStorage.s3.external.size
Сколько места модуль может занять в бакете под префиксом. Когда занято больше 80%, модуль удаляет сохранённые версии, пока не останется 60%, в таком порядке:
- Копии, заменённые после обновления шаблона документации.
- Версии, которые открывали читатели.
- Версии, которые использует поиск.
Внутри каждой группы первыми удаляются версии, сохранённые раньше остальных.
По умолчанию:
5GiШаблон:
^[1-9][0-9]*(Mi|Gi|Ti)$Примеры:
size: 5Gisize: 20Gi
- строкаsettings.moduleStorage.s3.type
Disabled— только в поде: после перезапуска пода версии готовятся заново при открытии. В режиме отказоустойчивости каждая реплика сама готовит и хранит версии. Документация расходует вдвое больше CPU и отправляет вдвое больше запросов в хранилище образов контейнеров. Для этого режима включите S3.System— также в системном хранилище S3 модуля system-s3: после перезапуска пода версии открываются из него за доли секунды. Модуль создаёт для этого бакет на 5 ГиБ. Требует включённого модуляsystem-s3: без него версии хранятся только в поде, и срабатывает алертD8DocumentationSystemS3Disabled.External— также в вашем хранилище S3, которое задаётся в разделеexternal.
По умолчанию:
DisabledДопустимые значения:
Disabled,System,External
- объектsettings.nodeSelector
Структура, аналогичная
spec.nodeSelectorпода Kubernetes.Если значение не указано или равно
false, Deckhouse Platform определяетnodeSelectorавтоматически.Пример:
nodeSelector: disktype: ssd - массив объектовsettings.tolerations
Структура, аналогичная
spec.tolerationsпода Kubernetes.Если значение не указано или равно
false, Deckhouse Platform определяетtolerationsавтоматически.Пример:
tolerations: - key: key1 operator: Equal value: value1 effect: NoSchedule- строкаsettings.tolerations.effect
- строкаsettings.tolerations.key
- строкаsettings.tolerations.operator
- целочисленныйsettings.tolerations.tolerationSeconds
- строкаsettings.tolerations.value

