nginx-gateway-fabric icon indicating copy to clipboard operation
nginx-gateway-fabric copied to clipboard

Published 20 hours ago • verified publisher icon nginxinc

NGINX Gateway Fabric Docs Not Very Easy To Follow

Open conradwt opened this issue 1 year ago • 2 comments
trafficstars

When attempting to install the Nginx implementation K8s Gateway API (i.e. Nginx Gateway Fabric), I found the documentation hard to follow because I had to jump from one page of the site to another. Thus, it wasn't clear as to what I was installing here. In the documentation, there should be a quick start that provides an end-to-end example of how to install and use Nginx's K8s Gateway API features. For example, here's a possible Getting Started outline for local development:

  1. create the cluster
  2. install MetalLB
  3. install the Gateway CRDs
  4. create the Gateway and Gateway resources
  5. install Nginx Gateway Fabric
  6. deploy a sample service
  7. create HTTPRoute for our deployed service
  8. test the routing rule
  9. and so on

BTW, the steps were inspired by both the Kong and Traefik K8s Gateway API implementations. Furthermore, I put together a document for using the Kong implementation that can be found here:

  • https://github.com/conradwt/k8s-gateway-api-using-kong

conradwt avatar Aug 08 '24 08:08 conradwt