Skip to content

docs: add runtime architecture diagram to RHDH Local guide #254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Fortune-Ndlovu wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −0
Open

docs: add runtime architecture diagram to RHDH Local guide #254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/images/rhdh-local-runtime-architecture.png
View file
Open in desktop

@rm3l rm3l Jun 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for adding this! Having a diagram like this is valuable.
However, I can see that this is already outdated as it doesn't include the Lightspeed containers (which are now enabled by default).
And in general, a .png diagram is opaque to diffs and will likely go stale as the project evolves. I'd suggest switching to a text-based diagram that could be rendered as expected by TechDocs (Mermaid, PlantUML, ...), if possible.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/rhdh-local-guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@ RHDH Local serves multiple purposes for platform engineers, developers, and orga
* Use plugin scaffolding templates
* Integrate locally-built plugins for development workflows

## Architecture Overview

The following diagram illustrates the RHDH Local service flow, showing how the container services, entry scripts, shared volumes, and environment configuration fit together when you run `compose up`.

![RHDH Local — Service Flow](../images/rhdh-local-runtime-architecture.png){ width="850" }

## Key Requirements of RHDH Local

To use RHDH Local effectively, you need:
Expand Down