VULN-92045 resolve DatadogMetric references in the referencing namespace - #54218
Conversation
|
Bits Code status: ✅ Done Comment @DataDog to request changes |
|
I can only run on private repositories. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 26a37572b8
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
🎯 Code Coverage (details) 🔗 Commit SHA: d33f6e4 | Docs | Datadog PR Page | Give us feedback! |
Files inventory check summaryFile checks results against ancestor 95ac563f: Results for datadog-agent_7.83.0~devel.git.523.d33f6e4.pipeline.128914745-1_amd64.deb:No change detected |
Static quality checks✅ Please find below the results from static quality gates 32 successful checks with minimal change (< 2 KiB)
|
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: 8cc30d2 Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | quality_gate_logs | % cpu utilization | +3.11 | [+2.23, +3.98] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_metrics_logs | memory utilization | +0.78 | [+0.54, +1.03] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_idle_all_features | memory utilization | +0.53 | [+0.48, +0.57] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_security_no_fs_load | memory utilization | +0.29 | [+0.19, +0.39] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_idle | memory utilization | -0.09 | [-0.14, -0.05] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_security_idle | memory utilization | -0.19 | [-0.24, -0.13] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_private_action_runner | memory utilization | -0.22 | [-0.34, -0.09] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_security_mean_fs_load | memory utilization | -0.28 | [-0.32, -0.25] | 1 | Logs bounds checks dashboard |
Bounds Checks: ✅ Passed
| perf | experiment | bounds_check_name | replicates_passed | observed_value | links |
|---|---|---|---|---|---|
| ✅ | quality_gate_idle | intake_connections | 10/10 | 3 ≤ 4 | bounds checks dashboard |
| ✅ | quality_gate_idle | memory_usage | 10/10 | 147.58MiB ≤ 154MiB | bounds checks dashboard |
| ✅ | quality_gate_idle | total_bytes_received | 10/10 | 731.29KiB ≤ 819.20KiB | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | intake_connections | 10/10 | 3 ≤ 4 | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | memory_usage | 10/10 | 492.54MiB ≤ 512MiB | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | total_bytes_received | 10/10 | 1.12MiB ≤ 1.25MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | intake_connections | 10/10 | 4 ≤ 6 | bounds checks dashboard |
| ✅ | quality_gate_logs | memory_usage | 10/10 | 185.75MiB ≤ 195MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | missed_bytes | 10/10 | 0B = 0B | bounds checks dashboard |
| ✅ | quality_gate_logs | total_bytes_received | 10/10 | 264.35MiB ≤ 292MiB | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | cpu_usage | 10/10 | 361.56 ≤ 2000 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | intake_connections | 10/10 | 3 ≤ 6 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | memory_usage | 10/10 | 409.14MiB ≤ 430MiB | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | missed_bytes | 10/10 | 0B = 0B | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | total_bytes_received | 10/10 | 0.94GiB ≤ 1.04GiB | bounds checks dashboard |
| ✅ | quality_gate_private_action_runner | memory_usage | 10/10 | 70.86MiB ≤ 75MiB | bounds checks dashboard |
| ✅ | quality_gate_security_idle | cpu_usage | 10/10 | 28.29 ≤ 100 | bounds checks dashboard |
| ✅ | quality_gate_security_idle | memory_usage | 10/10 | 302.77MiB ≤ 330MiB | bounds checks dashboard |
| ✅ | quality_gate_security_mean_fs_load | cpu_usage | 10/10 | 61.13 ≤ 200 | bounds checks dashboard |
| ✅ | quality_gate_security_mean_fs_load | memory_usage | 10/10 | 279.30MiB ≤ 310MiB | bounds checks dashboard |
| ✅ | quality_gate_security_no_fs_load | cpu_usage | 10/10 | 22.85 ≤ 100 | bounds checks dashboard |
| ✅ | quality_gate_security_no_fs_load | memory_usage | 10/10 | 289.89MiB ≤ 320MiB | bounds checks dashboard |
Explanation
Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%
Performance changes are noted in the perf column of each table:
- ✅ = significantly better comparison variant performance
- ❌ = significantly worse comparison variant performance
- ➖ = no significant change in performance
A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".
For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:
-
Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.
-
Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.
-
Its configuration does not mark it "erratic".
Replicate Execution Details
We run multiple replicates for each experiment/variant. However, we allow replicates to be automatically retried if there are any failures, up to 8 times, at which point the replicate is marked dead and we are unable to run analysis for the entire experiment. We call each of these attempts at running replicates a replicate execution. This section lists all replicate executions that failed due to the target crashing or being oom killed.
Note: In the below tables we bucket failures by experiment, variant, and failure type. For each of these buckets we list out the replicate indexes that failed with an annotation signifying how many times said replicate failed with the given failure mode. In the below example the baseline variant of the experiment named experiment_with_failures had two replicates that failed by oom kills. Replicate 0, which failed 8 executions, and replicate 1 which failed 6 executions, all with the same failure mode.
| Experiment | Variant | Replicates | Failure | Logs | Debug Dashboard |
|---|---|---|---|---|---|
| experiment_with_failures | baseline | 0 (x8) 1 (x6) | Oom killed | Debug Dashboard |
The debug dashboard links will take you to a debugging dashboard specifically designed to investigate replicate execution failures.
❌ Retried Profiling Replicate Execution Failures (ddprof)
Note: Profiling replicas may still be executing. See the debug dashboard for up to date status.
| Experiment | Variant | Replicates | Failure | Debug Dashboard |
|---|---|---|---|---|
| quality_gate_idle_all_features | baseline | 10 | Oom killed | Debug Dashboard |
| quality_gate_logs | baseline | 10 | Oom killed | Debug Dashboard |
| quality_gate_logs | comparison | 10 | Oom killed | Debug Dashboard |
| quality_gate_metrics_logs | baseline | 10 | Oom killed | Debug Dashboard |
| quality_gate_metrics_logs | comparison | 10 | Oom killed | Debug Dashboard |
| quality_gate_security_idle | baseline | 10 | Crashed (exit code: 134) | Debug Dashboard |
| quality_gate_security_mean_fs_load | baseline | 10 | Crashed (exit code: 134) | Debug Dashboard |
| quality_gate_security_no_fs_load | baseline | 10 | Oom killed | Debug Dashboard |
| quality_gate_security_no_fs_load | comparison | 10 | Crashed (exit code: 134) | Debug Dashboard |
CI Pass/Fail Decision
✅ Passed. All Quality Gates passed.
- quality_gate_security_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_security_idle, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
- quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_idle, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check missed_bytes: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
- quality_gate_security_mean_fs_load, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
- quality_gate_security_mean_fs_load, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_idle_all_features, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
- quality_gate_private_action_runner, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_security_no_fs_load, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
- quality_gate_security_no_fs_load, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_logs, bounds check missed_bytes: 10/10 replicas passed. Gate passed.
- quality_gate_logs, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
|
The implementation works. The original idea was indeed to allow cross-namespace usage of an object in case of sharing, but with this change it would probably make more sense to make the |
@vboulineau updated |
vboulineau
left a comment
There was a problem hiding this comment.
LGTM, but requires a clear entry in release note
| @@ -0,0 +1,30 @@ | |||
| --- | |||
There was a problem hiding this comment.
@vboulineau please check if this makes sense
The external metrics provider resolved a DatadogMetric using only the namespace embedded in the `datadogmetric@<namespace>:<name>` metric name, without comparing it to the namespace the request was authorized for. In a multi-tenant cluster, a tenant could read another tenant's DatadogMetric values and, through the autoscaler watcher, mark those DatadogMetrics active so their Datadog queries kept running against shared API quota. Cross-namespace sharing was the original intent of the `<namespace>:` syntax, but it has no authorization model behind it. Rather than adding one, drop the capability: the namespace part becomes an optional group in the parser and is discarded at read time, so a DatadogMetric is always resolved in the namespace of the object referencing it. A cross-namespace reference now resolves to a DatadogMetric that does not exist and errors out as not found. `metricNameToDatadogMetricID` takes the referencing namespace and builds the ID from it; the provider passes the request namespace and the autoscaler watcher passes the HPA/WPA namespace. `datadogmetric@<name>` without a namespace is now valid and resolves the same way, so existing same-namespace manifests keep working unchanged either way. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
4e02e07 to
d33f6e4
Compare
…ace (#54218) <!-- dd-meta {"pullId":"00000000-0000-0000-0000-000000000000","source":"chat","resourceId":"c4ad7c08-91ff-417c-ba4c-46e80bea665a","workflowId":"8c98a1cb-9292-475c-92c3-1ad5cdb2fd04","codeChangeId":"8c98a1cb-9292-475c-92c3-1ad5cdb2fd04","sourceType":"chat"} --> <!--Please give us some feedback on your experience writing this PR ! https://app.datadoghq.com/forms/43db4c02-6837-400c-8083-692e141b1b88 !--> ### What does this PR do? Makes a `datadogmetric@<namespace>:<name>` external metric reference always resolve in the namespace of the object doing the referencing, instead of the namespace embedded in the metric name. - `metricNameToDatadogMetricID` now takes the referencing namespace and builds the DatadogMetric ID from it. The `<namespace>:` part of the reference becomes an optional group in the parser and is discarded at read time. - `datadogMetricProvider.getExternalMetric` passes the request namespace, so a request from namespace `A` for `datadogmetric@B:name` looks up `A/name` and returns the usual not-found error. - `AutoscalerWatcher.extractAutoscalerReference` passes the HPA/WPA namespace, so a cross-namespace reference can no longer mark a foreign DatadogMetric active or make `metrics_retriever` refresh it. - `datadogmetric@<name>` (no namespace) is now a valid reference and resolves to the referencing namespace, so the namespace is only ever redundant, never meaningful. - Adds coverage for a tenant namespace attempting to read or activate a DatadogMetric owned by another namespace, and for the namespace-less reference form. ### Motivation Addresses VULN-92045. The external metrics provider resolved a DatadogMetric using only the namespace embedded in the metric name, with no comparison against the namespace the request was authorized for. In a multi-tenant cluster, tenant `A` could read tenant `B`'s DatadogMetric values, and — through the autoscaler watcher — mark `B`'s DatadogMetrics active, mutating their status and forcing their Datadog queries to run against shared API quota. Cross-namespace sharing was the original intent of the `<namespace>:` syntax, but it has no authorization model behind it. Rather than adding one, this PR drops the capability and keeps the syntax accepted-but-ignored so existing same-namespace manifests keep working unchanged. ### Describe how you validated your changes - `dda inv test --targets=./pkg/clusteragent/autoscaling/externalmetrics --build-include=kubeapiserver,test` — 110 tests pass. (The `test` build tag is required, otherwise `datadogmetric_controller_test.go` fails to build against `autoscaling.FilterInformerActions`.) - `dda inv linter.go --targets=./pkg/clusteragent/autoscaling/externalmetrics --build-tags=kubeapiserver,test` — 0 issues. ### Additional Notes Behavior change for anyone relying on cross-namespace references: an HPA in namespace `A` pointing at `datadogmetric@B:name` now resolves to `A/name` and fails as not-found rather than reading `B/name`. There is no way to opt back in. `datadogmetric@:<name>` (empty namespace) does not parse, matching the behavior before this PR. Created by Auto-JIRA (https://github.com/DataDog/datadog-agent/blob/main/.agents/skills/auto-jira/SKILL.md). --- PR by Bits - [View session in Datadog](https://app.datadoghq.com/code/c4ad7c08-91ff-417c-ba4c-46e80bea665a) Comment @DataDog to request changes Co-authored-by: hasan.mahmood <hasan.mahmood@datadoghq.com> 68e4d34
What does this PR do?
Makes a
datadogmetric@<namespace>:<name>external metric reference always resolve in the namespace of the object doing the referencing, instead of the namespace embedded in the metric name.metricNameToDatadogMetricIDnow takes the referencing namespace and builds the DatadogMetric ID from it. The<namespace>:part of the reference becomes an optional group in the parser and is discarded at read time.datadogMetricProvider.getExternalMetricpasses the request namespace, so a request from namespaceAfordatadogmetric@B:namelooks upA/nameand returns the usual not-found error.AutoscalerWatcher.extractAutoscalerReferencepasses the HPA/WPA namespace, so a cross-namespace reference can no longer mark a foreign DatadogMetric active or makemetrics_retrieverrefresh it.datadogmetric@<name>(no namespace) is now a valid reference and resolves to the referencing namespace, so the namespace is only ever redundant, never meaningful.Motivation
Addresses VULN-92045. The external metrics provider resolved a DatadogMetric using only the namespace embedded in the metric name, with no comparison against the namespace the request was authorized for. In a multi-tenant cluster, tenant
Acould read tenantB's DatadogMetric values, and — through the autoscaler watcher — markB's DatadogMetrics active, mutating their status and forcing their Datadog queries to run against shared API quota.Cross-namespace sharing was the original intent of the
<namespace>:syntax, but it has no authorization model behind it. Rather than adding one, this PR drops the capability and keeps the syntax accepted-but-ignored so existing same-namespace manifests keep working unchanged.Describe how you validated your changes
dda inv test --targets=./pkg/clusteragent/autoscaling/externalmetrics --build-include=kubeapiserver,test— 110 tests pass. (Thetestbuild tag is required, otherwisedatadogmetric_controller_test.gofails to build againstautoscaling.FilterInformerActions.)dda inv linter.go --targets=./pkg/clusteragent/autoscaling/externalmetrics --build-tags=kubeapiserver,test— 0 issues.Additional Notes
Behavior change for anyone relying on cross-namespace references: an HPA in namespace
Apointing atdatadogmetric@B:namenow resolves toA/nameand fails as not-found rather than readingB/name. There is no way to opt back in.datadogmetric@:<name>(empty namespace) does not parse, matching the behavior before this PR.Created by Auto-JIRA (https://github.com/DataDog/datadog-agent/blob/main/.agents/skills/auto-jira/SKILL.md).
PR by Bits - View session in Datadog
Comment @DataDog to request changes