Skip to content

NGF: Upgrade NGF from 1.x to 2.x #564

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

salonichf5
Copy link

Proposed changes

Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
following format:

Problem: Users need documentation to upgrade from NGF v1.6.x to v2.0.x

Solution: Adds an upgrade document with instructions to upgrade

Testing: Describe any testing that you did.

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

If this PR addresses an issue on GitHub, ensure that you link to it here:

Closes #ISSUE

nginx/nginx-gateway-fabric#3241

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.

@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels May 19, 2025
@salonichf5 salonichf5 marked this pull request as ready for review May 19, 2025 18:33
@salonichf5 salonichf5 requested a review from a team as a code owner May 19, 2025 18:33
@salonichf5 salonichf5 force-pushed the docs/upgrade-ngf branch 2 times, most recently from 7147105 to 527d8d9 Compare May 19, 2025 18:47
@@ -0,0 +1,96 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm thinking this doc should be top level of our docs for now. It probably won't be a permanent doc, though users are slow to upgrade, so it'll be around for awhile. But I want it to be obvious for users. @ADubhlaoich what do you think?


With this release, NGINX Gateway Fabric adopts a new architecture that separates the control plane and data plane into independent deployments. This separation improves scalability, security, and operational clarity.

The control plane is a Kubernetes controller built with `controller-runtime`. It watches Gateway API and Kubernetes resources (e.g., Services, Endpoints, Secrets) and dynamically provisions NGINX data plane deployments for each Gateway.
Copy link
Contributor

Choose a reason for hiding this comment

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

This context isn't necessary for this doc.

@salonichf5 salonichf5 requested a review from a team May 20, 2025 15:21
@salonichf5 salonichf5 changed the title NGF: Upgrade NGF from 1.6.x to 2.0.x NGF: Upgrade NGF from 1.x to 2.x May 20, 2025
@salonichf5 salonichf5 force-pushed the docs/upgrade-ngf branch 2 times, most recently from 16ee0c1 to 13be7da Compare May 20, 2025 19:10
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/564/

@salonichf5 salonichf5 force-pushed the docs/upgrade-ngf branch 2 times, most recently from c4fec32 to 7ab7aed Compare May 20, 2025 19:34
@salonichf5 salonichf5 requested review from sjberman and a team May 20, 2025 19:39
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.

2 participants