MPP-3864: Add more container-level (C2) diagrams #5000
Merged
Conversation
This file contains 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
Hand-tune the relationship lines from tasks to backend services on the Container (C2) diagram. Make the vertical segments vertical, parallel to each other, and tighten the entry and exit angles. After this was done, solid relationship lines were more pleasing than dashed lines, so I switched to a dark grey line.
Move the elements so the C2 high-level diagram has more of a landscape orientation, like a slide. Move Stripe and GA a little more to the left, to mirror the C1 diagram.
groovecoder
approved these changes
Sep 4, 2024
docs/system_diagrams.md
Outdated
Comment on lines
32
to
37
| - **User Interfaces** (_Collection_) - The various ways Relay users manage masks | ||
| - **Email Services** (_Collection_) - The AWS systems that provide email sending and | ||
| receiving. | ||
| - **Other Managed Services** (_Collection_) - Other GCP services used to provide the | ||
| Relay application and talk to Mozilla backend systems | ||
| - **Periodic Tasks** (_Collection_) - Other backend Django applications that help provide the service |
There was a problem hiding this comment.
question & suggestion (non-blocking): Is there a way to link these list items to their respective sections/headings? And then to add a corresponding "Back to Containers Diagram" link below each of those diagrams back up to this one?
| -> db | ||
| -> logs | ||
| -> metrics | ||
| -> sentry |
There was a problem hiding this comment.
praise: thanks for connecting these containers to the entities, but keeping the diagram simpler by omitting the "Sends exceptions" and "HTTPS API" labels from every relationship line.
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.
This adds a "top-level" container (c2) diagram, which makes a smoother transition from the system context (c1) diagram, by collecting containers into "container collections". There are further diagrams that "zoom in" to these container collections:
The "All details" diagram remains. For this and the deployment diagrams, I've adjusts some of the relationship lines so they do not overlap as much, but instead remain distinct traces.
The easiest way to review is to view the
docs/system_diagrams.mddocument with the inline SVG images.