chore: Doc update for em default value and warning if dpf is not used.#3656
Open
abvarshney-nv wants to merge 1 commit into
Open
chore: Doc update for em default value and warning if dpf is not used.#3656abvarshney-nv wants to merge 1 commit into
abvarshney-nv wants to merge 1 commit into
Conversation
Contributor
Summary by CodeRabbit
WalkthroughThe NICo DPF manual now presents its expectations as separate bullets and documents ChangesNICo DPF documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
🔍 Container Scan SummaryNo Grype artifacts were found to aggregate. |
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3656.docs.buildwithfern.com/infra-controller |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 `@docs/manuals/dpf.md`:
- Around line 34-38: Update the second note in the DPF documentation to scope
the “default provisioning strategy” claim to configurations where [dpf].enabled
is true, while preserving the existing warning behavior for hosts not using DPF.
🪄 Autofix (Beta)
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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 8cadccd9-60e3-4d6d-9c33-2c1af99fe9fc
📒 Files selected for processing (1)
docs/manuals/dpf.md
Comment on lines
+34
to
+38
| > **Note**: | ||
| > | ||
| > 1. NICo expects DPF to be installed and configured on the same Kubernetes cluster where NICo (the controller) runs. | ||
| > 2. DPF is the default provisioning strategy. If any host is not using it, a warning will be displayed. | ||
| > |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Scope the default claim to [dpf].enabled.
When the site-level DPF gate is off, this reads as if DPF is always the default provisioning strategy. Qualify it so the default only applies when [dpf].enabled = true.
Suggested wording
- 2. DPF is the default provisioning strategy. If any host is not using it, a warning will be displayed.
+ 2. When `[dpf].enabled = true`, DPF is the default per-host provisioning strategy. A warning is displayed for hosts that are not configured to use DPF.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| > **Note**: | |
| > | |
| > 1. NICo expects DPF to be installed and configured on the same Kubernetes cluster where NICo (the controller) runs. | |
| > 2. DPF is the default provisioning strategy. If any host is not using it, a warning will be displayed. | |
| > | |
| > **Note**: | |
| > | |
| > 1. NICo expects DPF to be installed and configured on the same Kubernetes cluster where NICo (the controller) runs. | |
| > 2. When `[dpf].enabled = true`, DPF is the default per-host provisioning strategy. A warning is displayed for hosts that are not configured to use DPF. | |
| > |
🤖 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 `@docs/manuals/dpf.md` around lines 34 - 38, Update the second note in the DPF
documentation to scope the “default provisioning strategy” claim to
configurations where [dpf].enabled is true, while preserving the existing
warning behavior for hosts not using DPF.
polarweasel
requested changes
Jul 17, 2026
polarweasel
left a comment
polarweasel
left a comment
Contributor
There was a problem hiding this comment.
Just a couple little changes to your couple little changes :)
Comment on lines
+34
to
+38
| > **Note**: | ||
| > | ||
| > 1. NICo expects DPF to be installed and configured on the same Kubernetes cluster where NICo (the controller) runs. | ||
| > 2. DPF is the default provisioning strategy. If any host is not using it, a warning will be displayed. | ||
| > |
Contributor
There was a problem hiding this comment.
Let's use Fern's component here. Check the Coderabbit commentary too, in case it's relevant...
Suggested change
| > **Note**: | |
| > | |
| > 1. NICo expects DPF to be installed and configured on the same Kubernetes cluster where NICo (the controller) runs. | |
| > 2. DPF is the default provisioning strategy. If any host is not using it, a warning will be displayed. | |
| > | |
| <Note title="Notes"> | |
| 1. NICo expects DPF to be installed and configured on the same Kubernetes cluster where NICo (the controller) runs. | |
| 2. DPF is the default provisioning strategy. If any host is not using it, a warning will be displayed. | |
| </Note> | |
Comment on lines
743
to
+746
| > **Important**: this is **not a merge**. Any expected-machine row that is | ||
| > not present in the file is **deleted**. Each entry is then re-created via | ||
| > the same path as `add`, so any entry whose `dpf_enabled` is omitted is | ||
| > re-inserted with `dpf_enabled = false`. | ||
| > re-inserted with `dpf_enabled = true`. |
Contributor
There was a problem hiding this comment.
I have no doubt there are more of these, but gotta start somewhere :)
Suggested change
| > **Important**: this is **not a merge**. Any expected-machine row that is | |
| > not present in the file is **deleted**. Each entry is then re-created via | |
| > the same path as `add`, so any entry whose `dpf_enabled` is omitted is | |
| > re-inserted with `dpf_enabled = false`. | |
| > re-inserted with `dpf_enabled = true`. | |
| <Warning> | |
| This is not a merge. Any expected-machine row that is not present in the file is **deleted**. Each entry is then re-created using the same path as `add`, so any entry whose `dpf_enabled` is omitted is re-inserted with `def_enabled = true`. | |
| </Warning> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Doc change for the commits:
Related issues
Type of Change
Breaking Changes
Testing
Additional Notes