Skip to content

docs(kv-cache): state that a ledger-less pool needs an explicit multiTenancy false - #696

Merged
thxCode merged 1 commit into
mainfrom
docs/pool-multitenancy-default
Sep 28, 2026
Merged

thxCode merged 1 commit into
mainfrom
docs/pool-multitenancy-default

Conversation

@thxCode

@thxCode thxCode commented Sep 28, 2026

Copy link
Copy Markdown
Collaborator

What type of PR is this?

/kind documentation
/area worker

What this PR does / why we need it:

#695 made KVCacheBackend's leader.multiTenancy default to true. docs/kv-cache/pool.md still described the ledger-less master as the plain case. This says where one now comes from:

It also updates the omitted domain.name bullet: on a multi-tenant master, default is the tenant the engines are handed, so each domain should be named once a second Binding shares the master. The kubectl get kvcpb example is now read from a managed backend's default rather than from an opt-in.

Which issue(s) this PR links to:

Relates #695

Special notes for your reviewer:

Docs only. make lint docs passes.

Does this PR introduce a user-facing change?

NONE

…Tenancy false

#695 made leader.multiTenancy default to true, but the pool page still
described the ledger-less master as the plain case. Say where a
ledger-less master now comes from: a managed backend that declares
leader.multiTenancy: false, which a store image older than Mooncake
0.3.12 has to, or an external master started without multi-tenancy.
The omitted domain name is now the tenant the engines are handed on a
multi-tenant master, so name each domain once a second Binding shares
it. The kubectl example reads from a managed backend's default.

Signed-off-by: thxCode <thxcode0824@gmail.com>
@gpustack-code-review

gpustack-code-review Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

🔍 OpenCodeReview found 2 issue(s) in this PR.

  • ✅ Successfully posted inline: 0 comment(s)
  • 📋 Routed to summary by policy: 2 comment(s)

documentation · low

📄 docs/kv-cache/pool.md (L114-L115)

⚠️ GitHub could not post this as an inline comment: Routed to summary (severity low · category documentation)

The sentence "so name each domain once a second Binding shares the master" is ambiguous: "once" here means "when/if", but it can also read as "name each domain one time", which contradicts the following sentence saying a domain name is claimed per master and a second naming is rejected. Consider rephrasing, e.g. "so name each domain as soon as a second Binding shares the master" or "so give each domain its own name when a second Binding shares the master".


style · low

📄 docs/kv-cache/pool.md (L116-L117)

⚠️ GitHub could not post this as an inline comment: Routed to summary (severity low · category style)

This edited line grew to ~105 characters while the surrounding bullets wrap near 90; rewrap for consistency (e.g. break after "registration").

💡 Suggested Change

Before:

  so the name only records the registration. It is claimed like any other name, so two Bindings that both leave it out collide on a
  shared master.

After:

  so the name only records the registration. It is claimed like any other name, so two Bindings
  that both leave it out collide on a shared master.

@thxCode
thxCode merged commit 70cb168 into main Sep 28, 2026
2 checks passed
@thxCode
thxCode deleted the docs/pool-multitenancy-default branch September 28, 2026 15:25
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.

1 participant