Skip to content

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

Draft
wants to merge 4 commits into
base: ngf-feature-cp-dp-split
Choose a base branch
from

Conversation

ciarams87
Copy link

@ciarams87 ciarams87 commented Apr 24, 2025

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.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. 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.

Copy link

github-actions bot commented Apr 24, 2025

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@ciarams87 ciarams87 requested a review from a team April 24, 2025 13:35
@ciarams87
Copy link
Author

I have hereby read the F5 CLA and agree to its terms

%% Assign Custom Style Classes
class DataplaneComponentsAB dashedSubgraph;
class DataplaneComponentsC dashedSubgraph;
```
Copy link
Contributor

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?

Copy link
Author

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.

Copy link
Author

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?

Copy link
Contributor

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.

Copy link
Author

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

@ciarams87 ciarams87 force-pushed the feat/update-ngf-architecture branch from 264d327 to 381d3c3 Compare April 24, 2025 18:08
@ciarams87 ciarams87 force-pushed the feat/update-ngf-architecture branch from 381d3c3 to 3e366c8 Compare April 24, 2025 18:54
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