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

Open
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

@ciarams87 ciarams87 force-pushed the feat/update-ngf-architecture branch 3 times, most recently from 3e366c8 to d41b315 Compare April 28, 2025 11:54
@ciarams87 ciarams87 marked this pull request as ready for review April 28, 2025 11:57
@ciarams87 ciarams87 requested a review from a team as a code owner April 28, 2025 11:57
@bjee19 bjee19 force-pushed the ngf-feature-cp-dp-split branch from 8319e75 to e95d5f2 Compare April 28, 2025 17:26
Copy link

@bjee19 bjee19 left a comment

Choose a reason for hiding this comment

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

looks like there might be some rebase/merging issues with other files included in the pr, but the gateway-architecture looks good to me! 🚀

@ciarams87 ciarams87 force-pushed the feat/update-ngf-architecture branch from d41b315 to c78fee7 Compare April 28, 2025 20:54
@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels Apr 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants