Document the remote-jobs opt-in and MDM keys - #914
Conversation
Remote jobs are now an explicit opt-in on the peer (default off), enabled with --allow-remote-jobs or the allowRemoteJobs MDM policy, and a new debugBundleUploadURL MDM policy overrides the debug-bundle upload service. Document both MDM keys in the MDM integration reference, and note the opt-in requirement plus the new anonymization-level and upload-URL bundle parameters on the Remote Jobs page.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThe documentation adds MDM policies for remote-job opt-in and Debug Bundle upload URLs. It also documents peer opt-in requirements, anonymization settings, Dashboard availability, and related limitations. ChangesRemote Jobs Documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/pages/client/mdm-integration.mdx`:
- Around line 73-74: Update the policy-key count in the surrounding
documentation to match the table’s 20 rows, or remove the hard-coded count so it
cannot become stale. Keep the descriptions for allowRemoteJobs and
debugBundleUploadURL unchanged.
In `@src/pages/manage/peers/remote-jobs.mdx`:
- Around line 11-13: Update both opt-in descriptions in the Note to explicitly
state that the allowRemoteJobs MDM policy must be set to true, not merely
present, while preserving the existing --allow-remote-jobs option wording.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: eaea6acb-312c-4351-b095-1eca68ba0ce8
📒 Files selected for processing (2)
src/pages/client/mdm-integration.mdxsrc/pages/manage/peers/remote-jobs.mdx
| | `allowRemoteJobs` | boolean | Allow management-requested remote jobs (e.g. debug bundles) on this peer. Off by default; equivalent to `--allow-remote-jobs`. | | ||
| | `debugBundleUploadURL` | string | Override the upload service used for debug bundles produced by remote jobs, taking precedence over the value requested by Management. Must be an `https` URL with a host. | |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Update the policy count.
The preceding text at Line 63 says that the reference contains 16 keys, but the table now contains 20 rows, including these two new keys. Remove the hard-coded count or update it so administrators are not given incorrect documentation.
Proposed fix
-The same 16 keys apply on every platform.
+The same policy keys apply across platform payloads.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/pages/client/mdm-integration.mdx` around lines 73 - 74, Update the
policy-key count in the surrounding documentation to match the table’s 20 rows,
or remove the hard-coded count so it cannot become stale. Keep the descriptions
for allowRemoteJobs and debugBundleUploadURL unchanged.
| <Note> | ||
| Remote Jobs are **opt-in on the peer** and disabled by default. A peer accepts remote jobs only when started with `--allow-remote-jobs`, or when the `allowRemoteJobs` [MDM policy](/client/mdm-integration) is set. Enabling it is a privileged operation on the client (like enabling the embedded SSH server). Peers that have not opted in report this to Management, and the Dashboard disables the **Run Remote Job** button for them. | ||
| </Note> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
State that the MDM policy must be true.
allowRemoteJobs is a boolean policy. “The policy is set” can be read as “the key is present,” including allowRemoteJobs: false. State that the policy must be set to true in both opt-in descriptions.
Proposed fix
- ... when the `allowRemoteJobs` MDM policy is set.
+ ... when `allowRemoteJobs` is set to `true` in the MDM policy.
...
-- The target peer must have **opted into remote jobs** (`--allow-remote-jobs` or the `allowRemoteJobs` MDM policy)
+- The target peer must have **opted into remote jobs** (`--allow-remote-jobs` or `allowRemoteJobs: true` in the MDM policy)Also applies to: 146-146
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/pages/manage/peers/remote-jobs.mdx` around lines 11 - 13, Update both
opt-in descriptions in the Note to explicitly state that the allowRemoteJobs MDM
policy must be set to true, not merely present, while preserving the existing
--allow-remote-jobs option wording.
1 participant
Documents the remote-jobs client opt-in and the two new MDM policy keys introduced in netbirdio/netbird#7153, plus the new debug-bundle parameters from netbirdio/netbird#7147.
client/mdm-integration): addallowRemoteJobs(boolean) anddebugBundleUploadURL(string) to the managed-keys table.manage/peers/remote-jobs): note that remote jobs are opt-in on the peer (default off;--allow-remote-jobsor theallowRemoteJobsMDM policy), that peers which haven't opted in are surfaced to the Dashboard (Run Remote Job disabled), and add the new Anonymization Level and Upload URL bundle parameters.Tracked in NET-1489 (parent NET-1484). Pairs with netbirdio/netbird#7153 and #7147; merge alongside them.
Generated by Claude Code
Summary by CodeRabbit