Skip to content

chore: Doc update for em default value and warning if dpf is not used. #3656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abvarshney-nv merged 2 commits into from
Jul 21, 2026
Merged

chore: Doc update for em default value and warning if dpf is not used. #3656

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d01a471
chore: Doc update for em default value and warning if dpf is not used.
abvarshney-nv Jul 17, 2026
8c3c90e
review comments fixes
abvarshney-nv Jul 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/manuals/dpf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ The guide is organized into the following sections:
3. **Post-Installation Configuration** — the cluster state and NICo configuration that must be in place after DPF is installed and before NICo starts.
4. **Restart carbide-api** — what NICo creates on startup, and why a restart is required to apply DPF config changes.

> **Note**: NICo expects DPF to be installed and configured on the same
> Kubernetes cluster where NICo (the controller) runs.

<Note title="Notes">
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.
</Note>
---

## 1. Prerequisites
Expand Down Expand Up @@ -663,7 +664,7 @@ below in the order an operator typically uses them.
#### 3.6.a. `nico-admin-cli expected-machine add` — create a new entry

Adds a new expected-machine row. `--dpf-enabled` is optional; **omitting it
stores `false`**.
stores `true`**.

```bash
nico-admin-cli expected-machine add \
Expand Down Expand Up @@ -738,10 +739,9 @@ same per-entry shape as `update`:
nico-admin-cli expected-machine replace-all --filename em-all.json
```

> **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`.
<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 `dpf_enabled = true`.
</Warning>

#### 3.6.e. Quick reference

Expand Down
Loading