docs(baseosmgr): add architecture document#5921
Open
eriknordmark wants to merge 1 commit into
Open
Conversation
This was referenced May 8, 2026
eriknordmark
requested review from
andrewd-zededa,
christoph-zededa,
europaul and
zedi-pramodh
Adds pkg/pillar/docs/baseosmgr.md describing the responsibilities, pubsub inputs and outputs, internal logical components, control flow through the five main paths (boot, BaseOsConfig install, content-tree progress, test-complete commit, reboot-after-failed-update) plus the force-fallback and retry-update side channels, and a debugging section. Structured to mirror the existing nim.md and nodeagent.md so the pillar docs remain consistent across microservices. Signed-off-by: eriknordmark <erik@zededa.com> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
eriknordmark
force-pushed
the
baseosmgr-architecture-doc
branch
from
e0d1938 to
e5b260d
Compare
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.
Description
Adds
pkg/pillar/docs/baseosmgr.md— a new architecture documentdescribing the
baseosmgrmicroservice. Mirrors the structure of theexisting
pkg/pillar/docs/nim.mdandpkg/pillar/docs/nodeagent.md:machine, the install worker that does the dd, mirroring grubenv into
the published
ZbootStatus, surfacing the previous boot'sRebootReasononto a failedBaseOsStatus, the kubevirt drain gate,the force-fallback knob, and the retry-update counter).
or consumes (
BaseOsConfig,BaseOsStatus,ZbootConfig/ZbootStatus,BaseOSMgrStatus,NodeAgentStatus,ZedAgentStatus,ContentTreeStatus,NodeDrainStatus/NodeDrainRequest,ConfigItemValueMap), theon-disk state under
/persist/status/and/persist/checkpoint/,and the GRUB-env writes via
pkg/pillar/zboot.baseosmgr.go,handlebaseos.go,forcefallback.go,handledownload.go,handlevolumemgr.go,worker.go,handlenodedrain.go).controller-driven new BaseOsConfig, content-tree progress, the
test-complete commit, and the reboot-after-failed-update path,
plus the two side channels (force-fallback, retry-update).
log greps, and how to force each transition during dev (including
the existing eden tests).
No production code changes; documentation only.
PR dependencies
None.
How to test and validate this PR
This is a documentation-only change. Validation is by review of the
content against the source under
pkg/pillar/cmd/baseosmgr/and therelated types (
types.BaseOsConfig,types.BaseOsStatus,types.ZbootConfig,types.ZbootStatus,types.BaseOSMgrStatus,kubeapi.NodeDrainStatus).No automated test is required.
Changelog notes
No user-facing changes.
PR Backports
Checklist