Skip to content

docs: add microservice classification#5899

Merged
rene merged 1 commit intolf-edge:masterfrom
eriknordmark:eriknordmark/remove-executor-command
May 6, 2026
Merged

docs: add microservice classification#5899
rene merged 1 commit intolf-edge:masterfrom
eriknordmark:eriknordmark/remove-executor-command

Conversation

@eriknordmark
Copy link
Copy Markdown
Contributor

@eriknordmark eriknordmark commented May 5, 2026

Description

Add docs/MICROSERVICE-CLASSIFICATION.md documenting the distinction between
device management and workload management microservices in EVE.

Also updates docs/CODE-COVERAGE.md to note that device management coverage
gaps carry higher operational risk and should be prioritized over equal-sized
workload management gaps, and updates docs/README.md to reference the new
document from the EVE Internals section.

How to test and validate this PR

Documentation-only change. Verify that:

  • Links in MICROSERVICE-CLASSIFICATION.md to CODE-COVERAGE.md and EVE-K.md
    resolve correctly.
  • The microservice classification is consistent with the roles described in the
    respective service documentation.

Changelog notes

None.

PR Backports

  • 16.0-stable: No, documentation only.
  • 14.5-stable: No, documentation only.
  • 13.4-stable: No, documentation only.

Checklist

  • I've provided a proper description
  • I've added the proper documentation
  • I've tested my PR on amd64 device
  • I've tested my PR on arm64 device
  • I've written the test verification instructions
  • I've set the proper labels to this PR
  • I've checked the boxes above, or I've provided a good reason why I didn't check them.

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>
@eriknordmark eriknordmark force-pushed the eriknordmark/remove-executor-command branch from 3cf8b68 to d1d2b6d Compare May 5, 2026 14:19
Copy link
Copy Markdown
Contributor

@andrewd-zededa andrewd-zededa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rene rene merged commit a912237 into lf-edge:master May 6, 2026
9 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants