docs: replace invalid duration "1w" with "168h" in time-based-fairshare examples#1361
docs: replace invalid duration "1w" with "168h" in time-based-fairshare examples#1361JheSue wants to merge 2 commits intokai-scheduler:mainfrom
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
…irshare examples Go's time.ParseDuration does not support the 'w' (week) unit. Using 'windowSize: 1w' as shown in the documentation causes the kai-operator to crash-loop with: failed to list *v1.SchedulingShard: time: unknown unit "w" in duration "1w" Replace with the equivalent '168h' (7 * 24h) in all examples and tables. Signed-off-by: Homer <homer.su@fongcon.com.tw>
d3bf57a to
9a950d7
Compare
|
Thanks @JheSue ! 🙏 |
|
Hi, this is probably a bug in code, not docs: we were supposed to use prometheus' duration type which allows for I'll take a look when I have the time |
|
Hi, thanks for the pointer! I've investigated the issue and implemented a fix. |
Problem
The time-based-fairshare documentation uses
windowSize: 1was an example value.However, Go's
time.ParseDurationdoes not support thew(week) unit —only
ns,us,ms,s,m, andhare valid.When a user follows the documentation and sets
windowSize: 1win theirSchedulingShardCR, the kai-operator fails to listSchedulingShardresourcesand enters a crash loop:
Fix
Replace
1wwith the equivalent168h(7 × 24h) in all documentation examples.The semantic meaning is preserved — one week is still the default.
Changes
docs/time-based-fairshare/README.md— replacewindowSize: 1wwithwindowSize: 168hexamples/time-based-fairshare/README.md— update default value in parameter tableHow to reproduce
windowSize: 1was shown in the docs