Files
Виталий ЧефановandClaude Opus 5.5 c50020e420 v0.10.0: each viewer sees what their own RBAC allows
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>
2026-09-25 01:03:50 +03:00

5.0 KiB

cluster-map

A Deckhouse Kubernetes Platform module: an interactive topology map of the cluster with live traffic from Cilium Hubble. User documentation is in docs/README.md (на русском).

The module follows deckhouse/modules-template: werf build, lib-helm templates, module-sdk hooks, and it passes dmt lint with no findings.

Layout

Path What
module.yaml, Chart.yaml, .helmignore, oss.yaml, changelog.yaml module metadata
openapi/ config-values.yaml (ModuleConfig settings), doc-ru-config-values.yaml, values.yaml (internal values)
templates/ Helm templates on lib-helm (charts/deckhouse_lib_helm-*.tgz)
hooks/batch/ Go hooks on module-sdk: hubble CA, external auth, custom certificate
images/cluster-map/ the application image: werf.inc.yaml and the Go source in src/
monitoring/prometheus-rules/ alert rules
docs/ user documentation, English and Russian
.werf/, werf.yaml, werf-giterminism.yaml build, from modules-template
tests/values/ values for make render

The application (images/cluster-map/src)

Package What
cmd/cluster-map wiring, signals, graceful shutdown
internal/config settings from the environment (the Deployment template is the only writer)
internal/kube informer caches, managedFields stripped
internal/topology the graph: workloads, Services, Ingresses, nodes, the pod-owner rules shared with traffic, and the problems attached to cards
internal/traffic Hubble follow stream, per-minute buckets of distinct connections
internal/actions restart, scale, run, suspend, delete pod, cordon — as the viewer
internal/access what each viewer may see: SelfSubjectAccessReviews as the viewer, cached per token
internal/server HTTP API, CSP headers, request metrics
internal/metrics Prometheus metrics
web/ the frontend, embedded into the binary: plain JS, Cytoscape.js, elkjs, English and Russian

API: /api/graph (with problems), /api/flows?namespaces=a,b&window=<seconds>, /api/resource?kind=&namespace=&name=, /api/pods?id=&namespace=, /api/logs?namespace=&pod=&container=, /api/events?id=, /api/usage?id=, /api/me, /api/permissions?kind=&namespace=&name=, POST /api/action, /healthz, /readyz; metrics on :9090/metrics.

/api/me, /api/permissions and /api/action use the viewer's bearer token from the Authorization header (the DexAuthenticator adds it when actions.enabled or auth.visibility: ViewerRBAC), never the module's service account. With ViewerRBAC every read endpoint also filters by the viewer's scope and answers 401 without a token.

To run the binary on a workstation, point KUBECONFIG at a kubeconfig; without it the in-cluster service account is used.

Development

make test     # go test -race for the app, hook tests on the module-sdk framework
make lint     # golangci-lint and dmt
make render   # helm template with tests/values/*.yaml

dmt is built from deckhouse/dmt; crane from go-containerregistry.

Build and publish

Base images come from the base_images.yml Deckhouse publishes for its own modules (make base-images; the file is not committed, as in the template).

docker login git.project-chimera.ru
make publish VERSION=v0.10.0              # build, push bundle and release, register, channel alpha
make release VERSION=v0.10.0 CHANNEL=stable

The registry layout matches deckhouse/modules-actions:

<SOURCE>:cluster-map                    module registration (empty image)
<SOURCE>/cluster-map:v0.7.0             bundle
<SOURCE>/cluster-map:<content-tag>      application image
<SOURCE>/cluster-map/release:v0.7.0     release
<SOURCE>/cluster-map/release:<channel>  alpha | beta | early-access | stable | rock-solid

Install

apiVersion: deckhouse.io/v1alpha1
kind: ModuleSource
metadata:
  name: cluster-map
spec:
  registry:
    repo: git.project-chimera.ru/fanchji/cluster-map
    scheme: HTTPS
---
apiVersion: deckhouse.io/v1alpha2
kind: ModuleUpdatePolicy
metadata:
  name: cluster-map
spec:
  releaseChannel: Alpha
  update:
    mode: Auto
---
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: cluster-map
spec:
  enabled: true
  version: 1
  updatePolicy: cluster-map
  source: cluster-map
  settings:
    auth:
      allowedUserGroups: [admins]

The module is Experimental: enable allowExperimentalModules in the deckhouse ModuleConfig first.

License

Apache 2.0, see LICENSE. Go files carry an Apache-2.0 header with a neutral copyright line; DMT's license rule expects Copyright <year> Flant JSC, so .dmtlint.yaml excludes the two Go directories from that rule until the headers are changed on transfer.