NGF: control plane/data plane split docs #590
Merged
Conversation
This file contains hidden or 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
Problem: Added support for running NGINX in debug mode in NGF's CP-DP split which changes the old way to run NGINX in debug mode. Solution: Update docs to show new way to run NGINX in debug mode.
Problem: With the new NGF architecture incoming, the process for setting up NGINX Plus is slightly different than before. Solution: Update the docs to remove unnecessary steps and add extra context around creating NGINX Plus Secrets.
Add new CLI field and update CLI name for the changes in the split feature.
Update documentation on prometheus metrics. Problem: Because NGF now uses NGINX Agent to export NGINX metrics, we need to update our documentation on metrics available and the example grafana dashboard. Solution: Update the metrics. * Add feedback
Mention that users can update the original Secrets to propagate changes to duplicate Secrets.
A few flags have been removed, and one new one has been added.
Update documentation on accessing nginx container Problem: With our incoming changes to our control data plane split, the nginx container will no longer be in the NGF Pod. Thus all documentation on accessing the nginx container (logs, sending traffic, config...) need to be updated. Solution: Updated the documentation. Mainly, when sending traffic in the examples, the host and IP of the NGINX Service are recorded after the Gateway is deployed. Also updated a link in the NGINX Plus feature document to point away from the NGINX Prometheus exporter and to the internal document showing metrics.
* NGF: Update architecture overview * Apply suggestions from code review Co-authored-by: Saylor Berman <[email protected]> * Review feedback * Improve diagrams * Final feedback --------- Co-authored-by: Saylor Berman <[email protected]>
The getting started guide needs to change with the new NGF architecture, specifically regarding the NodePorts. The user no longer needs to create the Service, and instead specifies configuration at installation time.
Update docs for CP/DP split telemetry changes. Problem: Some small docs changes are needed for the new telemetry metrics/changes introduced with the control data plane split. Solution: Add the new metrics. Also updated the data plane configuration document small error of including the namespace field in the gateway.infrastructure.parametersRef field since that does not exist.
With the control plane and data plane split in NGF, a secure connection is necessary for communication between the two entities. We secure this by default, but for production environments, users should use an official solution to secure this communication channel. This doc describes how to do that.
docs: Updata data plane configuration doc to reflect changes to NginxProxy resource
docs: Introduces a new how-to guide on scaling control and data plane pods
Update tracing doc and Helm install doc
Agent updated some metrics names and descriptions. Updating the NGF doc that describes them.
Add "Deploy Data plane document" to guide users on how to create and modify the NGINX Data Plane. Problem: Users want a guide on how to create and modify the NGINX Data Plane. Solution: Added the guide.
docs: Updates Gateway Compatibility document to reflect new architecture changes.
Update missed imagePullSecret helm values
* docs: upgrade NGF from v1.x to v2.x
Problem: Agent metrics were updated, but the NGF sample dashboard was not. Solution: Update the dashboard with the new metrics name.
github-actions
bot
added
documentation
✅ Deploy Preview will be available once build job completes!
|
ADubhlaoich
approved these changes
May 23, 2025
salonichf5
approved these changes
May 27, 2025
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.
Now that the control plane/data plane split feature is in main in NGF, we can merge this docs feature branch into the upcoming NGF release branch for 2.0.
All PRs as a part of this branch were previously reviewed, but a once-over isn't a bad idea.
Checklist
Before merging a pull request, run through this checklist and mark each as complete.
README.mdandCHANGELOG.mdFootnotes
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. ↩