Skip to content

Commit 083103b

Browse files
author
isaac
committed
Update install docs with status and port flags
1 parent 1725583 commit 083103b

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

docs/installation.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,21 @@ The public IP can be reported in the status of an ingress resource. To enable:
144144
145145
Read more about the type LoadBalancer [here](https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer).
146146
147-
## 5. Access the Live Activity Monitoring Dashboard
147+
## 5. Access the Live Activity Monitoring Dashboard / Stub_status Page
148+
For NGINX, you can access the [stub_status page](http://nginx.org/en/docs/http/ngx_http_stub_status_module.html):
149+
1. Stub_status is enabled by default. Ensure that the `nginx-status` command-line argument is not set to false.
150+
2. Stub_status is available on port 8080 by default. It is customizable by the `nginx-status-port` command-line argument. If yours is not on 8080, modify the kubectl proxy command below.
151+
1. Use the `kubectl port-forward` command to forward connections to port 8080 on your local machine to port 8080 of an NGINX Ingress controller pod (replace `<nginx-ingress-pod>` with the actual name of a pod):.
152+
```
153+
$ kuebctl port-forward <nginx-ingress-pod> 8080:8080 --namespace=nginx-ingress
154+
```
155+
Open your browser at http://127.0.0.1:8080/stub_status to access the status.
156+
148157
149158
For NGINX Plus, you can access the live activity monitoring dashboard:
150-
1. Use `kubectl port-forward` command to forward connections to port 8080 on your local machine to port 8080 of an NGINX Plus Ingress controller pod (replace <nginx-plus-ingress-pod> with the actual name of a pod):
159+
1. The dashboard is enabled by default. Ensure that the `nginx-status` command-line argument is not set to false.
160+
1. The dashboard is available on port 8080 by default. It is customizable by the `nginx-status-port` command-line argument. If yours is not on 8080, modify the kubectl proxy command below.
161+
1. Use the `kubectl port-forward` command to forward connections to port 8080 on your local machine to port 8080 of an NGINX Plus Ingress controller pod (replace `<nginx-plus-ingress-pod>` with the actual name of a pod):
151162
```
152163
$ kubectl port-forward <nginx-plus-ingress-pod> 8080:8080 --namespace=nginx-ingress
153164
```

0 commit comments

Comments
 (0)