docs: Snapshot alpha documentation (README + usage/reference/operations guides) - #132

Open

ozbarshalom wants to merge 72 commits into

mainfrom

Commits on Aug 20, 2026

docs: refresh README as alpha docs entry point
ozbarshalom
committed
f7d649d
docs: refine README and add usage guides, architecture, benchmarks, and build-from-source pages
ozbarshalom
committed
170e00b
docs: reorganize docs into reference/operations/development, add CLI, troubleshooting, and security pages
ozbarshalom
committed
af747f1
docs: tighten README opening — drop release-state framing, add a concise API-stability note
ozbarshalom
committed
4da96e1
docs: add operations/storage page (shared checkpoint PVC) and move privileged-agent detail to Security
ozbarshalom
committed
0a2a13c
docs: reword README limitations (single-GPU workloads; vGPU not supported)
ozbarshalom
committed
d8d9304

Commits on Aug 26, 2026

docs: refine README 'Who it's for' — two builder audiences (developers, MLOps/platform engineers)
ozbarshalom
committed
c8232c9
docs: trim README 'Who it's for' to the two audiences
ozbarshalom
committed
a1689b5
docs: use checkpoint/restore terminology in README (not capture)
ozbarshalom
committed
7d7605d
docs(vllm): complete snapshot-ready image guide
leeZardNav
committed
124ca40
docs(vllm): keep guide focused on Python API
leeZardNav
committed
4ec6015
docs(vllm): simplify image setup to one path
leeZardNav
committed
124ae3a
docs(vllm): preserve build guide heading
leeZardNav
committed
94a8e7e
docs(vllm): restore next steps section
leeZardNav
committed
6295d1d
docs(vllm): combine image build and set model
leeZardNav
committed
e670481
docs(vllm): set model in app and keep checkpoint generic
leeZardNav
committed
9d3ff28
docs(vllm): add downloadable build files
leeZardNav
committed
b82caff
docs(vllm): use vLLM 0.28 release
leeZardNav
committed
2c6c303
docs(vllm): remove unused placeholder setup
leeZardNav
committed
1aa29d2
docs: sync CLI and guides with main (snapshotctl --snapshot flags, SnapshotJob completion, Restored condition)
ozbarshalom
committed
80524f4
docs: use impersonal voice across README and docs; rework the checkpoint method table into a decision aid
ozbarshalom
committed
0f51ed9
docs(vllm): pass model at container startup
leeZardNav
committed
0ed2b64
fix(vllm): use checkpoint-compatible runtime
leeZardNav
committed
1042695
Merge origin/ozb/alpha-docs into vLLM guide branch
leeZardNav
committed
205d65d
fix(vllm): select model during image build
leeZardNav
committed
186537b
fix(vllm): wait in restore standby mode
leeZardNav
committed
3443b7d
fix(vllm): avoid reserved environment prefix
leeZardNav
committed
1e87a4b
fix(vllm): include snapshot control directory
leeZardNav
committed
12a12fa
fix(vllm): disable Xet for restorable downloads
leeZardNav
committed
7851aa1
fix(guides): keep restore placeholders inert
leeZardNav
committed
3429150

Commits on Aug 27, 2026

fix(guides): align vLLM with current snapshot lifecycle
leeZardNav
committed
f68ea88
fix(vllm): keep lifecycle update scoped
leeZardNav
committed
0fc19b9
fix(vllm): retain snapshot control path
leeZardNav
committed
b30a0fb
docs(vllm): clarify base image contents
leeZardNav
committed
692421b
docs(vllm): explain image registry handoff
leeZardNav
committed
a93a108
docs(vllm): pin verification platform
leeZardNav
committed
dcfbf05
feat(vllm): expose restored validation API
leeZardNav
committed
12f6b08
feat(vllm): add restored engine readiness probe
leeZardNav
committed
8c0ee4f
revert(vllm): remove readiness probe guidance
leeZardNav
committed
62acca2
docs(vllm): add source pod deployment step
leeZardNav
committed
20d8ec5
docs(vllm): link source pod manifest
leeZardNav
committed
663f184
refactor(vllm): configure model in source pod
leeZardNav
committed
d03a0bd
docs(vllm): clarify image verification output
leeZardNav
committed
6c9d294
feat(vllm): serve requests after restore
leeZardNav
committed
770cafd
Merge pull request #118 from ai-dynamo/lirane/RUN-41928-vllm-alpha-guide
ozbarshalom
authored
afc801b
docs(guides): restructure into build-and-deploy / checkpoint / restore
ozbarshalom
committed
8d1fff5
docs(guides): note vLLM example uses env vars, not vllm serve args
ozbarshalom
committed
ccde7dd
refactor(vllm): deploy source with Deployment
leeZardNav
committed
24f13a8
docs(vllm): limit Deployment follow-up scope
leeZardNav
committed
190d70f
docs(guides): add TensorRT-LLM and SGLang examples
leeZardNav
committed
2405466
chore(guides): remove generated Python bytecode
leeZardNav
committed
87292c5
docs(sglang): wait for the capture-ready pod
leeZardNav
committed
c612fb2
docs(sglang): restore Deployment rollout wait
leeZardNav
committed
6d114bd
docs(sglang): verify the selected namespace
leeZardNav
committed
8c3eb41
docs(vllm): verify the selected namespace
leeZardNav
committed
5b8a859
Merge vLLM guide namespace validation
leeZardNav
committed
c824f9e
docs(tensorrt-llm): verify the selected namespace
leeZardNav
committed
f1fd1d7
feat(guides): serve restored framework engines
leeZardNav
committed
c7b93c6
fix(tensorrt-llm): allow slow source initialization
leeZardNav
committed
7af24a6
Merge pull request #124 from ai-dynamo/lirane/RUN-41928-use-deployment-in-vllm-guide
ozbarshalom
authored
9cd0647
Merge pull request #125 from ai-dynamo/lirane/RUN-41931-trtllm-sglang-guides
ozbarshalom
authored
65def65
docs(guides): align restored-engine validation across frameworks
ozbarshalom
committed
9710a5f
docs(guides): note SGLang and TRT-LLM configure via engine API, not the server CLI
ozbarshalom
committed
d919b4c
docs(readme): frame integrator responsibility as orchestration, not failure handling
ozbarshalom
committed
28b9574
docs(readme): drop references to the not-yet-written quickstart
ozbarshalom
committed
04cbbda
docs: editorial pass for impersonal voice, consistent terms, and no broken links
ozbarshalom
committed
f093512
docs: remove the support matrix page
ozbarshalom
committed
10458f8
docs: remove TODO(eng) comments
ozbarshalom
committed
197fc57
docs: drop RBAC from the installation pointers
ozbarshalom
committed
060fa22
docs: drop runtime from the installation pointers
ozbarshalom
committed
43c1f61

Commits on Aug 28, 2026