-
Notifications
You must be signed in to change notification settings - Fork 59
NGF: Update architecture overview #450
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.
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
base: ngf-feature-cp-dp-split
Are you sure you want to change the base?
NGF: Update architecture overview #450
Conversation
✅ All required contributors have signed the F5 CLA for this PR. Thank you! |
I have hereby read the F5 CLA and agree to its terms |
%% Assign Custom Style Classes | ||
class DataplaneComponentsAB dashedSubgraph; | ||
class DataplaneComponentsC dashedSubgraph; | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The only downside of using mermaid versus manual is it doesn't render the prettiest or most balanced diagrams. (like the giant nginx-gateway namespace box). Unless you can create a manual image and translate into mermaid?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll see if I can tweak it a bit more, but yeah, it is an issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've changed the alignment to Left Right from Top Down which has kind of improved it I think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, that does look a bit better. Only nitpick would be the AB components are below the C components.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll see if I can reorder them
Co-authored-by: Saylor Berman <[email protected]>
264d327
to
381d3c3
Compare
381d3c3
to
3e366c8
Compare
Proposed changes
Problem: The Gateway architecture document does not reflect the new control plane/ data plane split
Solution: Update the architecture document to reflect the new architecture. This PR also converts the existing diagrams into mermaid from PNG files.
Closes nginx/nginx-gateway-fabric#3234
Checklist
Before merging a pull request, run through this checklist and mark each as complete.
README.md
andCHANGELOG.md
Footnotes
Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content. ↩