Skip to content

docs: add multi-host quick start, system setup, and Dynamo pages - #97

Merged
seohui-XCENA merged 4 commits into
xcena-dev:mainfrom
seohui-XCENA:docs/multi-node-dynamo-bios
Oct 7, 2026
Merged

seohui-XCENA merged 4 commits into
xcena-dev:mainfrom
seohui-XCENA:docs/multi-node-dynamo-bios

Conversation

@seohui-XCENA

Copy link
Copy Markdown
Collaborator

Summary

Rewrites the quick start so one Python producer/consumer pair runs on either a single host or two hosts sharing CXL memory, and adds System Setup and Dynamo pages. The consistency doc now states the cross-host visibility requirements behind the quick start's explicit cache flushes.

Key Changes

  • Quick Start: single-host and multi-host service setup, then a shared producer/consumer that flushes CPU writes before store() and invalidates before reading. Replaces the multi-node "coming soon" note in Installation.
  • System Setup (new): GNR Allocating Write Flows setting, InfiniteMemory BIOS guide link, and DEV_DAX verification.
  • Consistency and Safety: data visibility reworded for non-coherent multi-host CXL; new Cross-Host Visibility subsection covering the flush_range writer/reader pattern and what Non-Allocating does and does not cover.
  • Installation: check for the optional cache-flush extension; systemd override for running the Resource Manager on a network address.
  • Dynamo (new): integration page and an example page for examples/dynamo/single_node/. Marked single-host; a multi-host example will follow.
  • Navigation: System Setup and Examples under Getting Started; Dynamo under Integrations.

Test Plan

  • sphinx-build -b html docs/ docs/_build/html: no new warnings from the changed pages; new {ref} labels resolve
  • External links resolve (Dynamo vLLM guide, InfiniteMemory BIOS anchor, example README)
  • Commands, flags, and defaults checked against maru-server, maru-resource-manager, install.sh, and the Dynamo example scripts
  • Quick start run end-to-end on single-host and multi-host hardware

Rewrite the quick start around one producer/consumer pair that runs on
either a single host or two hosts sharing CXL memory, with explicit
flush_range calls for cross-host CPU visibility. Add a System Setup page
for DEV_DAX verification and the GNR BIOS setting, Dynamo integration and
example pages, and qualify the data-visibility section of the consistency
doc for non-coherent multi-host platforms.
- System Setup: install the cxl package; Ubuntu 24.04 has no cxl-cli.
- Consistency: put write-then-register ahead of the caveats, describe
  every store as a caller write followed by store(), and add a
  Cross-Host Visibility section with the flush_range writer/reader
  pattern and what Allocating Write Flows does on Intel GNR.
- Installation: check the optional cache-flush extension, and show a
  systemd override for running the Resource Manager on a network address.
- Quick start: wait for the Resource Manager's ready log line, and stop
  the systemd service before starting a second Resource Manager on a
  different address for multi-host.
- Dynamo: mark the example as single-host with a multi-host example to
  follow, note that it starts its own MaruServer, and check worker
  registration before running the query.

@jooho-XCENA jooho-XCENA left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@seohui-XCENA
seohui-XCENA force-pushed the docs/multi-node-dynamo-bios branch from 6d4bd80 to 6c0ef87 Compare October 7, 2026 02:43
@seohui-XCENA
seohui-XCENA merged commit e84ea9c into xcena-dev:main Oct 7, 2026
7 checks passed
@seohui-XCENA
seohui-XCENA deleted the docs/multi-node-dynamo-bios branch October 7, 2026 06:35
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