Доступно с ограничениями в редакциях:  CE, BE, SE

Доступно без ограничений в редакциях:  SE+, EE

параметры

Версия схемы: 1

  • settings
    объект
    • settings.auth
      объект
      Доступ к web-интерфейсу.

      По умолчанию: {}

      • settings.auth.allowedUserGroups
        массив строк

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

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

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

      • settings.auth.externalAuthentication
        объект

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

        Внешняя аутентификация включается автоматически, если включен модуль user-authn.

        По умолчанию: {}

        • settings.auth.externalAuthentication.authSignInURL
          строка
          URL, куда будет перенаправлен пользователь для прохождения аутентификации (если сервис аутентификации вернул код ответа HTTP, отличный от 200).
        • settings.auth.externalAuthentication.authURL
          строка
          URL сервиса аутентификации. Если пользователь прошел аутентификацию, сервис должен возвращать код ответа HTTP 200.
      • settings.auth.password
        Параметр устарел
        строка

        Этот параметр ни на что не влияет и в будущих релизах будет удален.

        Раньше он использовался для HTTP-авторизации для пользователя admin, если не был включен модуль user-authn или не был задан параметр externalAuthentication.

        Теперь внешняя аутентификация обязательна для корректной работы Deckhouse Commander.

      • settings.auth.whitelistSourceRanges
        массив строк

        Список адресов в формате CIDR, которым разрешено проходить аутентификацию.

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

        Пример: 


        whitelistSourceRanges:
- 1.1.1.1/32
    • settings.billing
      объект
      Настройки биллинга.

      По умолчанию: {}

      • settings.billing.prometheus
        объект

        По умолчанию: {}

        • settings.billing.prometheus.diskSizeGigabytes
          целочисленный

          Размер диска для хранилища метрик Prometheus в гигабайтах.

          Вам следует вручную указать желаемый размер диска для хранилища метрик Prometheus, но при необходимости вы сможете увеличить его позже.

          Занятый объем автоматически отслеживается с помощью модуля extended-monitoring.

          ОСТОРОЖНО! Если диск с данными хранилища метрик Prometheus переполнится, биллинг перестанет работать.

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

          Пример: 


          diskSizeGigabytes: "10"
        • settings.billing.prometheus.storageClass
          строка

          Имя StorageClass’а, который предполагается использовать для хранилища метрик Prometheus.

          Если не указано, используется StorageClass существующего PVC. Если PVC нет, будет использоваться StorageClass, согласно настройке глобального параметра storageClass.

          Настройка параметра storageClass учитывается только при включении модуля. Изменение параметра storageClass при включенном модуле не приведет к перезаказу диска.

          Пример: 


          storageClass: ceph-ssd
      • settings.billing.reports
        объект

        По умолчанию: {}

        • settings.billing.reports.diskSizeGigabytes
          целочисленный

          Размер диска для хранилища отчётов в гигабайтах.

          Вам следует вручную указать желаемый размер диска для хранилища отчётов, но при необходимости вы сможете увеличить его позже.

          Занятый объем автоматически отслеживается с помощью модуля extended-monitoring.

          ОСТОРОЖНО! Если диск с данными хранилища отчётов переполнится, отчёты станут недоступными.

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

          Пример: 


          diskSizeGigabytes: "2"
        • settings.billing.reports.storageClass
          строка

          Имя StorageClass’а, который предполагается использовать для хранилища отчётов биллинга.

          Если не указано, используется StorageClass существующего PVC. Если PVC нет, будет использоваться StorageClass, согласно настройке глобального параметра storageClass.

          Настройка параметра storageClass учитывается только при включении модуля. Изменение параметра storageClass при включенном модуле не приведет к перезаказу диска.

          Пример: 


          storageClass: ceph-ssd
    • settings.featureFlags
      объект
      Параметр, используемый для управления экспериментальными функциями.

      По умолчанию: {}

    • settings.highAvailability
      булевый

      Ручное управление режимом отказоустойчивости.

      По умолчанию режим отказоустойчивости определяется автоматически. Подробнее про режим отказоустойчивости.

      Примеры: 


      highAvailability: true

      highAvailability: false
    • settings.https
      объект

      Тип используемого сертификата.

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

      Примеры: 


      customCertificate:
  secretName: foobar
mode: CustomCertificate

      certManager:
  clusterIssuerName: letsencrypt
mode: CertManager
      • settings.https.certManager
        объект

        По умолчанию: {}

        • settings.https.certManager.clusterIssuerName
          строка

          Тип ClusterIssuer’а, используемого для заказа SSL-сертификата.

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

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

      • settings.https.customCertificate
        объект

        По умолчанию: {}

        • settings.https.customCertificate.secretName
          строка

          Имя Secret’а в пространстве имен d8-system, который будет использоваться для веб-интерфейса.

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

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

      • settings.https.mode
        строка

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

        • Disabled — доступ только по HTTP. Внимание! Данный режим не поддерживается. HTTPS обязателен для корректной работы модуля. Если HTTPS отключен, веб-интерфейс модуля будет недоступен.
        • CertManager — доступ по HTTPS с заказом сертификата согласно ClusterIssuer’у, заданному в параметре certManager.clusterIssuerName. Подробнее.
        • CustomCertificate — доступ по HTTPS с использованием сертификата из пространства имен d8-system.
        • OnlyInURI — доступ по HTTP, подразумевая, что перед веб-интерфейсом стоит внешний HTTPS-балансер, который терминирует HTTPS, и все ссылки в user-authn будут генерироваться с HTTPS-схемой. Балансировщик должен обеспечивать перенаправление с HTTP на HTTPS.

        Допустимые значения: 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])?)*$

      Пример: 


      ingressClass: nginx
    • settings.nodeSelector
      объект

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

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

      Пример: 


      disktype: ssd
    • settings.postgres
      объект

      По умолчанию: {}

      • settings.postgres.external
        объект
        • settings.postgres.external.credentials
          объект

          По умолчанию: {}

          • settings.postgres.external.credentials.secretName
            строка

            Имя секрета в неймспейсе d8-commander с паролем. Если заполнено, параметр user and password игнорируется.

            Рекомендуется задавать учетные данные базы данных таким образом.

            Пример создания секрета: kubectl -n d8-commander create secret generic postgres-secret --from-literal=username=postgres --from-literal=password=postgres

            Пример: 


            secretName: postgres-secret
        • settings.postgres.external.db
          строка
          Database name
        • settings.postgres.external.host
          строка

          Адрес сервера или несколько адресов через запятую, если кластер PostgreSQL состоит из нескольких узлов.

          Внимание! Порты серверов указываются отдельно в параметре port.

          Примеры: 


          host: host1

          host: host1,host2,host3
        • settings.postgres.external.password
          Параметр устарел
          строка

          Пароль пользователя

          Параметр устарел, пожалуйста, используйте passwordSecret, что является более безопасным способом указания пароля.

        • settings.postgres.external.port
          строка

          Порт сервера или несколько портов через запятую, если кластер PostgreSQL состоит из нескольких узлов.

          Внимание! Для каждого узла необходимо указать свой порт.

          Примеры: 


          port: "5432"

          port: 5432,5432,5433
        • settings.postgres.external.ssl
          объект
          • settings.postgres.external.ssl.secretName
            строка

            Имя секрета в неймспейсе d8-commander, который содержит клиентский сертификат для аутентификации по сертификату на сервере PostgreSQL.

            Пример создания секрета: kubectl -n d8-commander create secret generic postgres-ssl --from-file=tls.crt=client.crt --from-file=tls.key=client.key --from-file=ca.crt=ca.crt

            Пример: 


            secretName: postgres-ssl
        • settings.postgres.external.user
          Параметр устарел
          строка
          Имя пользователя

          Пример: 


          user: postgres
      • settings.postgres.internal
        объект

        По умолчанию: {}

        • settings.postgres.internal.diskSizeGigabytes
          целочисленный

          Размер диска для базы данных PostgreSQL в гигабайтах.

          Вам следует вручную указать желаемый размер диска для базы данных PostgreSQL, но при необходимости вы сможете увеличить его позже.

          Занятый объем автоматически отслеживается с помощью модуля extended-monitoring.

          ОСТОРОЖНО! Если диск с данными PostgreSQL переполнится, приложение перестанет работать.

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

        • settings.postgres.internal.storageClass
          строка

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

          Если не указано, используется StorageClass существующего PVC, а если PVC пока нет, используется или глобальный StorageClass или global.discovery.defaultStorageClass.

          Обратитесь к разделу документации Изменение класса хранения, если хотите изменить это значение.

          Пример: 


          storageClass: ceph-ssd
      • settings.postgres.mode
        строка

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

        • Internal — PostgreSQL развертывается в кластере и управляется с помощью postgres-operator.

          Это не рекомендуемый способ для использования в производственных средах. Однако использование operator-postgres удобно для более быстрого знакомства с Deckhouse Commander или для сред, где нет высоких требований к доступности и поддержке.

        • External - Используется внешняя инсталляция PostgreSQL, управляемая пользователем. Это рекомендуемый способ использования Deckhouse Commander в производственных средах.

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

        Допустимые значения: Internal, External

    • settings.tolerations
      массив объектов

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

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

      Пример: 


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