Модуль по умолчанию включен.

Параметры

  • authобъект

    Обязательный параметр

    Доступ к web-интерфейсу

    • statusобъект

      Обязательный параметр

      Настройки доступа к web-интерфейсу.

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

        Группы доступа к просмотру интерфейса приложения.

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

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

        • authSignInURLстрока

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

        • authURLстрока

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

      • passwordстрока

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

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

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

        Список CIDR, которым разрешено проходить аутентификацию. Если параметр не указан, аутентификацию разрешено проходить без ограничения по IP-адресу.

        Пример:

        whitelistSourceRanges:
        - 1.1.1.1/32
        
    • webuiобъект

      Обязательный параметр

      Настройки доступа к web-интерфейсу.

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

        Группы доступа к просмотру интерфейса приложения.

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

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

        • authSignInURLстрока

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

        • authURLстрока

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

      • passwordстрока

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

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

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

        Список CIDR, которым разрешено проходить аутентификацию. Если параметр не указан, аутентификацию разрешено проходить без ограничения по IP-адресу.

        Пример:

        whitelistSourceRanges:
        - 1.1.1.1/32
        
  • disabledProbesмассив строк

    Массив строк из названий групп или определенных проб из группы. Названия можно подсмотреть в web-интерфейсе.

    Пример:

    disabledProbes:
      - "synthetic/api" # отключить отдельную пробу
      - "synthetic/"    # отключить группу проб
      - control-plane   # или без /
    

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

  • httpsобъект

    Тип сертификата используемого для веб-приложений webui и status.

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

    Примеры:

    https:
      mode: CustomCertificate
      customCertificate:
        secretName: foobar
    
    https:
      mode: CertManager
      certManager:
        clusterIssuerName: letsencrypt
    
    • certManagerобъект
      • clusterIssuerNameстрока

        ClusterIssuer, используемый для webui/status.

        Доступны letsencrypt, letsencrypt-staging, selfsigned, но вы можете определить свои.

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

    • customCertificateобъект
      • secretNameстрока

        Имя secret’а в namespace d8-system, который будет использоваться для webui/status.

        Секрет должен быть в формате kubernetes.io/tls.

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

    • modeстрока

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

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

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

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

  • nodeSelectorобъект

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

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

    Пример:

    nodeSelector:
      disktype: ssd
    
  • smokeMiniобъект

    Configuration of authentication for smoke-mini.

    • authобъект

      Обязательный параметр

      Натсройки доступа к web-интерфейсу.

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

        Группы доступа к просмотру интерфейса приложения.

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

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

        • authSignInURLстрока

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

        • authURLстрока

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

      • passwordстрока

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

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

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

        Список CIDR, которым разрешено проходить аутентификацию. Если параметр не указан, аутентификацию разрешено проходить без ограничения по IP-адресу.

        Пример:

        whitelistSourceRanges:
        - 1.1.1.1/32
        
    • httpsобъект

      Тип сертификата используемого для smoke-mini.

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

      Примеры:

      https:
        mode: CustomCertificate
        customCertificate:
          secretName: foobar
      
      https:
        mode: CertManager
        certManager:
          clusterIssuerName: letsencrypt
      
      • certManagerобъект
        • clusterIssuerNameстрока

          ClusterIssuer, используемый для smoke-mini.

          Доступны letsencrypt, letsencrypt-staging, selfsigned, но вы можете определить свои.

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

      • customCertificateобъект
        • secretNameстрока

          Имя secret’а в namespace d8-system, который будет использоваться для smoke-mini.

          Секрет должен быть в формате kubernetes.io/tls.

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

      • modeстрока

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

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

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

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

    • ingressClassстрока

      Класс ingress-контроллера, который используется для smoke-mini.

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

    • storageClass

      storageClass для использования при проверке работоспособности дисков.

      • Если не указано — используется StorageClass существующей PVC, а если PVC пока нет — используется или global.storageClass, или global.discovery.defaultStorageClass, а если и их нет — данные сохраняются в emptyDir.
      • Если указать false — будет форсироваться использование emptyDir’а.

      Примеры:

      storageClass: false
      
      storageClass: default
      
  • smokeMiniDisabledбулевый

    Выключение smokeMini. Также отключает группу “synthetic”.

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

  • statusPageAuthDisabledбулевый

    Выключение авторизации для status-домена.

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

  • storageClass

    Имя storageClass’а, который использовать.

    • Если не указано — используется StorageClass существующей PVC, а если PVC пока нет — используется или global.storageClass, или global.discovery.defaultStorageClass, а если и их нет — данные сохраняются в emptyDir.
    • ОСТОРОЖНО! При указании этой опции в значение, отличное от текущего (из существующей PVC), диск будет перезаказан, а все данные удалены.
    • Если указать false — будет форсироваться использование emptyDir’а.

    Примеры:

    storageClass: false
    
    storageClass: default
    
  • tolerationsмассив объектов

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

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

    Пример:

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