Skip to content
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

Use Case Guide: How to direct traffic to your application via NKG #876

Closed
Tracked by #770
mpstefan opened this issue Jul 18, 2023 · 2 comments · Fixed by #991
Closed
Tracked by #770

Use Case Guide: How to direct traffic to your application via NKG #876

mpstefan opened this issue Jul 18, 2023 · 2 comments · Fixed by #991
Assignees
Labels
documentation Improvements or additions to documentation refined Requirements are refined and the issue is ready to be implemented. size/medium Estimated to be completed within a week
Milestone

Comments

@mpstefan
Copy link
Collaborator

mpstefan commented Jul 18, 2023

As a potential user of NKG
I want a guide to help me understand how I can host a one application API with NKG
So that I can easily understand how to immediately start using NKG in my environment.

Acceptance

  • A guide is created that explains how a user may set up their single application that hosts an API with NKG.
  • The guide explains WHY each step is necessary and how it can be tailored to their own use case.
  • The guide mentions forwarding "REST API" and "web application" traffic for search engine optimization.
  • A link is present for any relevant Kubernetes Gateway API guide.
@mpstefan mpstefan added this to the v0.6.0 milestone Jul 18, 2023
@mpstefan mpstefan added the documentation Improvements or additions to documentation label Jul 18, 2023
@mpstefan mpstefan changed the title Use Case Guide: How to Host an API via NKG Use Case Guide: How to Host an REST API via NKG Aug 1, 2023
@mpstefan
Copy link
Collaborator Author

mpstefan commented Aug 1, 2023

Here's a super rough outline I have...

More conceptual, WHY do we need a gateway, WHY do we need a route?
Walking through the examples

Title
Intro to the problem
What features will be used to implement the solution
Prerequisities
Diagram of what we are going to implement
Step by step process of implementing the solution, by resource, with full YAML examples
Method to test if the solution is working as intended
If it did not work, what things can we check?
Links to Kubernetes API Docs on the concepts used in this guide

@mpstefan mpstefan added the refined Requirements are refined and the issue is ready to be implemented. label Aug 1, 2023
@mpstefan
Copy link
Collaborator Author

mpstefan commented Aug 3, 2023

@mpstefan mpstefan added the size/medium Estimated to be completed within a week label Aug 7, 2023
@mpstefan mpstefan changed the title Use Case Guide: How to Host an REST API via NKG Use Case Guide: How to direct traffic to your application via NKG Aug 7, 2023
@kate-osborn kate-osborn moved this from 🆕 New to 🔖 To Do in NGINX Gateway Fabric Aug 10, 2023
@kate-osborn kate-osborn moved this from 🔖 To Do to 🏗 In Progress in NGINX Gateway Fabric Aug 11, 2023
@kate-osborn kate-osborn moved this from 🏗 In Progress to 👀 In Review in NGINX Gateway Fabric Aug 18, 2023
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in NGINX Gateway Fabric Aug 28, 2023
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 refined Requirements are refined and the issue is ready to be implemented. size/medium Estimated to be completed within a week
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants