docs(config): list all six load_balancing values, mark UDP LB as shipped#1277
Merged
Conversation
Three stale spots contradicted the code: - doc/configure.md described the cluster load-balancing key as `load_balancing_policy` with values "roundrobin"/"random". The key is `load_balancing` (SCREAMING_SNAKE_CASE) and six algorithms exist: ROUND_ROBIN, RANDOM, LEAST_LOADED, POWER_OF_TWO, HRW, MAGLEV (lib/src/load_balancing.rs, command.proto LoadBalancingAlgorithms). - bin/config.toml listed only four values, omitting HRW/MAGLEV. - doc/upgrade/1.x-to-2.0.md still listed UDP load balancing (#654) as "future"; it landed via #1274. Doc/comment-only change, no behavior impact. Signed-off-by: Florentin Dubois <florentin.dubois@clever.cloud>
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
1 participant
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.
What
Doc/comment-only fixes for three spots that contradicted the code, found while triaging open issues:
doc/configure.md— the[clusters]block described the load-balancing key asload_balancing_policywith values"roundrobin"/"random". The actual key isload_balancing(SCREAMING_SNAKE_CASE) and six algorithms exist:ROUND_ROBIN,RANDOM,LEAST_LOADED,POWER_OF_TWO,HRW,MAGLEV(lib/src/load_balancing.rs,LoadBalancingAlgorithmsincommand.proto). The comment now also points at the#### UDP clusterssection for the flow-affine pair.bin/config.toml— the sample config comment listed four values, omittingHRW/MAGLEV.doc/upgrade/1.x-to-2.0.md— the "not in 2.0.0" table still listed UDP load balancing (UDP load balancing #654) as future; it landed via feat(udp): first-class UDP load balancing (#1273) #1274.Why
These lines are the evidence base for closing #409, #654 and #1273 — the docs argued against the closure.
Validation
cargo test -p sozu-command-lib --locked config— 34 passed (sample config still parses).