Skip to content
This repository was archived by the owner on Aug 22, 2025. It is now read-only.

Commit d6c54f8

Browse files
committed
update install guides
1 parent b523795 commit d6c54f8

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed

docs/http/http-installation-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -546,7 +546,7 @@ kubectl create namespace nkl
546546
kubectl apply -f secret.yaml serviceaccount.yaml clusterrole.yaml clusterrolebinding.yaml
547547
```
548548

549-
- Modify the ConfigMap manifest to match your Network environment. Change the `nginx-hosts` IP address to match your NGINX LB Server IP. If you have 2 or more LB Servers, separate them with a comma. Important! - keep the port number for the Plus API endpoint, and the `/api` URL as shown.
549+
- Modify the ConfigMap manifest to match your NGINX LB Server(s). Change the `nginx-hosts` IP address to match your NGINX LB Server IP. If you have 2 or more LB Servers, separate them with a comma. Important! - keep the port number for the Plus API endpoint, and the `/api` URL as shown.
550550

551551
```yaml
552552
apiVersion: v1
@@ -571,7 +571,7 @@ kubectl apply -f nkl-configmap.yaml
571571
kubectl apply -f nkl-deployment.yaml
572572
```
573573

574-
Check to see if the NKL Controller is running with the updated ConfigMap:
574+
Check to see if the NKL Controller is running, with the updated ConfigMap:
575575

576576
```bash
577577
kubectl get pods -n nkl
@@ -584,7 +584,7 @@ The status should show "running", your `nginx-hosts` should have the LB Server I
584584

585585
![NKL Running](../media/nkl-configmap.png)
586586

587-
To make it easy to watch the NKL Controller log messages, add the following bash alias:
587+
To make it easy to watch the NKL Controller's log messages, add the following bash alias:
588588

589589
```bash
590590
alias nkl-follow-logs='kubectl -n nkl get pods | grep nkl-deployment | cut -f1 -d" " | xargs kubectl logs -n nkl --follow $1'

docs/tcp/tcp-installation-guide.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ A standard K8s cluster is all that is required. There must be enough resources
6060

6161
<br/>
6262

63-
# 1. Install NGINX Ingress Controller
63+
## 1. Install NGINX Ingress Controller
6464

6565
<br/>
6666

@@ -107,15 +107,15 @@ Note: If you choose a different Application to test with, `the NGINX health chec
107107

108108
https://github.com/nginxinc/kubernetes-ingress/tree/main/examples/ingress-resources/complete-example
109109

110-
- The Cafe Demo Docker image used is an upgraded one, with simple graphics and additional Request and Response variables added.
110+
- The Cafe Demo Docker image used here is an upgraded one, with simple graphics and additional TCP/IP and HTTP variables added.
111111

112112
https://hub.docker.com/r/nginxinc/ingress-demo
113113

114114
**IMPORTANT** - Do not use the `cafe-ingress.yaml` file. Rather, use the `cafe-virtualserver.yaml` file that is provided here. It uses the NGINX Plus CRDs to define a VirtualServer, and the related Virtual Server Routes needed. If you are using NGINX OSS Ingress Controller, you will need to use the appropriate manifests, which is not covered in this Solution.
115115

116116
<br/>
117117

118-
# 3. Install NGINX Plus on LoadBalancer Server(s)
118+
## 3. Install NGINX Plus on LoadBalancer Server(s)
119119

120120
<br/>
121121

@@ -157,10 +157,9 @@ https://www.nginx.com/free-trial-request/
157157
158158
- dashboard.conf | NGINX Plus API and Dashboard config
159159
- default-tcp.conf | New default.conf config
160-
- grafana-dashboard.json | NGINX Plus Grafana dashboard
161160
- nginx.conf | New nginx.conf
162-
- loadbalancer-nkl.yaml | LoadBalancer manifest for Cluster1
163-
- nodeport-nkl.yaml | NodePort manifest for Cluster1
161+
- loadbalancer-nkl.yaml | LoadBalancer manifest
162+
- nodeport-nkl.yaml | NodePort manifest
164163

165164
>/etc/nginx/stream
166165
@@ -206,7 +205,7 @@ server {
206205
```
207206

208207
- Enable the NGINX Plus dashboard. Use the `dashboard.conf` file provided. It will enable the /api endpoint, change the port to 9000, and provide access to the Plus Dashboard. Note: There is no security for the /api endpoint in this example config, it should be secured as approprite with TLS or IP allow list.
209-
- Place this file in the /etc/nginx/conf.d folder, and reload nginx. The Plus dashboard is now accessible at http://nginx-lb-server-ip:9000/dashboard.html. It should look similar to this:
208+
- Place this file in the /etc/nginx/conf.d folder, and reload nginx. The Plus dashboard is now accessible at http://<nginx-lbserver-ip>:9000/dashboard.html. It should look similar to this:
210209

211210
![NGINX Dashboard](../media/nkl-stream-dashboard.png)
212211

@@ -319,7 +318,7 @@ stream {
319318

320319
```
321320

322-
- Check the NGINX Plus Dashboard, at http://<nginx-lbserver-ip:9000/dashboard.html. You should see something like this:
321+
- Check the NGINX Plus Dashboard, at http://<nginx-lbserver-ip>:9000/dashboard.html. You should see something like this:
323322

324323
![NKL Stream Upstreams](../media/nkl-stream-dashboard.png)
325324

@@ -355,7 +354,7 @@ kubectl create namespace nkl
355354
kubectl apply -f secret.yaml serviceaccount.yaml clusterrole.yaml clusterrolebinding.yaml
356355
```
357356

358-
Modify the ConfigMap manifest to match your Network environment. Change the `nginx-hosts` IP address to match your NGINX LB Server IP. If you have 2 or more LB Servers, separate them with a comma. Keep the port number for the Plus API endpoint, and the `/api` URL as shown.
357+
Modify the ConfigMap manifest to match your NGINX LB Server(s). Change the `nginx-hosts` IP address to match your NGINX LB Server IP. If you have 2 or more LB Servers, separate them with a comma. Keep the port number for the Plus API endpoint, and the `/api` URL as shown.
359358

360359
```yaml
361360

@@ -382,7 +381,7 @@ Deploy the NKL Controller:
382381
kubectl apply -f nkl-deployment.yaml
383382
```
384383

385-
Check to see if the NKL Controller is running with the updated ConfigMap:
384+
Check to see if the NKL Controller is running, with the updated ConfigMap:
386385

387386
```bash
388387
kubectl get pods -n nkl
@@ -395,13 +394,13 @@ The status should show "running", your `nginx-hosts` should have the LB Server I
395394

396395
![NKL Running](../media/nkl-configmap.png)
397396

398-
To make it easy to watch the NKL controller log messages, add the following bash alias:
397+
To make it easy to watch the NKL Controller's log messages, add the following bash alias:
399398

400399
```bash
401400
alias nkl-follow-logs='kubectl -n nkl get pods | grep nkl-deployment | cut -f1 -d" " | xargs kubectl logs -n nkl --follow $1'
402401
```
403402

404-
Using a Terminal, watch the NKL Controller logs:
403+
Using a Terminal, you can watch the NKL Controller log:
405404

406405
```bash
407406
nkl-follow-logs
@@ -552,8 +551,8 @@ When you are finished, the NGINX Plus Dashboard on the LB Server should look sim
552551

553552
Important items for reference:
554553
- Orange are the upstream server blocks, from the `etc/nginx/stream/nginxk8slb.conf` file.
555-
- Blue is the IP:Port of the NodePort Service for http.
556-
- Indigo is the IP:Port of the NodePort Service for https.
554+
- Blue is the IP:Port of the nginx-ingress Service for http.
555+
- Indigo is the IP:Port of the nginx-ingress Service for https.
557556

558557
>Note: In this example, there is a 3-Node K8s cluster, with one Control Node, and 2 Worker Nodes. The NKL Controller only configures `Worker Node` IP addresses, which are:
559558
- 10.1.1.8
@@ -584,7 +583,7 @@ or
584583
kubectl delete -f nodeport-nkl.yaml
585584
```
586585

587-
Now the `nginx-ingress` Service is gone, and the upstream list will be empty in the Dashboard.
586+
Now the `nginx-ingress` Service is gone, and the upstream lists will be empty in the Dashboard.
588587

589588
![NGINX No NodePort](../media/nkl-stream-no-nodeport.png)
590589

@@ -606,7 +605,7 @@ or
606605
kubectl apply -f nodeport-nkl.yaml
607606
```
608607

609-
- Verify the nginx-ingress Service is re-created. Notice the the Port Numbers have changed!
608+
- Verify the nginx-ingress Service is re-created. Notice the the NodePort Numbers have changed!
610609

611610
```bash
612611
kubectl get svc nginx-ingress -n nginx-ingress

0 commit comments

Comments
 (0)