Files
cluster-map/openapi/doc-ru-config-values.yaml
T
Vitaliy ChefanovandClaude Opus 5.5 4518393ce1 Package cluster-map as a Deckhouse module
Layout, build and templates follow deckhouse/modules-template; dmt lint
passes with no findings (Go files are excluded from the Flant-only
license-header rule, see .dmtlint.yaml).

- module.yaml, openapi schemas with Russian docs, lib-helm templates:
  https modes, ingress class, publicDomainTemplate, node placement,
  priority class, PSS-restricted security context, VPA, PDB, Ingress
  plus Gateway API ListenerSet/HTTPRoute, DexAuthenticator.
- module-sdk hooks: hubble CA from d8-cni-cilium (public certificate
  only), external_auth, copy_custom_certificate.
- The app moves to images/cluster-map/src and is split into packages;
  traffic mode Continuous/OnDemand/Disabled and retention are module
  settings; graceful shutdown; Prometheus metrics and two alerts;
  frontend embedded, English and Russian, strict CSP.
- Built with werf on Deckhouse's published base images; Makefile
  publishes the registry layout modules-actions uses.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-23 21:17:52 +03:00

101 lines
7.8 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
type: object
properties:
traffic:
description: Живой трафик между workload'ами из Cilium Hubble Relay.
properties:
mode:
description: |
Когда читать потоки из Hubble.
- `Continuous` — поток из Hubble открыт всегда, поэтому любое окно трафика заполнено сразу при открытии карты. На нагруженном кластере стоит hubble-relay около 100–150m CPU.
- `OnDemand` — поток открывается при первом запросе трафика и закрывается через `onDemandIdleMinutes` без запросов. Пока карту никто не смотрит, нагрузки почти нет, но окна заполняются только во время работы с картой.
- `Disabled` — без подключения к Hubble, карта показывает только связи по конфигурации.
Трафик выключен и тогда, когда выключен модуль `cilium-hubble`.
retentionMinutes:
description: |
На сколько минут назад могут смотреть окна трафика. Память растёт вместе с этим значением и с числом различных соединений в кластере.
onDemandIdleMinutes:
description: В режиме `OnDemand` — сколько минут поток остаётся открытым после последнего запроса трафика.
collectInfraTraffic:
description: |
Собирать также пробы kubelet и прочий трафик с хостов нод, трафик между нодами, проверки Cilium health и DNS.
По умолчанию выключено: на обычном кластере это около трёх четвертей всех потоков, ни один из них не привязан к workload'у, а отсев на агентах Hubble снижает нагрузку на hubble-relay в несколько раз.
logs:
properties:
tailLines:
description: Сколько последних строк лога контейнера показывает вкладка «Логи».
systemNamespacePrefixes:
description: |
Namespace, которые в дереве инвентаря попадают в группу «Системные». Элемент, заканчивающийся на `-`, сравнивается как префикс, остальные — по имени целиком.
ingressClass:
description: |
Класс Ingress-контроллера для веб-интерфейса.
Опциональный параметр. По умолчанию используется глобальное значение `modules.ingressClass`.
nodeSelector:
description: |
Аналогично параметру Kubernetes `spec.nodeSelector` у подов.
Если параметр не указан или указано `false`, значение будет определено [автоматически](https://deckhouse.ru/products/kubernetes-platform/documentation/v1/#выделение-узлов-под-определенный-вид-нагрузки).
tolerations:
description: |
Аналогично параметру Kubernetes `spec.tolerations` у подов.
Если параметр не указан или указано `false`, значение будет определено [автоматически](https://deckhouse.ru/products/kubernetes-platform/documentation/v1/#выделение-узлов-под-определенный-вид-нагрузки).
auth:
description: |
Доступ к веб-интерфейсу.
Любой, кого сюда пустили, видит все namespace, манифесты workload'ов, Service и Ingress (Secret — никогда) и логи контейнеров — через собственную read-only-учётку модуля. Ограничивайте доступ через `allowedUserGroups`.
properties:
externalAuthentication:
description: |
Параметры для подключения внешней аутентификации на основе механизма Ingress NGINX [external-auth](https://kubernetes.github.io/ingress-nginx/examples/auth/external-auth/).
> Внешняя аутентификация включается автоматически, если включен модуль [user-authn](https://deckhouse.ru/modules/user-authn/).
properties:
authURL:
description: URL сервиса аутентификации. Если пользователь прошёл аутентификацию, сервис должен вернуть код ответа HTTP 200.
authSignInURL:
description: URL, куда будет перенаправлен пользователь для прохождения аутентификации (если сервис аутентификации вернул код ответа HTTP, отличный от 200).
allowedUserEmails:
description: |
Email пользователей, которым разрешено открывать веб-интерфейс.
Используется, если включен модуль `user-authn` или задан параметр `externalAuthentication`.
allowedUserGroups:
description: |
Группы пользователей, которым разрешено открывать веб-интерфейс.
Используется, если включен модуль `user-authn` или задан параметр `externalAuthentication`.
**Внимание!** При использовании совместно с модулем [user-authn](https://deckhouse.ru/modules/user-authn/) эти группы нужно добавить в соответствующее поле DexProvider.
whitelistSourceRanges:
description: Список CIDR, которым разрешено открывать веб-интерфейс.
https:
description: |
Тип сертификата.
Этот параметр полностью переопределяет глобальные настройки `global.modules.https`.
properties:
mode:
description: |
Режим работы HTTPS:
- `CertManager` — веб-интерфейс по HTTPS с сертификатом от ClusterIssuer из `certManager.clusterIssuerName`;
- `CustomCertificate` — веб-интерфейс по HTTPS с сертификатом из namespace `d8-system`;
- `Disabled` — веб-интерфейс только по HTTP;
- `OnlyInURI` — веб-интерфейс по HTTP за внешним HTTPS-балансировщиком, который терминирует TLS; ссылки формируются со схемой HTTPS.
certManager:
properties:
clusterIssuerName:
description: ClusterIssuer, через который получается сертификат.
customCertificate:
properties:
secretName:
description: |
Имя Secret в namespace `d8-system` с сертификатом для веб-интерфейса.
Secret должен быть в формате [kubernetes.io/tls](https://kubernetes.github.io/ingress-nginx/user-guide/tls/#tls-secrets).