docs(mimo): add Scheduler public documentation#4738
Open
cloudygreybeard wants to merge 2 commits intomasterfrom
Open
docs(mimo): add Scheduler public documentation#4738cloudygreybeard wants to merge 2 commits intomasterfrom
cloudygreybeard wants to merge 2 commits intomasterfrom
Conversation
cloudygreybeard
requested review from
alcasim,
bennerv,
cadenmarchese,
hawkowl,
hlipsig,
jharrington22,
kevinobriendotca,
kimorris27,
mociarain,
mrWinston,
rogbas,
sankur-codes,
tiguelu,
tsatam,
tuxerrante,
ventifus,
wanghaoran1988 and
yjst2012
as code owners
Add comprehensive documentation for the MIMO Scheduler, which autonomously creates MaintenanceManifests based on configured MaintenanceSchedules. New documents: - docs/mimo/scheduler.md: Architecture, key concepts, data flow - docs/mimo/scheduler-calendar-and-selectors.md: Calendar expression format and selector syntax reference Updated documents: - docs/mimo/README.md: Replace stub text with links to Scheduler docs - docs/mimo/admin-api.md: Add PUT schedule semantics, curl examples, GET selectors endpoint, const.go cross-references Tracked-by: ARO-25790
cloudygreybeard
force-pushed
the
phijones/ARO-25790/mimo-scheduler-public-docs
branch
from
a9be5f6 to
e78fdcd
Compare
tuxerrante
reviewed
Apr 3, 2026
tuxerrante
reviewed
Apr 3, 2026
rajdeepc2792
reviewed
Apr 3, 2026
rajdeepc2792
reviewed
Apr 3, 2026
rajdeepc2792
reviewed
Apr 3, 2026
- Remove incorrect year max 2100 claim (no upper bound in code) - Narrow healthz wording to readiness only (no liveness check) - Clarify that schedule id is distinct from maintenanceTaskID
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
3 participants
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.
Summary
docs/mimo/scheduler.md: architecture (bucket partitioning, shared database, cluster cache), key concepts (MaintenanceSchedule, calendar format, selectors, scheduleAcross, lookForwardCount), data flow (Mermaid diagram), and schedule statesdocs/mimo/scheduler-calendar-and-selectors.md: full reference for systemd-style calendar expressions (wildcards, comma-separated lists, minute restrictions) and selector syntax (9 supported keys, operators, examples)docs/mimo/admin-api.md: expanded PUT schedule semantics (201/200 status codes, ID handling), added curl examples with sanitised placeholders, added GET selectors endpoint, and cross-references topkg/mimo/const.gofor task IDsdocs/mimo/README.md: replaced stub text about future Scheduler implementation with links to the new documentationTest plan
Tracked-by: ARO-25790