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

Параметры

  • 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-адресу.

        Пример: ["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-адресу.

        Пример: ["1.1.1.1/32"]

  • disabledProbes (массив строк)

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

    Пример:

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

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

  • https (объект)

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

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

    Пример: {"mode":"CustomCertificate","customCertificate":{"secretName":"foobar"}}, {"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

  • 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-адресу.

        Пример: ["1.1.1.1/32"]

    • https (объект)

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

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

      Пример: {"mode":"CustomCertificate","customCertificate":{"secretName":"foobar"}}, {"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’а.

      Пример: false, "default"

  • smokeMiniDisabled (булевый)

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

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

  • statusPageAuthDisabled (булевый)

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

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

  • storageClass

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

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

    Пример: false, "default"