feat(orchestrator): add OOTB CRD collection for Gateway API, service mesh, and ingress controllers#48966
Conversation
…mesh, and ingress controllers Add 22 new builtin CRD entries to the orchestrator explorer so Cloud Security can determine internet-reachability paths for k8s workloads. Uses a hybrid collection strategy: resource-specific entries for high-volume vendors (Istio, NGINX, Traefik) to control isForbidden API call volume, and group-level entries for less common vendors. Three new per-family config flags allow operators to disable specific families independently: - orchestrator_explorer.custom_resources.ootb.gateway_api - orchestrator_explorer.custom_resources.ootb.service_mesh - orchestrator_explorer.custom_resources.ootb.ingress_controllers Constraint: Must reuse existing K8sCR pipeline — no new entity kinds Constraint: isForbidden does a live List API call per resource, so resource-specific entries used for top vendors to limit call count Rejected: All group-level entries | isForbidden scaling (60-100+ API calls worst case) Rejected: Single global flag only | operators need per-family opt-out Confidence: high Scope-risk: moderate Not-tested: clusters running all supported meshes simultaneously (theoretical 48-54 isForbidden calls)
Gateway API, service mesh, and ingress controller collection should be opt-in, not opt-out. Users must explicitly enable via config or RBAC (helm/operator) before these CRDs are collected. Constraint: RBAC must be granted before collection can work
Files inventory check summaryFile checks results against ancestor 00ba5786: Results for datadog-agent_7.79.0~devel.git.472.82a8f86.pipeline.106602452-1_amd64.deb:No change detected |
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: eed7901 Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | docker_containers_cpu | % cpu utilization | -1.19 | [-4.12, +1.75] | 1 | Logs |
Fine details of change detection per experiment
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | quality_gate_metrics_logs | memory utilization | +2.16 | [+1.92, +2.40] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_logs | % cpu utilization | +1.68 | [+0.04, +3.33] | 1 | Logs bounds checks dashboard |
| ➖ | file_tree | memory utilization | +0.75 | [+0.70, +0.81] | 1 | Logs |
| ➖ | otlp_ingest_metrics | memory utilization | +0.45 | [+0.29, +0.61] | 1 | Logs |
| ➖ | ddot_logs | memory utilization | +0.30 | [+0.22, +0.37] | 1 | Logs |
| ➖ | docker_containers_memory | memory utilization | +0.29 | [+0.21, +0.37] | 1 | Logs |
| ➖ | quality_gate_idle | memory utilization | +0.18 | [+0.12, +0.23] | 1 | Logs bounds checks dashboard |
| ➖ | uds_dogstatsd_20mb_12k_contexts_20_senders | memory utilization | +0.11 | [+0.05, +0.17] | 1 | Logs |
| ➖ | tcp_syslog_to_blackhole | ingress throughput | +0.08 | [-0.09, +0.26] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | +0.03 | [-0.40, +0.46] | 1 | Logs |
| ➖ | ddot_metrics_sum_delta | memory utilization | +0.03 | [-0.14, +0.20] | 1 | Logs |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | +0.02 | [-0.10, +0.14] | 1 | Logs |
| ➖ | tcp_dd_logs_filter_exclude | ingress throughput | +0.00 | [-0.11, +0.11] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | -0.01 | [-0.20, +0.19] | 1 | Logs |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | -0.01 | [-0.41, +0.39] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api_v3 | ingress throughput | -0.02 | [-0.23, +0.19] | 1 | Logs |
| ➖ | quality_gate_idle_all_features | memory utilization | -0.02 | [-0.06, +0.01] | 1 | Logs bounds checks dashboard |
| ➖ | file_to_blackhole_0ms_latency | egress throughput | -0.11 | [-0.68, +0.45] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulativetodelta_exporter | memory utilization | -0.22 | [-0.44, +0.01] | 1 | Logs |
| ➖ | ddot_metrics | memory utilization | -0.30 | [-0.47, -0.12] | 1 | Logs |
| ➖ | otlp_ingest_logs | memory utilization | -0.33 | [-0.43, -0.23] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulative | memory utilization | -0.62 | [-0.76, -0.48] | 1 | Logs |
| ➖ | docker_containers_cpu | % cpu utilization | -1.19 | [-4.12, +1.75] | 1 | Logs |
Bounds Checks: ✅ Passed
| perf | experiment | bounds_check_name | replicates_passed | observed_value | links |
|---|---|---|---|---|---|
| ✅ | docker_containers_cpu | simple_check_run | 10/10 | 696 ≥ 26 | |
| ✅ | docker_containers_memory | memory_usage | 10/10 | 276.50MiB ≤ 370MiB | |
| ✅ | docker_containers_memory | simple_check_run | 10/10 | 647 ≥ 26 | |
| ✅ | file_to_blackhole_0ms_latency | memory_usage | 10/10 | 0.19GiB ≤ 1.20GiB | |
| ✅ | file_to_blackhole_0ms_latency | missed_bytes | 10/10 | 0B = 0B | |
| ✅ | file_to_blackhole_1000ms_latency | memory_usage | 10/10 | 0.23GiB ≤ 1.20GiB | |
| ✅ | file_to_blackhole_1000ms_latency | missed_bytes | 10/10 | 0B = 0B | |
| ✅ | file_to_blackhole_100ms_latency | memory_usage | 10/10 | 0.20GiB ≤ 1.20GiB | |
| ✅ | file_to_blackhole_100ms_latency | missed_bytes | 10/10 | 0B = 0B | |
| ✅ | file_to_blackhole_500ms_latency | memory_usage | 10/10 | 0.21GiB ≤ 1.20GiB | |
| ✅ | file_to_blackhole_500ms_latency | missed_bytes | 10/10 | 0B = 0B | |
| ✅ | quality_gate_idle | intake_connections | 10/10 | 3 = 3 | bounds checks dashboard |
| ✅ | quality_gate_idle | memory_usage | 10/10 | 176.21MiB ≤ 181MiB | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | intake_connections | 10/10 | 3 = 3 | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | memory_usage | 10/10 | 495.55MiB ≤ 550MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | intake_connections | 10/10 | 4 ≤ 6 | bounds checks dashboard |
| ✅ | quality_gate_logs | memory_usage | 10/10 | 207.23MiB ≤ 220MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | missed_bytes | 10/10 | 0B = 0B | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | cpu_usage | 10/10 | 357.93 ≤ 2000 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | intake_connections | 10/10 | 4 ≤ 6 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | memory_usage | 10/10 | 432.62MiB ≤ 475MiB | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | missed_bytes | 10/10 | 0B = 0B | 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".
CI Pass/Fail Decision
✅ Passed. All Quality Gates passed.
- quality_gate_metrics_logs, bounds check memory_usage: 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 cpu_usage: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check intake_connections: 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, 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_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 memory_usage: 10/10 replicas passed. Gate passed.
Static quality checks✅ Please find below the results from static quality gates Successful checksInfo
14 successful checks with minimal change (< 2 KiB)
On-wire sizes (compressed)
|
Older Istio clusters (pre-1.22) only serve networking.istio.io/v1alpha3. Add it as a fallback version so those clusters are not silently excluded.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 82a8f86af3
ℹ️ 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".
rahulkaukuntla
left a comment
There was a problem hiding this comment.
config options LGTM
…agent
When networkCRDs.enabled=true, set all three per-family agent config flags
on the cluster-agent pod so collection is activated alongside the RBAC:
DD_ORCHESTRATOR_EXPLORER_CUSTOM_RESOURCES_OOTB_GATEWAY_API=true
DD_ORCHESTRATOR_EXPLORER_CUSTOM_RESOURCES_OOTB_SERVICE_MESH=true
DD_ORCHESTRATOR_EXPLORER_CUSTOM_RESOURCES_OOTB_INGRESS_CONTROLLERS=true
These map to orchestrator_explorer.custom_resources.ootb.{gateway_api,
service_mesh,ingress_controllers} in the agent config (DataDog/datadog-agent#48966).
What does this PR do?
Adds 22 new builtin CRD entries to the orchestrator explorer so Cloud Security can determine internet-reachability paths for k8s workloads. Uses a hybrid collection strategy: resource-specific entries for high-volume vendors (Istio, NGINX, Traefik) and group-level entries for less common vendors.
Three new per-family config flags (all opt-in, default: false):
orchestrator_explorer.custom_resources.ootb.gateway_apiorchestrator_explorer.custom_resources.ootb.service_meshorchestrator_explorer.custom_resources.ootb.ingress_controllersNew families:
Motivation
Cloud Security needs to tell customers which container workloads are internet-reachable. Today, the agent collects standard Ingress and Service objects, covering ~16% of EKS customers. Over 36% use service meshes or non-standard ingress controllers whose exposure paths go through CRDs we don't collect.
RFC: https://datadoghq.atlassian.net/wiki/x/4IOyfAE
Technical implementation: https://datadoghq.atlassian.net/wiki/x/EgO6fAE
Describe how you validated your changes
TestNewBuiltinCRDConfigs,TestImportBuiltinCollectors,TestGetDatadogCustomResourceCollectors,TestFilterCRCollectorsByPermissionTestNewBuiltinCRDConfigsPerFamilyFlagsverifies each per-family flag independently disables its family, and the global OOTB flag disables everythinggo build -tags "kubeapiserver orchestrator"Additional Notes
All three flags default to
false(opt-in). Collection is only activated when RBAC is granted (via helm/operator) and the corresponding flag is set totrue.Merge order: The backend allowlist PR (dd-go) must be deployed before this PR merges, otherwise collected CRs will be silently dropped.
Related PRs