docs: fix the router ConfigMap example key and nesting - #1621
Open
aeron-gh wants to merge 2 commits into
Open
Conversation
aeron-gh
force-pushed
the
docs/config-router-example-key
branch
from
August 14, 2026 15:52
60bf493 to
87de552
Compare
Signed-off-by: aeron-gh <agab0323@gmail.com>
Signed-off-by: aeron-gh <agab0323@gmail.com>
Contributor
Author
|
@acsoto @kube-gopher |
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: kube-gopher The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Contributor
Author
|
@LiZhenCheng9527 this one has lgtm and kube-gopher's approval, just needs a docs/OWNERS approve when you get a minute. thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
/kind documentation
What this PR does / why we need it:
The first ConfigMap example in the router configuration guide could not work as written. Three separate defects, all in the same block:
schedulerConfiguration, which no code path reads. The deployment subPath-mountsrouterConfigurationto the fixed path the router loads, so the example's config was never seen.RouterConfiguration, which expects them underscheduler:. They were dropped as unknown fields.namespace: default, while the chart creates the router's ConfigMap in the release namespace (documented install:kthena-system), so applying it produced an unrelated ConfigMap the router never mounts.Mechanism and file references in #1599.
Running the example through the router's own
ParseRouterConfigplusLoadSchedulerConfigshows what the first two cost:pluginConfigs=0 scoreWeights=map[] filters=[], an entirely empty scheduler configpluginConfigs=4 scoreWeights=map[kvcache-aware:1 least-latency:1 least-request:1 prefix-cache:1] filters=[least-request]The example now uses the
routerConfigurationkey with thescheduler:nesting, andnamespace: <namespace>, matching both the authentication example further down this page and the other router-ConfigMap examples in the repo (kvcache-aware.md,examples/redis/README.md).Scope: all five published doc versions carry this example (
versions.jsonlists v1.0.0 through v0.1.0), and every release tag from v0.1.0 to v1.0.0 subPath-mountsrouterConfigurationand loads/etc/config/routerConfiguration.yaml, so it was never correct for any of them. Each versioned copy is fixed in place, keeping its own plugin set and names (the v0.x copies keepkv-cache); only the data key, the nesting, and the namespace change. The four v0.x copies additionally had the ConfigMap header pasted twice inside the same snippet, which is removed. Each result was verified by parsing it back through the router's config loader.Which issue(s) this PR fixes:
Fixes #1599
Does this PR introduce a user-facing change?: