docs(nodeagent): add architecture document#5913
Open
eriknordmark wants to merge 1 commit into
Open
Conversation
6 tasks
a02f536 to
463045b
Compare
Adds pkg/pillar/docs/nodeagent.md describing the responsibilities, pubsub inputs and outputs, internal logical components, control flow through the four main paths (boot/onboarding, periodic timer tick, controller-driven device operation, baseos upgrade) and a debugging section. Structured to mirror the existing nim.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>
463045b to
79dfb33
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
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/nodeagent.md— a new architecture documentdescribing the
nodeagentmicroservice. The document mirrors thestructure of the existing
pkg/pillar/docs/nim.md:reboot/shutdown/poweroff, health-timer-driven reset, reboot-reason
reconstruction, maintenance-mode aggregation).
publishes/consumes plus the on-disk state under
/persist/,/run/global/, etc.nodeagent.go,handletimers.go,handlebaseos.go/handlezboot.go,handlenodedrain.go, plus the maintenance-mode helpers), sinceunlike NIM the agent is not split across packages.
the periodic timer tick, controller-driven device operations and
the full baseos upgrade lifecycle.
useful log greps, and how to force each transition during dev.
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/nodeagent/and therelated types (
types.NodeAgentStatus,types.ZbootConfig,types.ZbootStatus,kubeapi.NodeDrainStatus).No automated test is required.
Changelog notes
No user-facing changes.
PR Backports
Checklist