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

Commit 0c1271e

Browse files
committed
update install guides
1 parent 3b995d8 commit 0c1271e

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

docs/tcp/tcp-installation-guide.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<br/>
88

9-
![Kubernetes](../media/kubernetes-icon.png) | ![NKL](../media/nkl-logo.png) | ![NGINX Plus](../media/NGINX-plus-icon.png) | ![NIC](../media/nginx-ingress-icon.png)
9+
![Kubernetes](../media/kubernetes-icon.png) | ![NKL](../media/nkl-logo.png) | ![NGINX Plus](../media/nginx-plus-icon.png) | ![NIC](../media/nginx-ingress-icon.png)
1010
--- | --- | --- | ---
1111

1212
<br/>
@@ -17,7 +17,7 @@
1717

1818
1. Provides a `replacement Loadbalancer Service.` The Loadbalancer Service is a key component provided by most Cloud Providers. However, when running a K8s Cluster On Premises, the `Loadbalancer Service is not available`.
1919
2. This Solution provides a replacement, using an NGINX Server, and a new K8s Controller from NGINX. These two components work together to watch the `nginx-ingress Service` in the cluster, and immediately update the NGINX LB Server when changes occur.
20-
- Provides automatic NGINX upstream config updates, application health checks, and enhanced metrics.
20+
3. Provides automatic NGINX upstream config updates, application health checks, and enhanced metrics.
2121

2222
<br/>
2323

@@ -39,7 +39,7 @@
3939

4040
### Pre-Requisites
4141

42-
- Working kubernetes cluster, with admin privleges
42+
- Working Kubernetes cluster, with admin privleges
4343
- Running `nginx-ingress controller`, either OSS or Plus. This install guide followed the instructions for deploying an NGINX Ingress Controller here: https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/
4444
- Demo application, this install guide uses the NGINX Cafe example, found here: https://github.com/nginxinc/kubernetes-ingress/tree/main/examples/ingress-resources/complete-example
4545
- A bare metal Linux server or VM for the external NGINX LB Server, connected to a network external to the cluster. Two of these will be required if High Availability is needed, as shown here.
@@ -205,7 +205,7 @@ server {
205205
```
206206

207207
- 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.
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:
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:
209209

210210
![NGINX Dashboard](../media/nkl-stream-dashboard.png)
211211

@@ -318,7 +318,7 @@ stream {
318318

319319
```
320320

321-
- 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:
322322

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

@@ -362,7 +362,7 @@ apiVersion: v1
362362
kind: ConfigMap
363363
data:
364364
nginx-hosts:
365-
"http://10.1.1.4:9000/api,http://10.1.1.5:9000/api" # change IP(s) to match NGINX LB Server(s)
365+
"http://10.1.1.4:9000/api,http://10.1.1.5:9000/api" # change IP(s) to match NGINX LB Server(s)
366366
metadata:
367367
name: nkl-config
368368
namespace: nkl
@@ -546,15 +546,14 @@ kubectl get svc nginx-ingress -n nginx-ingress
546546

547547
<br/>
548548

549-
The name of the Service port is matched to the name of the upstream block in NGINX. The Plus API, follows a defined format, so the url for the API call must be correct, in order to update the correct NGINX upstream block. There are 2 types of upstreams in NGINX. `Stream` upstreams are used in the stream context, for TCP/UDP load balancing configurations. `Http` upstreams are used in the http context, for HTTP/HTTPS configurations. (See details for HTTP in the http-installation-guide.md, here: [HTTP Guide](../http/http-installation-guide.md)
549+
The name of the Service port is matched to the name of the upstream block in NGINX. The Plus API, follows a defined format, so the url for the API call must be correct, in order to update the correct NGINX upstream block. There are 2 types of upstreams in NGINX. `Stream` upstreams are used in the stream context, for TCP/UDP load balancing configurations. `Http` upstreams are used in the http context, for HTTP/HTTPS configurations. (See details for HTTP in the http-installation-guide.md, here: [HTTP Guide](../http/http-installation-guide.md).
550550

551551
<br/>
552552

553553
## 7. Testing NKL NGINX Kubernetes Loadbalancer
554554

555555
<br/>
556556

557-
558557
When you are finished, the NGINX Plus Dashboard on the LB Server should look similar to the following image:
559558

560559
![NGINX Upstreams Dashboard](../media/nkl-stream-upstreams.png)
@@ -623,6 +622,11 @@ kubectl get svc nginx-ingress -n nginx-ingress
623622

624623
`The NKL Controller detects this change, and modifies the LB Server(s) upstreams to match.` The Dashboard will show you the new Port numbers, matching the new LoadBalancer or NodePort definitions. The NKL logs show these messages, confirming the changes:
625624

625+
![NKL LoadBalancer](../media/nkl-stream-add-loadbalancer.png)
626+
627+
or
628+
629+
![NKL NodePort](../media/nkl-stream-nodeport.png)
626630
![NKL Logs Created](../media/nkl-stream-logs-created.png)
627631
![NGINX Upstreams Dashboard](../media/nkl-stream-upstreams.png)
628632

0 commit comments

Comments
 (0)