Skip to content

docs: note that pools selected by ActorTemplate.worker_selector must share a CPU architecture - #3458

Merged
Zoe Zhao (zoez7) merged 1 commit into
agent-substrate:mainfrom
shrutiyam-glitch:fix-doc
Oct 30, 2026
Merged

Zoe Zhao (zoez7) merged 1 commit into
agent-substrate:mainfrom
shrutiyam-glitch:fix-doc

Conversation

@shrutiyam-glitch

@shrutiyam-glitch Shrutiya Mohan (shrutiyam-glitch) commented Oct 29, 2026 •

Copy link
Copy Markdown
Collaborator

Part of #3230

A SNAPSHOT_FIDELITY_ROOTFS restore reuses the container's rootfs upper layer, which can contain architecture-specific binaries written on the worker where the snapshot was captured. Until the scheduler filters by CPU architecture on fallback, every WorkerPool selected by an ActorTemplate must run on the same CPU architecture.

Previously, this requirement was only mentioned under Snapshot Storage Layout (sandboxRuntime) in docs/reference/api-guide.md. Surface it where operators and users configure pools and templates:

  • README.md: add Known limitations under Status and compatibility.
  • docs/reference/api-guide.md: note how to pin and label WorkerPools in mixed-architecture clusters under WorkerPoolPodTemplate, and note the single-architecture requirement on ActorTemplate.workerSelector.
  • api/ateapi/v1/ateapi.proto (ateapi.pb.go): document the requirement on ActorTemplate.worker_selector.

Used an AI assistant to draft the documentation wording and reviewed it locally.

  • Tests pass
  • Docs updated

@shrutiyam-glitch Shrutiya Mohan (shrutiyam-glitch) changed the title docs: note that pools selected by ActorTemplate.worker_selector must … docs: note that pools selected by ActorTemplate.worker_selector must share a CPU architecture Oct 29, 2026
@shrutiyam-glitch
Shrutiya Mohan (shrutiyam-glitch) marked this pull request as ready for review October 29, 2026 20:41
Comment thread docs/reference/api-guide.md Resolved
@zoez7
Zoe Zhao (zoez7) added this pull request to the merge queue Oct 30, 2026
Merged via the queue into agent-substrate:main with commit af42c9d Oct 30, 2026
7 checks passed
Dmitry Berkovich (dberkov) pushed a commit that referenced this pull request Nov 2, 2026
…share a CPU architecture (#3458)

Part of #3230

A `SNAPSHOT_FIDELITY_ROOTFS` restore reuses the container's rootfs upper
layer, which can contain architecture-specific binaries written on the
worker where the snapshot was captured. Until the scheduler filters by
CPU architecture on fallback, every `WorkerPool` selected by an
`ActorTemplate` must run on the same CPU architecture.

Previously, this requirement was only mentioned under `Snapshot Storage
Layout` (`sandboxRuntime`) in `docs/reference/api-guide.md`. Surface it
where operators and users configure pools and templates:

- `README.md`: add `Known limitations` under `Status and compatibility`.
- `docs/reference/api-guide.md`: note how to pin and label `WorkerPool`s
in mixed-architecture clusters under `WorkerPoolPodTemplate`, and note
the single-architecture requirement on `ActorTemplate.workerSelector`.
- `api/ateapi/v1/ateapi.proto` (`ateapi.pb.go`): document the
requirement on `ActorTemplate.worker_selector`.

Used an AI assistant to draft the documentation wording and reviewed it
locally.

- [x] Tests pass
- [x] Docs updated

Signed-off-by: Shrutiya <[email protected]>
(cherry picked from commit af42c9d)
Signed-off-by: Eitan Yarmush <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants