docs: add microservice classification#5899
Merged
rene merged 1 commit intolf-edge:masterfrom May 6, 2026
Merged
Conversation
96612aa to
4182a52
Compare
e858b00 to
3cf8b68
Compare
Add MICROSERVICE-CLASSIFICATION.md documenting the distinction between device management and workload management microservices in EVE. Device management microservices (nim, zedagent, client, baseosmgr, downloader, verifier, volumemgr, nodeagent, tpmmgr, logmanager/ loguploader) must remain operational for the device to stay remotely manageable. A bug here may prevent the controller from reaching the device, requiring physical intervention to recover. downloader, verifier, and volumemgr are dual-use, serving both EVE-OS update content and application content. Workload management microservices (domainmgr, zedrouter, zedmanager, diag, hypervisors, container runtime) handle running applications on the device. Their failure is remotely recoverable. diag is observability-only and not in the controller communication path. The document explains the implications of this split for testing priority, code review rigor, and the EVE A/B partition scheme. Update CODE-COVERAGE.md to note that device management coverage gaps carry higher operational risk and should be prioritized over equal-sized workload management gaps. Update README.md to reference the new document from the EVE Internals section. Signed-off-by: eriknordmark <erik@zededa.com> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
3cf8b68 to
d1d2b6d
Compare
rene
approved these changes
May 6, 2026
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
Add
docs/MICROSERVICE-CLASSIFICATION.mddocumenting the distinction betweendevice management and workload management microservices in EVE.
Also updates
docs/CODE-COVERAGE.mdto note that device management coveragegaps carry higher operational risk and should be prioritized over equal-sized
workload management gaps, and updates
docs/README.mdto reference the newdocument from the EVE Internals section.
How to test and validate this PR
Documentation-only change. Verify that:
MICROSERVICE-CLASSIFICATION.mdtoCODE-COVERAGE.mdandEVE-K.mdresolve correctly.
respective service documentation.
Changelog notes
None.
PR Backports
Checklist