Skip to content

Add architecture diagrams for Radius services and CLI - #11399

Merged
brooke-hamilton merged 8 commits into
radius-project:mainfrom
willdavsmith:willdavsmith/architecturemd
Mar 13, 2026
Merged

brooke-hamilton merged 8 commits into
radius-project:mainfrom
willdavsmith:willdavsmith/architecturemd

Conversation

@willdavsmith

@willdavsmith willdavsmith commented Mar 9, 2026 •

Copy link
Copy Markdown
Contributor

Description

Add architecture diagrams for Radius services and CLI

Type of change

  • This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional).

Fixes: #issue_number

Contributor checklist

Please verify that the PR meets the following requirements, where applicable:

  • An overview of proposed schema changes is included in a linked GitHub issue.
    • Yes
    • Not applicable
  • A design document PR is created in the design-notes repository, if new APIs are being introduced.
    • Yes
    • Not applicable
  • The design document has been reviewed and approved by Radius maintainers/approvers.
    • Yes
    • Not applicable
  • A PR for the samples repository is created, if existing samples are affected by the changes in this PR.
    • Yes
    • Not applicable
  • A PR for the documentation repository is created, if the changes in this PR affect the documentation or any user facing updates are made.
    • Yes
    • Not applicable
  • A PR for the recipes repository is created, if existing recipes are affected by the changes in this PR.
    • Yes
    • Not applicable

Signed-off-by: willdavsmith <willdavsmith@gmail.com>
@willdavsmith
willdavsmith had a problem deploying to external-contributor-approval March 9, 2026 19:01 — with GitHub Actions Failure
@willdavsmith
willdavsmith marked this pull request as ready for review March 9, 2026 20:43
@willdavsmith
willdavsmith requested review from a team as code owners March 9, 2026 20:43
Copilot AI review requested due to automatic review settings March 9, 2026 20:43
@willdavsmith willdavsmith changed the title [WIP] Add architecture diagrams for Radius services and CLI Add architecture diagrams for Radius services and CLI Mar 9, 2026

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

Adds a code-oriented architecture documentation set under docs/architecture/ and links to it from existing contributor docs, so developers can quickly find entry points, key packages, and safe-change guidance when working in this repository.

Changes:

  • Introduce new architecture “start here” index plus per-binary architecture notes (UCP, applications-rp, dynamic-rp, controller, CLI).
  • Add shared-runtime/ARM-RPC overview and a service interaction map with Mermaid diagrams.
  • Cross-link architecture docs from docs/README.md and the control-plane contributing index.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/README.md Adds a pointer from docs index to the new architecture docs set.
docs/contributing/contributing-code/contributing-code-control-plane/README.md Links control-plane contributor guide to architecture docs for upfront context.
docs/architecture/README.md Provides the architecture docs entrypoint, reading order, and related material links.
docs/architecture/service-interaction-map.md Adds a high-level runtime map of executables and typical flows.
docs/architecture/shared-runtime-and-armrpc.md Documents shared hosting/HTTP/builder/async framework used by Go services.
docs/architecture/ucp.md Adds UCP-focused entry points, package map, and routing flow diagrams.
docs/architecture/applications-rp.md Adds applications-rp architecture overview and builder/async handoff flow.
docs/architecture/dynamic-rp.md Adds dynamic-rp architecture overview emphasizing generic lifecycle handling.
docs/architecture/controller.md Adds controller architecture overview and reconciler flow diagram.
docs/architecture/rad-cli.md Adds CLI architecture overview, dependency seams, and deploy flow diagram.

Comment thread docs/architecture/controller.md Resolved
@brooke-hamilton
brooke-hamilton temporarily deployed to external-contributor-approval March 9, 2026 21:07 — with GitHub Actions Inactive
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
@brooke-hamilton
brooke-hamilton temporarily deployed to external-contributor-approval March 9, 2026 21:11 — with GitHub Actions Inactive
Signed-off-by: willdavsmith <willdavsmith@gmail.com>
@willdavsmith
willdavsmith had a problem deploying to external-contributor-approval March 9, 2026 21:43 — with GitHub Actions Failure
@willdavsmith
willdavsmith temporarily deployed to external-contributor-approval March 9, 2026 21:43 — with GitHub Actions Inactive
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
@brooke-hamilton
brooke-hamilton had a problem deploying to external-contributor-approval March 9, 2026 22:21 — with GitHub Actions Failure
…plane/README.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
@brooke-hamilton
brooke-hamilton had a problem deploying to external-contributor-approval March 9, 2026 22:21 — with GitHub Actions Failure
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
@brooke-hamilton
brooke-hamilton temporarily deployed to external-contributor-approval March 9, 2026 22:22 — with GitHub Actions Inactive
@brooke-hamilton
brooke-hamilton requested a review from sk593 March 11, 2026 04:51
@brooke-hamilton
brooke-hamilton merged commit 0803e28 into radius-project:main Mar 13, 2026
41 checks passed
willtsai pushed a commit that referenced this pull request Mar 30, 2026
# Description

Add architecture diagrams for Radius services and CLI

## Type of change

<!--

Please select **one** of the following options that describes your
change and delete the others. Clearly identifying the type of change you
are making will help us review your PR faster, and is used in authoring
release notes.

If you are making a bug fix or functionality change to Radius and do not
have an associated issue link please create one now.

-->

- This pull request is a minor refactor, code cleanup, test improvement,
or other maintenance task and doesn't change the functionality of Radius
(issue link optional).

<!--

Please update the following to link the associated issue. This is
required for some kinds of changes (see above).

-->

Fixes: #issue_number

## Contributor checklist
Please verify that the PR meets the following requirements, where
applicable:

<!--
This checklist uses "TaskRadio" comments to make certain options
mutually exclusive.
See:
https://github.com/mheap/require-checklist-action?tab=readme-ov-file#radio-groups
For details on how this works and why it's required.
-->

- An overview of proposed schema changes is included in a linked GitHub
issue.
    - [ ] Yes <!-- TaskRadio schema -->
    - [x] Not applicable <!-- TaskRadio schema -->
- A design document PR is created in the [design-notes
repository](https://github.com/radius-project/design-notes/), if new
APIs are being introduced.
    - [ ] Yes <!-- TaskRadio design-pr -->
    - [x] Not applicable <!-- TaskRadio design-pr -->
- The design document has been reviewed and approved by Radius
maintainers/approvers.
    - [ ] Yes <!-- TaskRadio design-review -->
    - [x] Not applicable <!-- TaskRadio design-review -->
- A PR for the [samples
repository](https://github.com/radius-project/samples) is created, if
existing samples are affected by the changes in this PR.
    - [ ] Yes <!-- TaskRadio samples-pr -->
    - [x] Not applicable <!-- TaskRadio samples-pr -->
- A PR for the [documentation
repository](https://github.com/radius-project/docs) is created, if the
changes in this PR affect the documentation or any user facing updates
are made.
    - [ ] Yes <!-- TaskRadio docs-pr -->
    - [x] Not applicable <!-- TaskRadio docs-pr -->
- A PR for the [recipes
repository](https://github.com/radius-project/recipes) is created, if
existing recipes are affected by the changes in this PR.
    - [ ] Yes <!-- TaskRadio recipes-pr -->
    - [x] Not applicable <!-- TaskRadio recipes-pr -->

---------

Signed-off-by: willdavsmith <willdavsmith@gmail.com>
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Co-authored-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

This branch was previously deployed

1 inactive deployment
external-contributor-approval — c3d8af0b Deployed Mar 9, 2026 by brooke-hamilton via Approval Gate #8284
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.

4 participants