Skip to content

Commit 1c8fdd3

Browse files
authored
Improve installation doc (#1153)
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.
1 parent f0bae36 commit 1c8fdd3

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/installation.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,14 @@ You can gain access to NGINX Gateway Fabric by creating a `NodePort` Service or
6767
This Service must live in the same Namespace as the controller. The name of this Service is provided in
6868
the `--service` argument to the controller.
6969

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

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

0 commit comments

Comments
 (0)