Skip to content

Commit

Permalink
Improve installation doc (#1153)
Browse files Browse the repository at this point in the history
Problem: The installation doc does not mention that NGINX 
will not listen until a Gateway is created. This can be confusing 
for first-time users. 

Solution: Add note to installation doc.
  • Loading branch information
kate-osborn authored Oct 17, 2023
1 parent f0bae36 commit 1c8fdd3
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,14 @@ You can gain access to NGINX Gateway Fabric by creating a `NodePort` Service or
This Service must live in the same Namespace as the controller. The name of this Service is provided in
the `--service` argument to the controller.

> Important
>
> **Important**
> The Service manifests expose NGINX Gateway Fabric on ports 80 and 443, which exposes any
> Gateway [Listener](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.Listener)
> configured for those ports. If you'd like to use different ports in your listeners,
> update the manifests accordingly.
>
> Additionally, NGINX Gateway Fabric will not listen on any ports until you configure a
[Gateway](https://gateway-api.sigs.k8s.io/api-types/gateway/#gateway) resource with a valid listener.

NGINX Gateway Fabric will use this Service to set the Addresses field in the Gateway Status resource. A LoadBalancer
Service sets the status field to the IP address and/or Hostname. If no Service exists, the Pod IP address is used.
Expand Down

0 comments on commit 1c8fdd3

Please sign in to comment.