Add Routing Traffic to Your Application Guide #991
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
github-actions
bot
added
the
documentation
pleshakov
reviewed
Aug 21, 2023
sjberman
reviewed
Aug 22, 2023
mpstefan
approved these changes
Aug 22, 2023
kate-osborn
force-pushed
the
docs/basic-use-case-guide
branch
2 times, most recently
from
2c813b9 to
6d406ee
Compare
kate-osborn
changed the title
pleshakov
reviewed
Aug 25, 2023
sjberman
reviewed
Aug 25, 2023
sjberman
reviewed
Aug 25, 2023
sjberman
approved these changes
Aug 25, 2023
ADubhlaoich
approved these changes
Aug 28, 2023
added 8 commits
August 28, 2023 13:46
Co-authored-by: Alan Dooley <ADubhlaoich@users.noreply.github.com>
kate-osborn
force-pushed
the
docs/basic-use-case-guide
branch
from
6c546f7 to
5877ef7
Compare
miledxz
added a commit
to miledxz/nginx-gateway-fabric
that referenced
this pull request
Jan 14, 2025
Problem: As a potential user of NKG, I want a guide to help me understand how to host an application API with NKG so that I can easily understand how to start using NKG in my environment immediately. Solution: Add a use case guide that describes how to route all traffic to a single application running in Kubernetes using NKG.
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
Problem: As a potential user of NKG, I want a guide to help me understand how to host an application API with NKG so that I can easily understand how to start using NKG in my environment immediately.
Solution: Add a use case guide that describes how to route all traffic to a single application running in Kubernetes using NKG.
Testing: Ran through guide
This is meant to be the basic use case guide so we are intentionally not introducing every field and variation of the Gateway API. We want to give the users enough information to get started. Other use case guides will build on the information provided in this guide.
Closes #876
The diagrams are written using mermaid, but the GitHub mermaid integration is not working well with dark mode, so I added them as pngs. The mermaid source files are in the /docs/images/source directory. This will allow internal and external contributors to easily modify the diagrams.
Checklist
Before creating a PR, run through this checklist and mark each as complete.