Skip to content

[PAR] Add runRemediationCommand rshell action#52490

Merged
gh-worker-dd-mergequeue-cf854d[bot] merged 5 commits into
mainfrom
jules.macret/rshell-remediation-action
Jun 22, 2026
Merged

[PAR] Add runRemediationCommand rshell action#52490
gh-worker-dd-mergequeue-cf854d[bot] merged 5 commits into
mainfrom
jules.macret/rshell-remediation-action

Conversation

@julesmcrt

Copy link
Copy Markdown
Contributor

What does this PR do?

Adds a new Private Action Runner action com.datadoghq.remoteaction.rshell.runRemediationCommand, a sibling of the existing runCommand. It runs the restricted shell (rshell) in remediation mode (interp.ModeRemediation) instead of read-only mode.

Remediation mode (introduced in rshell #526 / #532) permits:

  • file-target output redirections — >, >>, 2>, &>, &>>
  • write-oriented builtins such as truncate

all still confined to the configured AllowedPaths sandbox.

Changes

  • Bump github.com/DataDog/rshell v0.0.20v0.0.21.
  • Refactor RunCommandHandler to be parameterized by interp.Mode; runCommand keeps read-only behavior, runRemediationCommand uses remediation mode. The two actions share all sandboxing/allowlist-intersection logic.
  • Register runRemediationCommand in the rshell bundle.
  • Unit tests + parallel E2E tests + release note.

Motivation

Enable operator-authorized remediation workflows (writing/truncating files within the sandbox) while keeping runCommand strictly read-only.

Describe how you validated your changes

  • dda inv test --targets=./pkg/privateactionrunner/bundles/remoteaction/rshell/ — 126 unit tests pass, including new coverage:
    • both actions register with the expected mode
    • remediation: in-sandbox redirect writes the file
    • read-only: same redirect is rejected, no file created
    • remediation: out-of-sandbox redirect is still rejected
  • E2E tests/privateactionrunner package compiles; added TestRshellRemediationWriteFile (write + read-back) and TestRshellRunCommandBlocksWrite.

Security / rollout notes

  • ⚠️ Not default-enabled. runRemediationCommand is intentionally left out of defaultCommonActionFQNs. Being write-capable, it must be explicitly added to a runner's actions_allowlist.
  • Operators already using a wildcard allowlist entry (e.g. com.datadoghq.remoteaction.rshell.* or com.datadoghq.remoteaction.*) would pick this action up automatically — worth a security reviewer's attention.
  • Path/command allowlists (restricted_shell.allowed_paths / allowed_commands) are shared with runCommand. A follow-up could add a separate, narrower write-allowlist if desired.

Possible drawbacks / trade-offs

  • Shared allowlist means operators can't currently grant broad read paths but narrow write paths in one config.

Additional Notes

Draft — pending review of the default-enablement decision and whether a dedicated remediation allowlist is wanted.

🤖 Generated with Claude Code

Bump rshell to v0.0.21 and add a new Private Action Runner action
`com.datadoghq.remoteaction.rshell.runRemediationCommand`, a sibling of
`runCommand` that runs the restricted shell in remediation mode
(interp.ModeRemediation) instead of read-only mode.

Remediation mode permits file-target output redirections (>, >>, 2>, &>,
&>>) and write-oriented builtins such as `truncate`, all still confined to
the configured AllowedPaths sandbox. The two actions share all sandboxing
logic via a parameterized handler; runCommand's behavior is unchanged.

The action is intentionally not added to the default-enabled FQN list:
being write-capable, it must be explicitly added to the runner's actions
allowlist by an operator.

Adds unit tests (mode wiring, in-sandbox write allowed, read-only write
blocked, out-of-sandbox write blocked), parallel E2E tests, and a release
note.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
@datadog-prod-us1-5

datadog-prod-us1-5 Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Pipelines

Fix all issues with BitsAI

⚠️ Warnings

🚦 4 Pipeline jobs failed

DataDog/datadog-agent | oracle: [21.3.0-xe]   View in Datadog   GitLab

Label analysis | team-label-check   View in Datadog   GitHub Actions

DataDog/datadog-agent | tests_linux-x64-py3_hybrid   View in Datadog   GitLab

View all 4 failed jobs.

ℹ️ Info

🎯 Code Coverage (details)
Patch Coverage: 100.00%
Overall Coverage: 50.93% (-0.01%)

Useful? React with 👍 / 👎

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: b11b36c | Docs | Datadog PR Page | Give us feedback!

@dd-octo-sts

dd-octo-sts Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Files inventory check summary

File checks results against ancestor 776e98d3:

Results for datadog-agent_7.82.0~devel.git.247.b11b36c.pipeline.120240942-1_amd64.deb:

No change detected

@dd-octo-sts

dd-octo-sts Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 776e98d
📊 Static Quality Gates Dashboard
🔗 SQG Job

Successful checks

Info

Quality gate Change Size (prev → curr → max)
agent_deb_amd64 +4.0 KiB (0.00% increase, -0.04% of buffer) 747.917 → 747.920 → 758.200
agent_rpm_amd64 +4.0 KiB (0.00% increase, -0.04% of buffer) 747.900 → 747.904 → 758.170
agent_rpm_arm64 +4.0 KiB (0.00% increase, -0.06% of buffer) 723.523 → 723.527 → 729.660
agent_suse_amd64 +4.0 KiB (0.00% increase, -0.04% of buffer) 747.900 → 747.904 → 758.170
agent_suse_arm64 +4.0 KiB (0.00% increase, -0.06% of buffer) 723.523 → 723.527 → 729.660
docker_agent_amd64 +4.0 KiB (0.00% increase, -0.06% of buffer) 807.616 → 807.620 → 813.790
docker_agent_arm64 +4.0 KiB (0.00% increase, -0.06% of buffer) 808.134 → 808.137 → 815.030
docker_agent_jmx_amd64 +4.0 KiB (0.00% increase, -0.06% of buffer) 998.513 → 998.517 → 1004.550
docker_agent_jmx_arm64 +4.0 KiB (0.00% increase, -0.06% of buffer) 987.683 → 987.687 → 994.710
23 successful checks with minimal change (< 2 KiB)
Quality gate Current Size
agent_deb_amd64_fips 703.861 MiB
agent_heroku_amd64 308.587 MiB
agent_rpm_amd64_fips 703.845 MiB
agent_rpm_arm64_fips 683.115 MiB
agent_suse_amd64_fips 703.845 MiB
agent_suse_arm64_fips 683.115 MiB
docker_cluster_agent_amd64 208.044 MiB
docker_cluster_agent_arm64 221.251 MiB
docker_cws_instrumentation_amd64 7.447 MiB
docker_cws_instrumentation_arm64 6.877 MiB
docker_dogstatsd_amd64 39.008 MiB
docker_dogstatsd_arm64 37.117 MiB
docker_host_profiler_amd64 304.990 MiB
docker_host_profiler_arm64 316.090 MiB
dogstatsd_deb_amd64 29.747 MiB
dogstatsd_deb_arm64 27.798 MiB
dogstatsd_rpm_amd64 29.747 MiB
dogstatsd_suse_amd64 29.747 MiB
iot_agent_deb_amd64 45.675 MiB
iot_agent_deb_arm64 42.390 MiB
iot_agent_deb_armhf 43.175 MiB
iot_agent_rpm_amd64 45.676 MiB
iot_agent_suse_amd64 45.675 MiB

@cit-pr-commenter-54b7da

cit-pr-commenter-54b7da Bot commented Jun 19, 2026

Copy link
Copy Markdown

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: b59cecba-a840-40e3-8fd9-6314d2eea340

Baseline: 10e6a7e
Comparison: b7b0df5
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_logs % cpu utilization +1.07 [-0.01, +2.14] 1 Logs bounds checks dashboard
quality_gate_security_mean_fs_load memory utilization +0.23 [+0.19, +0.27] 1 Logs bounds checks dashboard
quality_gate_security_idle memory utilization +0.13 [+0.06, +0.20] 1 Logs bounds checks dashboard
quality_gate_idle_all_features memory utilization -0.43 [-0.47, -0.39] 1 Logs bounds checks dashboard
quality_gate_security_no_fs_load memory utilization -0.45 [-0.55, -0.35] 1 Logs bounds checks dashboard
quality_gate_idle memory utilization -0.52 [-0.58, -0.47] 1 Logs bounds checks dashboard
quality_gate_metrics_logs memory utilization -0.96 [-1.21, -0.72] 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 146.14MiB ≤ 154MiB bounds checks dashboard
quality_gate_idle total_bytes_received 10/10 575.40KiB ≤ 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 483.85MiB ≤ 495MiB bounds checks dashboard
quality_gate_idle_all_features total_bytes_received 10/10 0.89MiB ≤ 1.25MiB bounds checks dashboard
quality_gate_logs intake_connections 10/10 4 ≤ 6 bounds checks dashboard
quality_gate_logs memory_usage 10/10 180.54MiB ≤ 195MiB bounds checks dashboard
quality_gate_logs missed_bytes 10/10 0B = 0B bounds checks dashboard
quality_gate_logs total_bytes_received 10/10 263.83MiB ≤ 292MiB bounds checks dashboard
quality_gate_metrics_logs cpu_usage 10/10 323.07 ≤ 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 393.15MiB ≤ 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.86GiB ≤ 1.04GiB bounds checks dashboard
quality_gate_security_idle cpu_usage 10/10 28.40 ≤ 40 bounds checks dashboard
quality_gate_security_idle memory_usage 10/10 299.84MiB ≤ 330MiB bounds checks dashboard
quality_gate_security_mean_fs_load cpu_usage 10/10 67.97 ≤ 70 bounds checks dashboard
quality_gate_security_mean_fs_load memory_usage 10/10 275.58MiB ≤ 320MiB bounds checks dashboard
quality_gate_security_no_fs_load cpu_usage 10/10 21.52 ≤ 40 bounds checks dashboard
quality_gate_security_no_fs_load memory_usage 10/10 284.42MiB ≤ 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:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. 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.

  3. 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_idle_all_features comparison 10 Oom killed Debug Dashboard
quality_gate_metrics_logs comparison 10 Oom killed Debug Dashboard
quality_gate_security_no_fs_load baseline 10 Oom killed Debug Dashboard

CI Pass/Fail Decision

Passed. All Quality Gates passed.

  • quality_gate_logs, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check missed_bytes: 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 missed_bytes: 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 total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check cpu_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_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_security_mean_fs_load, bounds check memory_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_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 total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.

julesmcrt and others added 2 commits June 19, 2026 16:42
rshell v0.0.21 adds the builtins/truncate package; regenerate the
third-party license file so lint_licenses passes.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
The E2E remediation test targeted /host/var/log, which is a read-only host
mount inside the PAR container, so the file-target redirection failed and the
action published a failure rather than a result — the success poll then timed
out.

Point both write tests at /tmp (the container's own writable filesystem) so
remediation mode genuinely writes the file (exit 0) while read-only mode still
rejects the redirection at parse time. Only the execution mode differs between
the two tests now.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
@julesmcrt
julesmcrt marked this pull request as ready for review June 22, 2026 14:12
@julesmcrt
julesmcrt requested review from a team as code owners June 22, 2026 14:12
@julesmcrt
julesmcrt requested review from ross-m-young and removed request for a team June 22, 2026 14:12

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c49a10346e

ℹ️ 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".

Comment thread pkg/privateactionrunner/bundles/remoteaction/rshell/entrypoint.go
@dd-octo-sts dd-octo-sts Bot added the internal Identify a non-fork PR label Jun 22, 2026
@github-actions github-actions Bot added the medium review PR review might take time label Jun 22, 2026
@julesmcrt julesmcrt added the qa/done QA done before merge and regressions are covered by tests label Jun 22, 2026
@gh-worker-dd-mergequeue-cf854d
gh-worker-dd-mergequeue-cf854d Bot merged commit b7b0df5 into main Jun 22, 2026
270 of 281 checks passed
@gh-worker-dd-mergequeue-cf854d
gh-worker-dd-mergequeue-cf854d Bot deleted the jules.macret/rshell-remediation-action branch June 22, 2026 18:12
@github-actions github-actions Bot added this to the 7.82.0 milestone Jun 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Identify a non-fork PR medium review PR review might take time qa/done QA done before merge and regressions are covered by tests team/action-platform

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants