Implement ClusterUID enrichment for runtime alerts#708
Conversation
This change adds support for enriching runtime alerts with a stable cluster identifier (ClusterUID) based on the kube-system namespace UID. Changes: - Update armoapi-go dependency to v0.0.672 (includes ClusterUID field) - Add GetClusterUID utility function to fetch kube-system namespace UID - Update HTTPExporter to accept and store clusterUID - Update InitExporters to accept clusterUID parameter - Populate ClusterUID in createRuleAlert and createMalwareAlert - Fetch ClusterUID at agent startup in main.go The ClusterUID is fetched once at startup and passed to all exporters. If the kube-system namespace cannot be accessed (e.g., RBAC restrictions), a warning is logged and the field remains empty, allowing the agent to continue operating normally. Related PR: armosec/armoapi-go#602 Signed-off-by: Ben <ben@armosec.io>
📝 WalkthroughWalkthroughRetrieves a stable cluster UID from the Kubernetes kube-system namespace and threads that UID into exporter initialization and HTTP exporter alert payloads so emitted alerts include cluster identity. Changes
Sequence Diagram(s)sequenceDiagram
participant Main as Main
participant K8s as Kubernetes API
participant Utils as ClusterUID Utils
participant Exporters as Exporters Bus
participant HTTPExp as HTTP Exporter
participant Alerts as Alert Payloads
Main->>Utils: GetClusterUID(k8sClient)
Utils->>K8s: GET namespace/kube-system
K8s-->>Utils: namespace UID
Utils-->>Main: clusterUID
Main->>Exporters: InitExporters(..., clusterUID)
Exporters->>HTTPExp: NewHTTPExporter(..., clusterUID)
HTTPExp->>HTTPExp: store clusterUID
rect rgba(200,150,100,0.5)
Note over HTTPExp,Alerts: When building alerts
HTTPExp->>Alerts: set k8sDetails.ClusterUID = clusterUID
HTTPExp->>Alerts: set httpDetails.SourcePodInfo.ClusterUID = clusterUID
end
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@go.mod`:
- Line 10: The dependency was bumped to github.com/armosec/armoapi-go v0.0.672
without published release notes—before merging, run a vulnerability scan and
review the upstream changes: execute `govulncheck ./...` in the repo to detect
transitive vulnerabilities and inspect the upstream diff between tags
v0.0.671..v0.0.672 in the armosec/armoapi-go repository to confirm there are no
breaking or insecure changes; if issues are found, either revert the go.mod line
for github.com/armosec/armoapi-go to v0.0.671 or open a follow-up PR that pins a
safe version and documents the risk.
In `@pkg/utils/clusteruid.go`:
- Around line 15-23: The namespace lookup uses a background context with no
timeout; wrap the request in a cancellable context with a small timeout (e.g.,
3–5s) so k8sClient.CoreV1().Namespaces().Get uses that timed context and cannot
block startup indefinitely — create ctx, cancel :=
context.WithTimeout(context.Background(), timeout), defer cancel() and pass ctx
into Get; ensure the necessary time import is added and keep the existing error
handling and logging (helpers.Error, helpers.String) unchanged.
🧹 Nitpick comments (1)
pkg/exporters/http_exporter.go (1)
316-325: ClusterUID propagation on rule alerts looks good.Optional: consider also setting ClusterUID on the “Alert limit reached” alert so all runtime alert types carry it consistently.
Signed-off-by: Ben <ben@armosec.io>
Co-authored-by: Matthias Bertschy <matthias.bertschy@gmail.com> Signed-off-by: Ben Hirschberg <59160382+slashben@users.noreply.github.com>
|
I'll merge once the CI/CD is fixed by @bvolovat |
Signed-off-by: Matthias Bertschy <matthias.bertschy@gmail.com>
20ff4b4 to
3bd0607
Compare
This PR contains the following updates: | Package | Update | Change | |---|---|---| | [kubescape-operator](https://kubescape.io/) ([source](https://redirect.github.com/kubescape/helm-charts)) | patch | `1.30.2` → `1.30.3` | --- ### Release Notes <details> <summary>kubescape/helm-charts (kubescape-operator)</summary> ### [`v1.30.3`](https://redirect.github.com/kubescape/helm-charts/releases/tag/kubescape-operator-1.30.3) [Compare Source](https://redirect.github.com/kubescape/helm-charts/compare/kubescape-operator-1.30.2...kubescape-operator-1.30.3) Kubescape is an E2E Kubernetes cluster security platform #### What's Changed - chore: adding the ability to adjust the source of busybox by [@​drew-viles](https://redirect.github.com/drew-viles) in [#​784](https://redirect.github.com/kubescape/helm-charts/pull/784) - add k8s context tag by [@​YakirOren](https://redirect.github.com/YakirOren) in [#​785](https://redirect.github.com/kubescape/helm-charts/pull/785) - run system tests from private repo by [@​bvolovat](https://redirect.github.com/bvolovat) in [#​786](https://redirect.github.com/kubescape/helm-charts/pull/786) - add stream logs and wait for tests finish by [@​bvolovat](https://redirect.github.com/bvolovat) in [#​787](https://redirect.github.com/kubescape/helm-charts/pull/787) - fix attempt by [@​bvolovat](https://redirect.github.com/bvolovat) in [#​788](https://redirect.github.com/kubescape/helm-charts/pull/788) - Update 02-e2e-test.yaml by [@​armobot](https://redirect.github.com/armobot) in [#​789](https://redirect.github.com/kubescape/helm-charts/pull/789) - Run test from private repo by [@​bvolovat](https://redirect.github.com/bvolovat) in [#​791](https://redirect.github.com/kubescape/helm-charts/pull/791) - add workflow\_call by [@​bvolovat](https://redirect.github.com/bvolovat) in [#​792](https://redirect.github.com/kubescape/helm-charts/pull/792) - add startup probe by [@​YakirOren](https://redirect.github.com/YakirOren) in [#​793](https://redirect.github.com/kubescape/helm-charts/pull/793) - <kubescape/kubescape@v3.0.47...v3.0.48> - Fix typos in documentation by [@​oglok](https://redirect.github.com/oglok) in [kubescape/kubescape#1913](https://redirect.github.com/kubescape/kubescape/pull/1913) - fix: Kustomize directory analysis not working by [@​majiayu000](https://redirect.github.com/majiayu000) in [kubescape/kubescape#1914](https://redirect.github.com/kubescape/kubescape/pull/1914) - feat: Define labels to copy from workloads to reports by [@​majiayu000](https://redirect.github.com/majiayu000) in [kubescape/kubescape#1915](https://redirect.github.com/kubescape/kubescape/pull/1915) - Add SkipPersistence flag to MetricsQueryParams in metrics endpoint by [@​BroderPeters](https://redirect.github.com/BroderPeters) in [kubescape/kubescape#1917](https://redirect.github.com/kubescape/kubescape/pull/1917) - ci: update scorecard action version by [@​AndrewCharlesHay](https://redirect.github.com/AndrewCharlesHay) in [kubescape/kubescape#1918](https://redirect.github.com/kubescape/kubescape/pull/1918) - update test lists by [@​amirmalka](https://redirect.github.com/amirmalka) in [kubescape/kubescape#1919](https://redirect.github.com/kubescape/kubescape/pull/1919) - build(deps): Bump github.com/sigstore/cosign/v3 from 3.0.3-0.20251208232815-901b44d65952 to 3.0.4 by [@​dependabot](https://redirect.github.com/dependabot)\[bot] in [kubescape/kubescape#1920](https://redirect.github.com/kubescape/kubescape/pull/1920) - Update build number retrieval and permissions in workflow by [@​matthyx](https://redirect.github.com/matthyx) in [kubescape/kubescape#1921](https://redirect.github.com/kubescape/kubescape/pull/1921) - Fix workload scan to include allcontrols framework by [@​Copilot](https://redirect.github.com/Copilot) in [kubescape/kubescape#1922](https://redirect.github.com/kubescape/kubescape/pull/1922) - build(deps): Bump github.com/sigstore/fulcio from 1.8.4 to 1.8.5 by [@​dependabot](https://redirect.github.com/dependabot)\[bot] in [kubescape/kubescape#1923](https://redirect.github.com/kubescape/kubescape/pull/1923) - Fix panic on unsafe interface{} to string type assertions by [@​Copilot](https://redirect.github.com/Copilot) in [kubescape/kubescape#1926](https://redirect.github.com/kubescape/kubescape/pull/1926) - build(deps): Bump github.com/theupdateframework/go-tuf/v2 from 2.3.0 to 2.3.1 by [@​dependabot](https://redirect.github.com/dependabot)\[bot] in [kubescape/kubescape#1927](https://redirect.github.com/kubescape/kubescape/pull/1927) - build(deps): Bump github.com/sigstore/rekor from 1.4.3 to 1.5.0 by [@​dependabot](https://redirect.github.com/dependabot)\[bot] in [kubescape/kubescape#1928](https://redirect.github.com/kubescape/kubescape/pull/1928) - <kubescape/operator@v0.2.121...v0.2.126> - bump version by [@​jnathangreeg](https://redirect.github.com/jnathangreeg) in [kubescape/operator#349](https://redirect.github.com/kubescape/operator/pull/349) - Fix comment typo in checkECRRegistry function to clarify \_catalog end… by [@​jnathangreeg](https://redirect.github.com/jnathangreeg) in [kubescape/operator#351](https://redirect.github.com/kubescape/operator/pull/351) - add permissions by [@​bvolovat](https://redirect.github.com/bvolovat) in [kubescape/operator#352](https://redirect.github.com/kubescape/operator/pull/352) - bump github.com/armosec/armoapi-go v0.0.673 by [@​matthyx](https://redirect.github.com/matthyx) in [kubescape/operator#353](https://redirect.github.com/kubescape/operator/pull/353) - bump github.com/kubescape/go-logger v0.0.26 by [@​matthyx](https://redirect.github.com/matthyx) in [kubescape/operator#354](https://redirect.github.com/kubescape/operator/pull/354) - bump github.com/goradd/maps v1.3.0 by [@​matthyx](https://redirect.github.com/matthyx) in [kubescape/operator#355](https://redirect.github.com/kubescape/operator/pull/355) - <kubescape/kubevuln@v0.3.98...v0.3.104> - replace debian 12 with debian 13 when building container images by [@​pfarikrispy](https://redirect.github.com/pfarikrispy) in [kubescape/kubevuln#317](https://redirect.github.com/kubescape/kubevuln/pull/317) - Add comprehensive documentation and governance by [@​matthyx](https://redirect.github.com/matthyx) in [kubescape/kubevuln#318](https://redirect.github.com/kubescape/kubevuln/pull/318) - Bump github.com/cilium/cilium from 1.16.9 to 1.16.17 by [@​dependabot](https://redirect.github.com/dependabot)\[bot] in [kubescape/kubevuln#319](https://redirect.github.com/kubescape/kubevuln/pull/319) - Add timeout to Grype DB update with graceful fallback to prevent indefinite readiness probe failures by [@​Copilot](https://redirect.github.com/Copilot) in [kubescape/kubevuln#320](https://redirect.github.com/kubescape/kubevuln/pull/320) - Prevent DB update cancellation on readiness probe by [@​matthyx](https://redirect.github.com/matthyx) in [kubescape/kubevuln#321](https://redirect.github.com/kubescape/kubevuln/pull/321) - <kubescape/storage@v0.0.237...v0.0.239> - feat: handle large object storage by clearing spec and updating annotations by [@​matthyx](https://redirect.github.com/matthyx) in [kubescape/storage#279](https://redirect.github.com/kubescape/storage/pull/279) - bump k8s version to v0.35.0 by [@​matthyx](https://redirect.github.com/matthyx) in [kubescape/storage#280](https://redirect.github.com/kubescape/storage/pull/280) - <kubescape/node-agent@v0.3.11...v0.3.36> - feat: propagate IsTriggerAlert field from rules to runtime alerts by [@​slashben](https://redirect.github.com/slashben) in [kubescape/node-agent#686](https://redirect.github.com/kubescape/node-agent/pull/686) - Generating release by [@​slashben](https://redirect.github.com/slashben) in [kubescape/node-agent#688](https://redirect.github.com/kubescape/node-agent/pull/688) - Feature/rule engine redesign by [@​YakirOren](https://redirect.github.com/YakirOren) in [kubescape/node-agent#685](https://redirect.github.com/kubescape/node-agent/pull/685) - refactor: update cloud metadata types to use armotypes package by [@​matthyx](https://redirect.github.com/matthyx) in [kubescape/node-agent#689](https://redirect.github.com/kubescape/node-agent/pull/689) - Replace host sensor with node agent sensing by [@​Bezbran](https://redirect.github.com/Bezbran) in [kubescape/node-agent#681](https://redirect.github.com/kubescape/node-agent/pull/681) - use k8s-interface by [@​Bezbran](https://redirect.github.com/Bezbran) in [kubescape/node-agent#691](https://redirect.github.com/kubescape/node-agent/pull/691) - optimize header parsing and add early return in ruleAppliesToContext by [@​YakirOren](https://redirect.github.com/YakirOren) in [kubescape/node-agent#692](https://redirect.github.com/kubescape/node-agent/pull/692) - improve field accessor retrieval with nil checks and type assertions by [@​matthyx](https://redirect.github.com/matthyx) in [kubescape/node-agent#694](https://redirect.github.com/kubescape/node-agent/pull/694) - Bump github.com/sigstore/sigstore from 1.9.5 to 1.10.4 by [@​dependabot](https://redirect.github.com/dependabot)\[bot] in [kubescape/node-agent#696](https://redirect.github.com/kubescape/node-agent/pull/696) - Add Azure ResourceGroup enrichment to CloudMetadata by [@​slashben](https://redirect.github.com/slashben) in [kubescape/node-agent#697](https://redirect.github.com/kubescape/node-agent/pull/697) - Add unit tests for Azure ResourceGroup parsing by [@​slashben](https://redirect.github.com/slashben) in [kubescape/node-agent#698](https://redirect.github.com/kubescape/node-agent/pull/698) - remove toMap function by [@​YakirOren](https://redirect.github.com/YakirOren) in [kubescape/node-agent#693](https://redirect.github.com/kubescape/node-agent/pull/693) - run system test from private repo by [@​bvolovat](https://redirect.github.com/bvolovat) in [kubescape/node-agent#700](https://redirect.github.com/kubescape/node-agent/pull/700) - bump: update golang-set dependency to v2.8.0 by [@​matthyx](https://redirect.github.com/matthyx) in [kubescape/node-agent#701](https://redirect.github.com/kubescape/node-agent/pull/701) - bump: update armoapi-go dependency to v0.0.671 by [@​matthyx](https://redirect.github.com/matthyx) in [kubescape/node-agent#702](https://redirect.github.com/kubescape/node-agent/pull/702) - update the tests\_groups by [@​bvolovat](https://redirect.github.com/bvolovat) in [kubescape/node-agent#703](https://redirect.github.com/kubescape/node-agent/pull/703) - bump: update dependencies for backend, storage, and OpenAPI packages by [@​matthyx](https://redirect.github.com/matthyx) in [kubescape/node-agent#704](https://redirect.github.com/kubescape/node-agent/pull/704) - update chart repo by [@​bvolovat](https://redirect.github.com/bvolovat) in [kubescape/node-agent#705](https://redirect.github.com/kubescape/node-agent/pull/705) - bump: update cel-go dependency to v0.26.1 by [@​matthyx](https://redirect.github.com/matthyx) in [kubescape/node-agent#706](https://redirect.github.com/kubescape/node-agent/pull/706) - Implement ClusterUID enrichment for runtime alerts by [@​slashben](https://redirect.github.com/slashben) in [kubescape/node-agent#708](https://redirect.github.com/kubescape/node-agent/pull/708) - fix a bug where failed expressions would recompile on every event by [@​YakirOren](https://redirect.github.com/YakirOren) in [kubescape/node-agent#690](https://redirect.github.com/kubescape/node-agent/pull/690) - fix container watcher error propagation by [@​YakirOren](https://redirect.github.com/YakirOren) in [kubescape/node-agent#709](https://redirect.github.com/kubescape/node-agent/pull/709) - add permissions by [@​bvolovat](https://redirect.github.com/bvolovat) in [kubescape/node-agent#710](https://redirect.github.com/kubescape/node-agent/pull/710) - upgrade to IG v0.48.1 by [@​matthyx](https://redirect.github.com/matthyx) in [kubescape/node-agent#695](https://redirect.github.com/kubescape/node-agent/pull/695) - <kubescape/synchronizer@v0.0.127...v0.0.128> - perf: optimize memory usage by avoiding string-to-byte conversions by [@​amirmalka](https://redirect.github.com/amirmalka) in [kubescape/synchronizer#135](https://redirect.github.com/kubescape/synchronizer/pull/135) #### New Contributors - [@​drew-viles](https://redirect.github.com/drew-viles) made their first contribution in [#​784](https://redirect.github.com/kubescape/helm-charts/pull/784) - [@​YakirOren](https://redirect.github.com/YakirOren) made their first contribution in [#​785](https://redirect.github.com/kubescape/helm-charts/pull/785) - [@​armobot](https://redirect.github.com/armobot) made their first contribution in [#​789](https://redirect.github.com/kubescape/helm-charts/pull/789) - [@​pfarikrispy](https://redirect.github.com/pfarikrispy) made their first contribution in [kubescape/kubevuln#317](https://redirect.github.com/kubescape/kubevuln/pull/317) - [@​bvolovat](https://redirect.github.com/bvolovat) made their first contribution in [kubescape/operator#352](https://redirect.github.com/kubescape/operator/pull/352) - [@​oglok](https://redirect.github.com/oglok) made their first contribution in [kubescape/kubescape#1913](https://redirect.github.com/kubescape/kubescape/pull/1913) - [@​majiayu000](https://redirect.github.com/majiayu000) made their first contribution in [kubescape/kubescape#1914](https://redirect.github.com/kubescape/kubescape/pull/1914) - [@​BroderPeters](https://redirect.github.com/BroderPeters) made their first contribution in [kubescape/kubescape#1917](https://redirect.github.com/kubescape/kubescape/pull/1917) - [@​AndrewCharlesHay](https://redirect.github.com/AndrewCharlesHay) made their first contribution in [kubescape/kubescape#1918](https://redirect.github.com/kubescape/kubescape/pull/1918) - [@​Bezbran](https://redirect.github.com/Bezbran) made their first contribution in [kubescape/node-agent#681](https://redirect.github.com/kubescape/node-agent/pull/681) - [@​bvolovat](https://redirect.github.com/bvolovat) made their first contribution in [kubescape/node-agent#700](https://redirect.github.com/kubescape/node-agent/pull/700) **Full Changelog**: <kubescape/helm-charts@kubescape-operator-1.30.2...kubescape-operator-1.30.3> </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/Darkflame72/home-ops). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0Mi45NS4yIiwidXBkYXRlZEluVmVyIjoiNDIuOTUuMiIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsicmVub3ZhdGUvaGVsbSIsInR5cGUvcGF0Y2giXX0=--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Summary
Implement ClusterUID enrichment for runtime alerts by fetching the kube-system namespace UID and populating it in all RuntimeAlert structures.
Changes
Dependencies
armoapi-goto v0.0.672 (includes new ClusterUID field)New Files
pkg/utils/clusteruid.go- Utility function to fetch kube-system namespace UIDModified Files
cmd/main.go- Fetch ClusterUID at startup and pass to exporterspkg/exporters/exporters_bus.go- Update InitExporters to accept clusterUID parameterpkg/exporters/http_exporter.go- Store and populate ClusterUID in alertsImplementation Details
Startup Phase: After creating the Kubernetes client, the agent fetches the UID of the
kube-systemnamespace using the newGetClusterUIDutility function.Error Handling: If the namespace cannot be accessed (e.g., due to RBAC restrictions), a warning is logged and an empty string is returned. The agent continues operating normally with an empty ClusterUID field.
Alert Enrichment: The ClusterUID is passed through the exporter chain and populated in:
RuntimeAlertK8sDetails.ClusterUIDfor all K8s alertsHttpRuleAlert.SourcePodInfo.ClusterUIDfor HTTP rule alertsBackward Compatibility: The field uses
omitemptyand existing functionality is not affected if ClusterUID is empty.Testing
Related PRs
Next Steps
After this PR is merged and a new version is released:
namespacesget/list)RBAC Requirements
Note: For ClusterUID to be populated, the agent's ServiceAccount needs permissions to read namespaces:
This will be added to Helm charts in a separate PR.
Summary by CodeRabbit
New Features
Tests
Chores