Skip to content

docs: add Trident Architecture content with mermaid diagrams#678

Open
bfjelds wants to merge 5 commits into
mainfrom
user/bfjelds/docs-trident-architecture
Open

docs: add Trident Architecture content with mermaid diagrams#678
bfjelds wants to merge 5 commits into
mainfrom
user/bfjelds/docs-trident-architecture

Conversation

@bfjelds

@bfjelds bfjelds commented Jun 8, 2026

Copy link
Copy Markdown
Member

Summary

Replaces the empty Explanation/Trident-Architecture.md placeholder (which only contained an internal ADO work item link in an HTML comment) with comprehensive architecture documentation.

Incorporates and expands on content from the earlier #264 attempt.

Content

  • Overview — High-level left-to-right flow diagram from user inputs through engine to target OS
  • Execution Modes — CLI, daemon (gRPC server), and gRPC client with full architecture diagram showing engine internals and subsystem fan-out
  • Engine — Servicing type selection (clean install / A/B update / runtime update) with decision flow diagram
  • Subsystem Lifecycle — The prepare → provision → configure trait model with phase diagram
  • Subsystems — Table of all subsystems with cross-links to related explanation and how-to docs
  • Storage Pipeline — Partitioning → RAID → encryption → image → filesystem → swap → verity with flow diagram
  • Boot Subsystem — GRUB2, systemd-boot, UEFI variables, ESP management
  • Commands — Step-by-step flows for install, update, offline-initialize, commit, rebuild-raid, validate, and get
  • A/B Update Mechanism — Stage → finalize → reboot → commit/rollback with sequence diagram showing the happy path and automatic rollback
  • COSI Image Format — File structure and key properties (streaming, integrity, compression)
  • gRPC Server — Socket, services, concurrency control, systemd integration with architecture diagram
  • Datastore — SQLite storage, persistent vs temporary modes
  • Data Flow — End-to-end sequence diagram showing prepare/provision/configure phases
  • Host Configuration — YAML structure overview with link to samples
  • Design Principles — Declarative configuration, separation of concerns, safety/reliability, platform agnostic
  • External Tool Integration — Table of wrapped Linux utilities

Includes 8 mermaid diagrams throughout the document.

Replace empty placeholder (internal ADO work item link only) with
comprehensive architecture documentation covering execution modes,
engine design, subsystem lifecycle (prepare/provision/configure),
storage pipeline, A/B update mechanism, gRPC server, datastore,
COSI image format, commands reference, and design principles.

Includes 8 mermaid diagrams: overview flow, execution modes,
servicing type selection, subsystem lifecycle, storage pipeline,
A/B update sequence, gRPC server, and end-to-end data flow.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
bfjelds added a commit that referenced this pull request Jun 8, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bfjelds bfjelds changed the title docs: add Trident Architecture content docs: add Trident Architecture content with mermaid diagrams Jun 8, 2026
bfjelds and others added 3 commits June 8, 2026 11:23
…nd get kinds

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Went from 11 tools to full inventory grouped by category:
Storage & Partitioning, Encryption & Integrity, Boot,
System & Device Management, and OS Configuration.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bfjelds bfjelds marked this pull request as ready for review June 8, 2026 18:32
@bfjelds bfjelds requested a review from a team as a code owner June 8, 2026 18:32
Copilot AI review requested due to automatic review settings June 8, 2026 18:32

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR replaces the placeholder Trident-Architecture.md with comprehensive Trident architecture documentation, covering execution modes, engine lifecycle, subsystem responsibilities, and key servicing workflows, with multiple Mermaid diagrams to illustrate system flow and update behavior.

Changes:

  • Adds an end-to-end architectural overview (engine, datastore, subsystems) with Mermaid flow/sequence diagrams.
  • Documents core servicing workflows (install/update/commit/rollback/diagnose/stream-disk) and the A/B update mechanism.
  • Adds reference-oriented sections on COSI, gRPC server behavior, datastore usage, and Host Configuration structure.

Comment thread docs/Explanation/Trident-Architecture.md Outdated
Comment thread docs/Explanation/Trident-Architecture.md Outdated
- Fix broken anchor #ab-updates -> #ab-update to match Glossary heading
- Fix management_os -> managementOs to match JSON schema (camelCase)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

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.

2 participants