Параметры

  • authобъект

    Опции, связанные с аутентификацией и авторизацией доступа к web-интерфейсу документации.

    • allowedUserGroupsмассив строк

      Массив групп, пользователям которых позволен доступ к просмотру документации. Используется если включен модуль user-authn или параметр externalAuthentication. Внимание! При использовании совместно с модулем user-authn необходимо также добавить разрешенные группы в соответствующее поле в настройках DexProvider.

      По умолчанию: []

      Примеры:

      allowedUserGroups:
      - admin
      - users
      
      allowedUserGroups: []
      
    • externalAuthenticationобъект

      Параметры для подключения внешней аутентификации (используется механизм Nginx Ingress external-auth, работающей на основе модуля Nginx auth_request.

      • authSignInURLстрока

        URL, куда будет перенаправлен пользователь для прохождения аутентификации (если сервис аутентификации вернул код ответа HTTP отличный от 200).

        По умолчанию: ""

        Пример:

        authSignInURL: https://$host/dex-authenticator/sign_in
        
      • authURLстрока

        URL сервиса аутентификации. Если пользователь прошел аутентификацию, сервис должен возвращать код ответа HTTP 200.

        По умолчанию: ""

        Пример:

        authURL: https://deckhouse-web-dex-authenticator.d8-system.svc.cluster.local/dex-authenticator/auth
        
    • passwordстрока

      Пароль для http-авторизации для пользователя admin (генерируется автоматически, но можно менять).

      Используется если не включен параметр externalAuthentication.

      Примеры:

      password: qwerty123
      
      password: foobar
      
  • httpsобъект

    Выбираем, какой типа сертификата использовать для web-интерфейса документации. При использовании этого параметра полностью переопределяются глобальные настройки global.modules.https.

    Примеры:

    https:
      mode: Disabled
    
    https:
      mode: OnlyInURI
    
    https:
      mode: CustomCertificate
      customCertificate:
        secretName: foobar
    
    https:
      mode: CertManager
      certManager:
        clusterIssuerName: letsencrypt
    
    • certManagerобъект

      Настройки для certmanager

      • clusterIssuerNameстрока

        Указываем, какой ClusterIssuer использовать для заказа SSL-сертификата (в данный момент доступны letsencrypt, letsencrypt-staging, selfsigned, но вы можете определить свои). По умолчанию letsencrypt.

        По умолчанию: "letsencrypt"

        Примеры:

        clusterIssuerName: letsencrypt
        
        clusterIssuerName: letsencrypt-staging
        
        clusterIssuerName: selfsigned
        
    • customCertificateобъект

      Настройки для использования пользовательского сертификата.

      • secretNameстрока

        Указываем имя secret’а в namespace d8-system, который будет использоваться для web-интерфейса документации (данный секрет должен быть в формате kubernetes.io/tls). По умолчанию false.

        По умолчанию: "false"

    • modeстрока

      Режим работы HTTPS:

      • Disabled — в данном режиме доступ к web-интерфейсу документации будет только по HTTP.
      • CertManager — доступ по HTTPS с заказом сертификата согласно clusterIssuer заданного в параметре certManager.clusterIssuerName.
      • CustomCertificate — доступ по HTTPS, с использованием сертификата из namespace d8-system.
      • OnlyInURI — web-интерфейс документации будет доступен по HTTP (подразумевая, что перед ним стоит внешний HTTPS-балансер, который терминирует HTTPS) и все ссылки в user-authn будут генерироваться с HTTPS-схемой.

      По умолчанию: "CertManager"

      Допустимые значения: Disabled, CertManager, CustomCertificate, OnlyInURI

  • ingressClassстрока

    Класс Ingress-контроллера web-интерфейса документации.

    Опциональный параметр, по умолчанию используется глобальное значение modules.ingressClass.

    Примеры:

    ingressClass: main
    
    ingressClass: front
    
  • nodeSelectorобъект

    Структура, аналогичная spec.nodeSelector Kubernetes pod.

    Если ничего не указано или указано false — будет использоваться автоматика.

    Пример:

    nodeSelector:
      disktype: ssd
    
  • tolerationsмассив объектов

    Структура, аналогичная spec.tolerations в Kubernetes Pod.

    Если ничего не указано или указано false — будет использоваться автоматика.

    Пример:

    tolerations:
    - key: key1
      operator: Equal
      value: value1
      effect: NoSchedule
    
    • effectстрока
    • keyстрока
    • operatorстрока
    • tolerationSecondsцелочисленный
    • valueстрока