Skip to content

docs: Sync Fern docs for recent changes #3306

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

Open
kfelternv wants to merge 2 commits into
base: main
Choose a base branch
from
+10 −7
Open

docs: Sync Fern docs for recent changes #3306

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a26f7d1
docs: reflect nico-admin-cli network-segment create subcommand
kfelternv Jul 9, 2026
cdd338a
docs: Clarify network segment creation guidance
kfelternv Jul 9, 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
17 changes: 10 additions & 7 deletions docs/manuals/vpc/flat_vpcs_zero_dpu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ abbreviated as `…/nico/...` thereafter.
|---|---|---|
| Put hosts in NIC / no-DPU mode (site-wide `dpu_mode`, per-host `ExpectedMachine.dpu_mode`) | Operator | **TOML** — Day 0 / rare; API restart |
| Declare `HostInband` underlay segments | Operator | **TOML** (`[networks.<name>]`, `type = "hostinband"`) — Day 0 |
| Create an additional `HostInband` segment after Day 0 | Operator | **TOML** (`[networks]`) + API restart, or **`nico-admin-cli`** (gRPC `CreateNetworkSegment`) — see [Configuring HostInband Segments](#2-configuring-hostinband-network-segments) |
| Create an additional `HostInband` segment after initial setup | Operator | **Restart-applied TOML** (`[networks]`), or runtime **`nico-admin-cli`** (`network-segment create`) — see [Configuring HostInband Segments](#2-configuring-hostinband-network-segments) |
| Inspect / delete a `HostInband` segment | Operator | **`nico-admin-cli`** (`network-segment show` / `delete`) |
| Create an instance type and associate zero-DPU machines | Operator | **REST** `…/nico/instance-type` · `nicocli` |
| Bind a `HostInband` segment to a Flat VPC | Tenant *(VPC owner)* | Set the VPC on the segment (see below) |
Expand Down Expand Up @@ -197,14 +197,17 @@ after Day 0 in either of two ways:

Note the current CLI surface for the runtime path:

- `nico-admin-cli --cloud-unsafe-op=<username> network-segment create` creates a
segment at runtime. The global `--cloud-unsafe-op` acknowledgment is required
and must not be used against a production site. For a `HostInband` segment,
pass `--segment-type host-inband` with `--name`, `--prefix`, and
`--subdomain-id`; add `--gateway` when the IPv4 prefix has a gateway. Run
`nico-admin-cli network-segment create --help` for the full flag set. The REST
API / `nicocli` do not expose operator network-segment management (the REST
`/subnet` endpoints are the tenant subnet surface, not operator `HostInband`
segments).
- `nico-admin-cli network-segment show` and `nico-admin-cli network-segment delete`
exist for inspecting and removing segments.
- There is **no `network-segment create` CLI subcommand**, and the REST API /
`nicocli` do not expose operator network-segment management (the REST
`/subnet` endpoints are the tenant subnet surface, not operator `HostInband`
segments). Runtime creation is therefore done by calling the
`CreateNetworkSegment` gRPC endpoint directly. If a wrapped create command is
needed operationally, file a bug.

Deleting a `HostInband` segment follows the standard segment lifecycle: the
segment is drained (it is not removed while any host interface or instance
Expand Down
Loading