You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 44448cd
Browse filesBrowse the repository at this point in the historyBrowse files
docs: list v1 changes since v0.1.0-rc9 and correct stale example claims (#14413)
The release notes now list every user-visible change on `v1` since the
`v0.1.0-rc9` tag, including the breaking ones, and four example pages
drop claims that later changes made false.
## Problem
`docs/about/release-notes.md` listed three breaking changes and none of
the features, fixes, and onboarding changes that reached `v1` after
`v0.1.0-rc9`; it didn't name the configuration shapes the parser now
rejects or the intent record version `v0.1.0-rc9` writes.
Some example claims went stale:
- `examples/spark/README.md` said the pinned OpenShell has the Podman
TLS initialization blocker, NVIDIA/OpenShell#3427; its fix merged before
OpenShell 0.1.0, and `v1` pins 0.1.7.
- `examples/station/README.md` and `examples/gtc-dc/README.md` required
exactly one visible GPU on the host; since #13929,
`container.gpuDevices` lets a service on a host with more GPUs request
one.
- `examples/hcl/travel-team` said Fabric's Deep Agents adapter can't
turn reasoning off, NVIDIA/NeMo-Fabric#433; NVIDIA/NeMo-Fabric#439 fixed
that, and the pinned catalog's Deep Agents `reasoning_effort` accepts
`none`.
- The travel team cited #13313 for the booking key its service doesn't
receive, but #13313 closed when `openshell_api` landed.
## Change
- `docs/about/release-notes.md` gains "Changes Since v0.1.0-rc9",
grouped by area, from the commits in `v0.1.0-rc9..origin/v1`; where a
later commit changed an earlier one, the entry describes the current
code, and changes added and removed after the tag aren't listed:
- Agents and interfaces: #14037, #14038, #14269, #13981, #14024, #14186,
#14052, #14385, #13971, #13858, #13947, #14039, #14042, #14044, #14343.
- Inference: #13929, #14391, #14396, #14398, #14400, #13963, #13912,
#13964, #14388, #14390, #14397.
- Gateways and Kubernetes: #13909, #13970, #13922 (an existing
namespace, refused at plan by #13756, is now bound; cluster-wide reads
dropped), #14014, #14169, #13921.
- Plan, apply, and diagnostics: #14224, #13756, #14141, #14133, #14135,
#13775, #13744, #13701.
- Onboarding: #13693, #13695, #13741, #13757, #13851, #13978, #14228,
#14233, #14334, #14336.
- Examples and builds: #14166, #14184, #14188, #14191, #14192, #14200,
#13889, #14267, #14312, #14315, #14355, b30e9b4, #13781, #13813,
#14246, and the pins in `versions.json` and `image/fabric/Dockerfile`.
- Its breaking changes since the tag:
- the intent record moving from 15, which `v0.1.0-rc9` writes, through
16 (#14266), 17 (#14343), 18 (#13929), 19 (#14391) and 20 (#14394);
- name-keyed `sandboxes` and `inferenceProviders` (#13703, #13705);
- a recipe `compatibility.gpu` outside every hardware profile (#13912);
- model tuning the adapter doesn't accept (#14111), and Hermes's
`max_tokens` losing its default (#14296);
- `skills.paths` resolution (#14296);
- endpoint and `networkCIDR` validation (#13847, #14081);
- the HCL `gateway_values` attribute (#14014), and Kubernetes ownership
receipts from before #13922 and #14014.
The two earlier items stay, under their own heading.
- `examples/spark/README.md` replaces the closed OpenShell#3427 blocker
with the Podman and remote-model limits in `docs/resources/limits.md`.
- `examples/station/README.md` and `examples/gtc-dc/README.md` require
one GPU visible in the model container, and point to
`container.gpuDevices` for a host with more.
- `examples/hcl/travel-team/README.md` and `WALKTHROUGH.md` drop the
NeMo-Fabric#433 limitation, and the travel team's booking-key statements
link #14417 instead of #13313.
Not listed, because both changes landed after the tag: Deep Agents Code
(#14043, #14250), `compatibility.gpuCount` (#14391, #14394), and the
"Creating infrastructure state" progress step (#14169, #14248).
Checked and left unchanged: the root `README.md`,
`crates/nemoclaw-onboarding/README.md`,
`crates/nemoclaw-cli/assets/README.md`, `internal-docs/README.md`, the
other example READMEs, and every example YAML header comment. The GPU
autoscaling README and `load.sh` read the JSON fields `OperationResult`
serializes, and NVIDIA/OpenShell#4287 is fixed only after the pinned
0.1.7. The two pre-tag release-note items still match the schema and
SDK. `docs/README.md` is left to #14412, which retires the stale field
reference snapshot it describes.
Not verified: whether Hermes sends the booking key's placeholder to MCP
servers; #14417 tracks the live check.
## Beyond CI
Each relative link and anchor in the changed files resolves to an
existing file and heading.
Copy file name to clipboardExpand all lines: docs/about/release-notes.md
+100-2Lines changed: 100 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,111 @@ The workspace package version alone does not establish that a release has been p
12
12
The development branch provides desired-state YAML, a Rust SDK, the `onboard`/`plan`/`apply`/`export`/`destroy` CLI, and a bundled OpenTofu provider.
13
13
Refer to [the overview](overview.md) for implemented boundaries and [the CLI reference](../references/cli.md) for commands.
14
14
15
+
### Changes Since v0.1.0-rc9
16
+
17
+
These changes reached `v1` after the `v0.1.0-rc9` tag; [breaking changes](#breaking-changes-and-migration) are listed separately.
18
+
19
+
Agents and interfaces:
20
+
21
+
-`harness.settings.interfaces` turns on OpenClaw's dashboard and Hermes's API server and dashboard; plan checks each against the image's adapter, and apply prints how to reach it, including OpenClaw's terminal UI command.
22
+
See [agent interfaces](../agents-inference/interfaces.md#reach-an-agent-interface).
23
+
- A sandbox's `serviceExposures` publishes one of its ports at a URL the gateway serves; apply prints each URL and returns it as `serviceUrls` in JSON.
24
+
See [service exposure](../agents-inference/interfaces.md#expose-a-service-through-the-gateway).
25
+
- Plan and apply list each agent's runtime ID and `fabric-agent-ctl invoke` command under **Agents**, and as `agents` in JSON results.
26
+
See [invoking an agent](../agents-inference/interfaces.md#invoke-an-agent).
27
+
- OpenClaw and Hermes keep their native state in `/sandbox/artifacts/.fabric/state/<adapter id>/<agent name>`, which every runtime of the agent uses, so their interface tokens moved there.
28
+
See [agent files](../build-deploy/state.md#agent-files).
29
+
- The Hermes image includes the API server, dashboard, and browser chat dependencies, and the Switchyard Relay plugin.
30
+
- Apply restarts an agent runtime that stopped in an unchanged sandbox.
31
+
- OpenClaw's startup has one 60-second deadline, instead of 30 seconds for each step.
32
+
- A failed agent start reports Fabric's cause.
33
+
- OpenClaw stops where the sandbox denies process-group signals.
34
+
- An explicit sandbox policy accepts `network_middlewares`.
35
+
See [network middleware](../security/sandbox-network.md#attach-network-middleware).
36
+
37
+
Inference and models:
38
+
39
+
-`container.gpuDevices` selects the GPU for a Docker-managed vLLM or Ollama service, by UUID or index; it takes one entry.
40
+
See [container limits](../agents-inference/inference.md#set-container-limits-and-update-policy).
41
+
-`serving.tensorParallelSize` and `serving.pipelineParallelSize` set vLLM's parallel layout; see [the parallel layout](../agents-inference/models.md#set-the-parallel-layout).
42
+
Until `container.gpuDevices` takes more than one GPU, vLLM refuses a layout larger than one GPU; see [current limits](../resources/limits.md#platforms-models-and-placement).
43
+
- A service's GPU memory budget applies to each GPU it uses, and capacity errors name the GPU.
44
+
- On dedicated-memory GPUs, `memory.hostReserveGiB` can be as low as 6 GiB, and a vLLM recipe's GPU budget is checked against the GPU's memory.
45
+
See [hardware profiles](../agents-inference/models.md#choose-a-hardware-profile).
46
+
- In hand-written HCL, the vLLM and Ollama capacity data sources take `gpu_devices`, and `vllm_runtime` and `ollama_runtime` take `gpu_count`, which must be 1 for now, and report it in `requirements`.
47
+
See [service capacity](../references/provider.md#service-capacity).
48
+
- When vLLM exits during startup, the apply error includes the last 4 KiB of its output, with the service key redacted; an Ollama runtime's stop detail, such as a memory protection stop, also appears in its apply error.
49
+
50
+
Gateways and Kubernetes:
51
+
52
+
- An external gateway's `gateway.tls` can name a CA alone; a client certificate and key must appear together.
53
+
-`gateway.kubernetes.kubeconfig` and `context` can be omitted together; without them, NemoClaw uses the service account of the pod it runs in.
54
+
See [running NemoClaw in a pod](../build-deploy/kubernetes.md#run-nemoclaw-in-a-pod).
55
+
-`gateway.kubernetes.namespace` can name an existing namespace: NemoClaw binds it by UID and never labels, changes, or deletes it, and refuses a namespace that another deployment created or that is being deleted.
56
+
- NemoClaw no longer reads cluster-wide objects: it doesn't check for a default StorageClass, the Agent Sandbox CRD, or `kube-system`.
57
+
Without a default StorageClass, the gateway install times out in Helm's wait.
58
+
- A managed OpenShift gateway lets OpenShift assign its UID and `fsGroup`.
59
+
- A managed Kubernetes or OpenShift gateway's Helm install is atomic; a release left by an unfinished install fails apply with the `helm uninstall` command to run.
60
+
See [recovering an unfinished Helm install](../build-deploy/usage.md#recover-from-an-unfinished-helm-install).
61
+
- Plan fails when a managed Docker or Podman gateway's subnet or port is already in use.
62
+
63
+
Plan, apply, and diagnostics:
64
+
65
+
- The first interrupt lets the resource operations in progress finish; a second stops at once.
66
+
See [recovering an interrupted operation](../build-deploy/usage.md#recover-an-interrupted-operation).
67
+
- Refusals name the object or setting: an ownership conflict, retained gateway storage from another state directory, a missing kubeconfig context, an image metadata bundle for another digest, and gateway TLS failures.
68
+
- The sandbox deletion warning ends with "except on mounted volumes".
69
+
- Adding a sandbox whose name sorts first leaves the other sandboxes unchanged.
-`nemoclaw onboard` offers OpenClaw and Hermes, saves only the values you chose, and leaves the rest for plan to fill.
75
+
- It doesn't ask for settings it can decide, such as a named vendor's API, the only engine that answered, or the network tier; the review shows why a value can't be saved and whether each credential is set.
76
+
- Saving prints the `nemoclaw plan` and `nemoclaw apply` commands with the saved path.
77
+
- The review explains how to set an unset credential and, for a hosted provider, names the page that issues its key.
78
+
- The Nous Research preset names `NOUS_API_KEY`.
79
+
80
+
Examples and builds:
81
+
82
+
- New examples: [an application container beside an agent](../../examples/application-container.yaml) and [GPU autoscaling on Kubernetes](../../examples/kubernetes/gpu-autoscaling/README.md).
83
+
- The [GTC DC](../../examples/gtc-dc/README.md) Kubernetes profile runs one OpenClaw and one Hermes agent on a managed gateway, in YAML or HCL, and keeps their files on PVCs; the local templates allow 8,192 output tokens.
84
+
- Linux bundles are built on Ubuntu 22.04 and need glibc 2.35 or newer; Ubuntu 22.04 is the oldest supported Linux.
85
+
See [prerequisites](../get-started/prerequisites.md).
86
+
- Run `cargo images fetch` before a direct `docker buildx bake` build of an agent or Ollama image.
87
+
See [building images](../build-deploy/build.md).
88
+
- Dependency pins take security fixes, including rustls, webpki, tokio, and zip.
Earlier CLI commands, schemas, and state formats have no compatibility guarantees.
18
94
See [migration](../get-started/migration.md) for where each earlier task lives now, and [state](../build-deploy/state.md) for data preservation.
19
-
Recent development changes that affect existing deployments:
95
+
Changes since the `v0.1.0-rc9` tag that affect existing deployments or documents:
96
+
97
+
- The intent record is now version 20.
98
+
`v0.1.0-rc9` wrote version 15, and the record moved to 16, 17, 18, 19, and 20 as later changes altered it.
99
+
This release refuses any deployment whose intent record is an earlier version, including every one that `v0.1.0-rc9` created, without changing its state.
100
+
Destroy each one with the bundle that created it, then create it again with this release; see [compatibility](../references/compatibility.md#deployment-state).
101
+
-`spec.sandboxes`, `spec.inferenceProviders`, and a sandbox's `inferenceProviders` are maps keyed by name; the parser rejects the earlier lists.
102
+
A provider declared inline on a route still takes `name`.
103
+
In the Rust SDK, these fields are `BTreeMap`s, and `InferenceProvider` has no `name`.
104
+
- A vLLM recipe whose `compatibility.gpu` belongs to no hardware profile's GPU family no longer parses.
105
+
- Plan rejects `maxTokens`, `temperature`, and `topP` when the image's adapter doesn't accept them; see [OpenClaw route tuning](../agents-inference/inference.md#tune-openclaws-primary-route).
106
+
- Hermes's `max_tokens` setting no longer defaults to 512, so Hermes uses its own response-token limit.
107
+
- In `skills.paths` for OpenClaw and Hermes, a folder with a `SKILL.md` is one skill, and otherwise each direct subfolder with one is a skill.
108
+
A folder without skills adds none, and a missing path or a duplicate skill name fails the agent's start.
109
+
Hermes no longer loads skills more than one folder deep, and no longer skips a missing path.
110
+
See [skills on a mounted volume](../agents-inference/agents.md#skills-on-a-mounted-volume).
111
+
- An endpoint must begin with its scheme and `://`.
112
+
Endpoints and service addresses can't name a cloud metadata host, such as `metadata` or `fd00:ec2::254`, or an IPv6 address that embeds an IPv4 address.
113
+
A `networkCIDR` must be in canonical form, without leading zeros.
114
+
- In hand-written HCL, `openshell_kubernetes_auth` has no `gateway_values` attribute.
115
+
- In hand-written HCL on Kubernetes or OpenShift, the gateway ownership receipts that `v0.1.0-rc9` wrote no longer load, and the intent record refusal above doesn't cover them.
116
+
Destroy such a deployment with the bundle that created it, then create it again with this release.
117
+
118
+
Earlier changes that affect existing deployments:
20
119
21
-
- The intent record is now version 20, so this release refuses every deployment that an earlier build created, without changing its state. Destroy each one with the bundle that created it, then create it again with this release; see [compatibility](../references/compatibility.md#deployment-state).
22
120
- Docker-managed vLLM and Ollama services default to [`updatePolicy: Preserve`](../agents-inference/inference.md#set-container-limits-and-update-policy), which refuses an image, model, serving, or container-limit change that would replace a running container; set `spec.services.<name>.updatePolicy: Recreate` to permit the replacement and its downtime.
23
121
-`spec.gateway.image` is removed: the SDK pins the managed gateway image, and defaulted and exported documents no longer name it.
24
122
- Remove the field from documents; the parser rejects it as an unknown field.
Copy file name to clipboardExpand all lines: examples/gtc-dc/README.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,8 @@ KV and SSM cache dtypes use runtime defaults; model output accuracy and tool cal
36
36
37
37
Ubuntu 24.04 is the assumed Linux environment, including the WSL2 distribution.
38
38
Use [the build prerequisites](../../docs/build-deploy/build.md), Docker with NVIDIA GPU access and the containerd image store, and driver major 580 or newer.
39
-
Each target requires exactly one visible NVIDIA GPU; these configurations provide neither CPU offloading nor multi-GPU serving.
39
+
Each model container must see exactly one NVIDIA GPU; on a host with more, set the service's [`container.gpuDevices`](../../docs/agents-inference/inference.md#set-container-limits-and-update-policy) to the target GPU.
40
+
These configurations provide neither CPU offloading nor multi-GPU serving.
Copy file name to clipboardExpand all lines: examples/hcl/travel-team/README.md
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,7 @@ The researchers use a fast local model, and the scheduler and buyer use a hosted
39
39
2. Set the variables in `terraform.tfvars`: at least `docker_host`, `gateway_endpoint`, `images`, `image_engine`, `ollama_image`, and `local_model`.
40
40
3. Export the keys the registrations name, which OpenShell reads during apply: by default `NVIDIA_API_KEY` for the hosted model, `BRAVE_API_KEY` for web search, and `BOOKINGS_API_KEY` for the booking service.
41
41
Sandboxes see a placeholder in place of each key, and OpenShell puts the key into requests that carry the placeholder, so agents never see the keys.
42
-
Hermes doesn't send the booking key's placeholder to MCP servers yet, so the booking service receives no key ([#13313](https://github.com/NVIDIA/NemoClaw/issues/13313)).
42
+
Hermes doesn't send the booking key's placeholder to MCP servers yet, so the booking service receives no key ([#14417](https://github.com/NVIDIA/NemoClaw/issues/14417)).
43
43
4. Run `tofu init` and `tofu apply`.
44
44
45
45
Hosted providers retire model names over time. If the scheduler or buyer fails with HTTP 404 or 410 from the hosted model, list the models your endpoint and key can use (`GET /v1/models`, then try one) and set `frontier.model`.
@@ -84,8 +84,7 @@ The team needs a few things NemoClaw and its components don't provide yet:
84
84
85
85
- Agents don't call one another directly: a person or script passes results between them ([#13311](https://github.com/NVIDIA/NemoClaw/issues/13311), [#13312](https://github.com/NVIDIA/NemoClaw/issues/13312)).
86
86
- The approval step happens outside the agents ([#13314](https://github.com/NVIDIA/NemoClaw/issues/13314)).
87
-
- The booking service receives no key yet ([#13313](https://github.com/NVIDIA/NemoClaw/issues/13313)).
88
-
- The scheduler runs Hermes rather than Deep Agents, whose adapter can't turn a model's reasoning off ([NVIDIA/NeMo-Fabric#433](https://github.com/NVIDIA/NeMo-Fabric/issues/433)).
87
+
- The booking service receives no key yet ([#14417](https://github.com/NVIDIA/NemoClaw/issues/14417)).
89
88
- Each invocation must finish within `fabric-agent-ctl`'s 320-second deadline, which bounds how much one agent can do per call.
This registers the booking service's key for the buyer's executables only.
147
147
OpenShell puts the key into a request in place of its placeholder, so the agent never sees the key itself.
148
-
Hermes doesn't send that placeholder to MCP servers yet, so for now the service receives no key; [#13313](https://github.com/NVIDIA/NemoClaw/issues/13313) tracks it.
148
+
Hermes doesn't send that placeholder to MCP servers yet, so for now the service receives no key; [#14417](https://github.com/NVIDIA/NemoClaw/issues/14417) tracks it.
149
149
150
150
## `policies.tf`: Network Grants
151
151
@@ -196,7 +196,7 @@ roles = merge(
196
196
197
197
This table describes the team.
198
198
Grants, registrations, sandboxes, and agents are all derived from it, so adding a researcher means adding one entry to `local.researchers`.
199
-
Every role runs Hermes; Fabric's Deep Agents adapter can't turn a model's reasoning off yet ([NVIDIA/NeMo-Fabric#433](https://github.com/NVIDIA/NeMo-Fabric/issues/433)), and a reasoning model there can't finish within Fabric's 320-second invocation deadline.
199
+
Every role runs Hermes.
200
200
201
201
```hcl
202
202
binaries = { for role, harness in data.fabric_harness.agent : role => jsondecode(harness.launch_json).binaries }
Copy file name to clipboardExpand all lines: examples/spark/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ The new scenarios use managed Docker gateways and authenticated vLLM services.
17
17
|[two-models.yaml](two-models.yaml)| Pi with Qwen3-4B and Qwen3.6-27B NVFP4 | Fast/smart route selection with two independently managed services |
18
18
|[local-and-hosted.yaml](local-and-hosted.yaml)| OpenClaw with local Qwen3.8-27B NVFP4 and an operator-selected hosted model | Managed local inference plus a hosted model; the local route is the default |
19
19
|[vllm.yaml](vllm.yaml)| OpenClaw with Qwen3-4B | The original ordinary-vLLM example |
20
-
|[remote-vllm.yaml](remote-vllm.yaml)| OpenClaw with SSH-managed Qwen3-4B and an external Podman gateway | Separate sandbox and model engines; the current OpenShell Podman pin has the [TLS initialization blocker](https://github.com/NVIDIA/OpenShell/issues/3427)|
20
+
|[remote-vllm.yaml](remote-vllm.yaml)| OpenClaw with SSH-managed Qwen3-4B and an external Podman gateway | Separate sandbox and model engines; Podman with a remote model service is [untested](../../docs/resources/limits.md#platforms-models-and-placement)|
21
21
22
22
The Deep Agents researcher has `tools.allow: [read]`; the writer retains the harness's default tools.
23
23
Each agent receives its own sandbox, workspace, and artifact directory.
Copy file name to clipboardExpand all lines: examples/station/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ These examples cover their exact combinations and do not qualify other DGX Stati
15
15
## Check the Host
16
16
17
17
The host must provide Ubuntu 24.04, ARM64, one NVIDIA GB300 with compute capability 10.3, driver major 580 or newer, and Docker with the containerd image store enabled.
18
-
The `dgx-station` profile requires observable dedicated GPU-memory counters and rejects additional visible GPUs.
18
+
The `dgx-station` profile requires observable dedicated GPU-memory counters and exactly one GPU visible in the model container; on a Station with another GPU, set the service's [`container.gpuDevices`](../../docs/agents-inference/inference.md#set-container-limits-and-update-policy) to the GB300.
19
19
Confirm that the selected example's gateway and inference ports are unused and that its gateway CIDR does not overlap a host route or Docker network.
20
20
Stop or resize only workloads you own before reserving GPU capacity.
0 commit comments