Skip to content

docs: mark KVBM as deprecated where the notice is missing - #16465

Open
fjvbn2003 wants to merge 1 commit into
ai-dynamo:mainfrom
fjvbn2003:docs-kvbm-deprecated
Open

docs: mark KVBM as deprecated where the notice is missing#16465
fjvbn2003 wants to merge 1 commit into
ai-dynamo:mainfrom
fjvbn2003:docs-kvbm-deprecated

Conversation

@fjvbn2003

@fjvbn2003 fjvbn2003 commented Oct 14, 2026 •
edited
Loading

Copy link
Copy Markdown

Overview:

Summary

KVBM is deprecated in v1.5.0 with removal targeted for v1.7.0 (the Deprecations ledger, updated in #15975). Several entry points still present KVBM without any notice, so a reader who lands on them has no way to know it is going away. This PR adds the notice where it is missing and fixes two stale references. Documentation only.

Details:

  • README.md
    • Feature table (KVBM row) and Core Capabilities table: mark KVBM as deprecated and link to the ledger.
    • The [kvbm] reference link pointed to docs/components/kvbm/README.md, which no longer exists. Point it at lib/bindings/kvbm/README.md.
  • lib/bindings/kvbm/README.md: add a warning at the top with the deprecation and migration text from the ledger.
  • docs/fern/pages/reference/components/kvbm-configuration.mdx: add a <Warning> at the top with the same text and a relative link to deprecations.mdx#v150.
  • docs/fern/.../router/offloading-support-matrix.md: the "See Also" entry described the vLLM KV Cache Offloading page as a catalog of "native, KVBM, LMCache, FlexKV", but that page lists LMCache and FlexKV only. Native offloading has its own page, linked one line above. Update the description to match.

The notice text follows the wording of the v1.5.0 entry in deprecations.mdx.

Where should the reviewer start?

lib/bindings/kvbm/README.md and kvbm-configuration.mdx for the notice wording. Please check whether you want KVBM to stay in the README Core Capabilities table at all until v1.7.0; this PR only annotates it. #14012 also edits kvbm-configuration.mdx (it drops the object-storage tier); the two changes touch different lines, and I will rebase whichever lands second.

Out of scope, noticed while editing: README.zh-CN.md also mentions KVBM, and the other unused reference links at the bottom of README.md ([disagg], [kv-routing], [migration], [lora]) point to files that no longer exist. Happy to handle these in a follow-up.

Validation

  • Checked that the relative link ../general/releases/deprecations.mdx#v150 resolves to an existing file and that the v150 anchor exists in it.
  • Checked that https://docs.nvidia.com/dynamo/reference/releases/deprecations returns 200 and contains the KVBM entry.
  • Checked that lib/bindings/kvbm/README.md exists for the new [kvbm] reference target.
  • I did not run fern check or fern docs broken-links locally.

This change was drafted with AI assistance and reviewed by me.

Related Issues

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Marked KVBM as deprecated in v1.5.0, with removal targeted for v1.7.0.
    • Added guidance to use native engine KV offloading for host and disk tiering, and clarified that KV Cache Runner is a separate early-stage project for cross-node sharing.
    • Updated the vLLM KV Cache Offloading catalog’s related resources to list LMCache and FlexKV.
    • Clarified that the KVBM wheel and launch and deployment examples remain available in v1.5.0.

@fjvbn2003
fjvbn2003 requested review from a team as code owners October 14, 2026 23:15
@copy-pr-bot

copy-pr-bot Bot commented Oct 14, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@fjvbn2003
fjvbn2003 temporarily deployed to external_collaborator October 14, 2026 23:16 — with GitHub Actions Inactive
@fjvbn2003
fjvbn2003 temporarily deployed to external_collaborator October 14, 2026 23:16 — with GitHub Actions Inactive
@github-actions

github-actions Bot commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

👋 Hi fjvbn2003! Thank you for contributing to ai-dynamo/dynamo.

Just a reminder: The NVIDIA Test Github Validation CI runs an essential subset of the testing framework to quickly catch errors.Your PR reviewers may elect to test the changes comprehensively before approving your changes.

🚀

@github-actions github-actions Bot added docs external-contribution Pull request is from an external contributor documentation Improvements or additions to documentation labels Oct 14, 2026
@coderabbitai

coderabbitai Bot commented Oct 14, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: ai-dynamo/dynamo/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: a6f437b1-90b8-4734-b973-c3d8d31b7434
📥 Commits

Reviewing files that changed from the base of the PR and between 6dd643d and 052a907.

📒 Files selected for processing: 4
  • README.md
  • docs/fern/pages/developer-guide/knowledge-base/modular-components/router/offloading-support-matrix.md
  • docs/fern/pages/reference/components/kvbm-configuration.mdx
  • lib/bindings/kvbm/README.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

Walkthrough

The documentation now identifies KVBM as deprecated in v1.5.0, with removal targeted for v1.7.0. It directs host and disk tiering users to native engine KV offloading and distinguishes KV Cache Runner as a separate project.

Changes

KVBM deprecation

Layer / File(s) Summary
Deprecation guidance and references
docs/fern/pages/reference/components/kvbm-configuration.mdx, lib/bindings/kvbm/README.md, README.md, docs/fern/pages/developer-guide/knowledge-base/modular-components/router/offloading-support-matrix.md		 The KVBM documentation states the deprecation and targeted removal versions, describes replacement options, and notes that the wheel and launch and deploy examples ship unchanged for v1.5.0. The top-level README updates its KVBM links and description. The offloading catalog now lists LMCache and FlexKV.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Merge Risk: ⚪ Minimal · up to 052a9

The updated documentation identifies KVBM’s deprecation and migration guidance, and its checked links and catalog description are consistent. No actionable merge-blocking risk remains.

Pre-merge checks: Passed 5
Check name Status Explanation
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Title check Passed The title clearly and concisely describes the main documentation change: marking KVBM as deprecated where notices are missing.
Description check Passed The description follows the required template, explains the changes and reviewer focus, includes validation details, and references related issues. It is complete and directly relevant.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (4 skipped: 4 unsupported.)

✨ Finishing Touches: 💡 1
🛠️ Fix failing CI checks: 💡
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@fjvbn2003 fjvbn2003 mentioned this pull request Oct 16, 2026
Open
@fjvbn2003

fjvbn2003 commented Oct 30, 2026

Copy link
Copy Markdown
Author

Hi, friendly follow-up: this docs-only PR has been waiting for about two weeks and has not had CI started yet. When a maintainer has a moment, could you please take a look at the current head (052a907) and comment /ok to test 052a9079db2cd43ab317a3bded44cfb4281b75d7 if it looks fine? Thank you!

@fjvbn2003
docs: mark KVBM as deprecated where the notice is missing
306b7f8 
KVBM was deprecated in v1.5.0 with removal targeted for v1.7.0, but the
root README, the kvbm bindings README and the KVBM configuration
reference still present it without a notice.

- README: flag KVBM as deprecated in the feature table and the core
  capabilities table, linking to the Deprecations ledger, and point the
  unused [kvbm] reference link at lib/bindings/kvbm/README.md instead
  of the removed docs/components/kvbm/README.md.
- lib/bindings/kvbm/README.md and kvbm-configuration.mdx: add the
  deprecation notice and migration guidance from the ledger.
- offloading-support-matrix.md: the vLLM KV Cache Offloading catalog
  lists LMCache and FlexKV only, so drop "native, KVBM" from its
  description.

Signed-off-by: YoungjuKim <[email protected]>
@fjvbn2003
fjvbn2003 force-pushed the docs-kvbm-deprecated branch from 052a907 to 306b7f8 Compare November 12, 2026 16:50
@fjvbn2003
fjvbn2003 temporarily deployed to external_collaborator November 12, 2026 16:50 — with GitHub Actions Inactive

This branch was previously deployed

1 inactive deployment
external_collaborator — 306b7f83 Deployed Nov 12, 2026 by fjvbn2003 via ok-to-test #50536
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

docs documentation Improvements or additions to documentation external-contribution Pull request is from an external contributor size/S

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[CONTRIBUTION]: docs: mark KVBM as deprecated where the notice is missing

1 participant

@fjvbn2003