Until now anyone admitted through Dex saw every namespace and every log, read with the module's service account. auth.visibility: ViewerRBAC (the default) asks the API server as the viewer, with the token the DexAuthenticator forwards: list pods in all namespaces means the whole cluster; otherwise the namespaces where they can list pods. Logs also need get pods/log, node cards list nodes, cluster-wide alerts are for cluster-wide viewers. Traffic to a hidden namespace keeps its counts with the peer shown as hidden. One minute cache per token hash, SSARs in parallel (8), a cluster-wide viewer costs two. Verified against the live cluster with two real tokens: a service account with view in one namespace got that namespace only (0 nodes, 403 on another namespace's YAML and logs, 403 on node usage); the module's own account, cluster-wide, got all 56 namespaces and 6 nodes; no token, 401. auth.visibility: Everything keeps the old behaviour. The DexAuthenticator now forwards the token when either actions or ViewerRBAC need it (templates/_helpers.tpl). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
119 lines
10 KiB
YAML
119 lines
10 KiB
YAML
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 в несколько раз.
|
||
actions:
|
||
description: Изменения, которые карта может вносить в кластер.
|
||
properties:
|
||
enabled:
|
||
description: |
|
||
Кнопки: перезапустить workload, масштабировать Deployment или StatefulSet, удалить под, запустить CronJob сейчас или приостановить его, закрыть ноду для новых подов (cordon).
|
||
|
||
Каждое действие выполняется от имени самого пользователя: DexAuthenticator передаёт модулю его токен, и API-сервер проверяет права по RBAC этого пользователя. Сервисный аккаунт модуля остаётся только на чтение, кнопка показывается, только если роль пользователя разрешает действие, а в аудит-логе API-сервера записан пользователь.
|
||
|
||
Нужен модуль `user-authn` или `externalAuthentication`, который кладёт в заголовок `Authorization` токен, принимаемый API-сервером. Если выключено, токен пользователя модулю не передаётся вовсе.
|
||
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: |
|
||
Доступ к веб-интерфейсу.
|
||
|
||
При `visibility: ViewerRBAC` (по умолчанию) каждый видит только namespace, где его собственный RBAC разрешает смотреть поды; при `Everything` любой, кого сюда пустили, видит все namespace, манифесты workload'ов, Service и Ingress (Secret — никогда) и логи контейнеров. В обоих случаях ограничивайте круг допущенных через `allowedUserGroups`.
|
||
properties:
|
||
visibility:
|
||
description: |
|
||
Что видит пользователь.
|
||
|
||
- `ViewerRBAC` — то, что разрешают его собственные права: весь кластер, если он может смотреть поды во всех namespace, иначе только namespace, где он может смотреть поды. Для логов контейнеров нужно ещё `get pods/log`, для карточек нод — `list nodes`. Трафик в скрытый namespace показывается как соединение со скрытым соседом. Проверяется через SelfSubjectAccessReview от имени пользователя, ответ кешируется на минуту.
|
||
- `Everything` — каждый допущенный пользователь видит весь кластер, чтение идёт сервисным аккаунтом модуля.
|
||
|
||
Для `ViewerRBAC` нужен токен пользователя: модуль `user-authn` или `externalAuthentication`, который кладёт в заголовок `Authorization` токен, принимаемый API-сервером.
|
||
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).
|