docs(client): add architecture document#5938
Open
eriknordmark wants to merge 1 commit into
Open
Conversation
eriknordmark
force-pushed
the
client-architecture-doc
branch
from
44f5eb0 to
6b211a3
Compare
Documents the zedclient onboarding microservice: responsibilities and its place in pillar (one-shot binary, distinct from the long-running zedbox group), the controller endpoints used (/certs, /register, /uuid) and the LED-state mapping per HTTP status, pubsub inputs (ConfigItemValueMap, DeviceNetworkStatus, CachedResolvedIPs, and the synchronous EvalStatus gate) and outputs (OnboardingStatus, MetricsMap), persistent artefacts under /persist/, the single retry-loop control flow including the SenderStatusCertMiss re-fetch trigger, a dedicated section on the 5-second already-onboarded fast path (pre-conditions, silent behaviour, and how to disable it), and a debugging section with the pubsub paths, log grep patterns, a connectivity smoke check, and how each control-flow branch is exercised in development. Structure mirrors nim.md, nodeagent.md, and baseosmgr.md so the pillar docs stay consistent across microservices. Signed-off-by: eriknordmark <erik@zededa.com> Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
eriknordmark
force-pushed
the
client-architecture-doc
branch
from
6b211a3 to
67232e4
Compare
eriknordmark
requested review from
andrewd-zededa,
christoph-zededa,
europaul,
rene and
zedi-pramodh
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
I've read this architecture document and asked claude to fix and add a few things. Ready for broader review and merge.
Adds
pkg/pillar/docs/client.mddescribing thezedclientonboardingmicroservice. The document covers:
zedclientdiffers from the rest of pillar(one-shot binary, not part of
zedboxlong-running group);/certs,/register,/uuid) and thedevice-side LED-state mapping per HTTP status code;
ConfigItemValueMap,DeviceNetworkStatus,CachedResolvedIPs, the synchronousEvalStatusgate) and outputs(
OnboardingStatus,MetricsMap);/persist/(status/uuid,status/hardwaremodel,checkpoint/controllercerts);already-onboarded fast path and the
SenderStatusCertMissre-fetchtrigger;
each path during development.
The document is structured to mirror the existing
nim.md,nodeagent.mdandbaseosmgr.mdso the pillar docs remain consistentacross microservices and can serve both as developer-onboarding
material and as a basis for functional test coverage.
Dependencies
The doc describes the post-refactor cmd/client; it should land after
the following PRs in this order:
How to test and validate this PR
Docs-only change. Read
pkg/pillar/docs/client.md; verify it matchesthe behaviour in
pkg/pillar/cmd/client/{client.go,parseuuid.go}andthe boot-time invocation in
pkg/pillar/scripts/device-steps.sh.Changelog notes
No user-facing changes.
PR Backports
Checklist