NGF: Update documentation on accessing nginx container #453
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
bjee19
changed the title
y82
approved these changes
Apr 28, 2025
sjberman
reviewed
Apr 28, 2025
Comment on lines
150
to
157
| Save the public IP address and port of the NGINX Service into shell variables: | ||
|
|
||
| ```text | ||
| GW_IP=XXX.YYY.ZZZ.III | ||
| GW_PORT=<port number> | ||
| ``` | ||
|
|
||
| {{< note >}}In a production environment, you should have a DNS record for the external IP address that is exposed, and it should refer to the hostname that the gateway will forward for.{{< /note >}} |
There was a problem hiding this comment.
Should this be above after we've created the Gateway resource? For consistency with the rest.
bjee19
force-pushed
the
ngf-feature-cp-dp-split
branch
from
8319e75 to
e95d5f2
Compare
bjee19
force-pushed
the
update-accessing-nginx-containers
branch
from
5d65d66 to
be3aeba
Compare
github-actions
bot
added
documentation
bjee19
force-pushed
the
update-accessing-nginx-containers
branch
from
be3aeba to
c1db9e4
Compare
sjberman
approved these changes
Apr 28, 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.
Proposed changes
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.
Testing: Ran
make watchand it looked good.Closes
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. ↩