Update installation.md to include a clarification on the instructions #977
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
Add a note that a gateway resource must be configured in order for the NGINX Kubernetes Gateway to start listening on the assigned ports.
github-actions
bot
added
the
documentation
ciarams87
reviewed
Aug 16, 2023
| @@ -58,6 +58,11 @@ You can gain access to NGINX Kubernetes Gateway by creating a `NodePort` Service | |||
| > configured for those ports. If you'd like to use different ports in your listeners, | |||
| > update the manifests accordingly. | |||
|
|
|||
| > Important | |||
| > | |||
| > NGINX Kubernetes Gateway will not listen on any ports until you configure a | |||
There was a problem hiding this comment.
Suggested change
| > NGINX Kubernetes Gateway will not listen on any ports until you configure a | |
| > NGINX will not listen on any ports until you configure a |
This was referenced Oct 17, 2023
Closed
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.
Add a note that a gateway resource must be configured in order for the NGINX Kubernetes Gateway to start listening on the assigned ports.
Proposed changes
Problem: I followed the installation instructions and then spent time debugging why I couldn't reach the nginx server using the NodePort.
Solution: Add a note to the instructions that a gateway resource must be configured. A similar note is already contained in the kind installation instructions but not in the generic installation guide.
Testing: N/A
Checklist
Before creating a PR, run through this checklist and mark each as complete.