update install guides

Author: chrisakker

docs/cafe-demo/cafe-virtualserver.yaml

@@ -1,6 +1,6 @@
 #Example virtual server with routes for Cafe Demo
 #For NKL Solution, redirects required for LB Server health checks
-#Chris Akker, Jan 2023
+#Chris Akker, Apr 2023
 #
 apiVersion: k8s.nginx.org/v1
 kind: VirtualServer

docs/http/http-installation-guide.md

@@ -151,7 +151,7 @@ https://www.nginx.com/free-trial-request/
 
 <br/>
 
-## 4. Configure Nginx Plus for MultiCluster Load Balancing
+## 4. Configure NGINX Plus for MultiCluster Load Balancing
 
 <br/>
 
@@ -654,8 +654,8 @@ kubectl apply -f loadbalancer-cluster1.yaml
 ![NKL Cluster1 Loadbalancer](..//media/nkl-cluster1-add-loadbalancer.png)
 
 Legend:
-- Orange is the LoadBalancer Service `External-IP`, which are your Nginx LB Server IP(s).
-- Blue is the `NodePort mapping` created by K8s. The new NKL Controller updates the Nginx LB Server upstreams with these, shown on the dashboard.
+- Orange is the LoadBalancer Service `External-IP`, which are your NGINX LB Server IP(s).
+- Blue is the `NodePort mapping` created by K8s. The new NKL Controller updates the NGINX LB Server upstreams with these, shown on the dashboard.
 
 <br/>
 
@@ -734,7 +734,7 @@ kubectl get svc nginx-ingress -n nginx-ingress
 
 <br/>
 
-## 7. Testing NKL Nginx Kubernetes Loadbalancer
+## 7. Testing NKL NGINX Kubernetes Loadbalancer
 
 <br/>
 
@@ -832,7 +832,7 @@ If you plan to implement and test the MultiCluster Load Balancing Solution, repe
 
 In this section, you will generate some HTTP load on the NGINX LB Server, and watch as it sends traffic to both Clusters. Then you will `dynamically change the HTTP Split ratio`, and watch NGINX send different traffic levels to each cluster.
 
-In these test examples, the Nginx LB Servers and IPs in the hosts file are:
+In these test examples, the NGINX LB Servers and IPs in the hosts file are:
 
 ```bash
 cat /etc/hosts
@@ -884,7 +884,7 @@ curl -iX PATCH -d '{"cafe.example.com":10}' http://nginxlb:9000/api/8/http/keyva
 
 ![NGINXLB Clusters 10-90](../media/nkl-clusters-10.png)
 
-**Important NOTE:** The first time, an `HTTP POST` is required to ADD a new record to the KeyValue store. Once the record exists, use an `HTTP PATCH` method to update an existing record, which will change the ratio value in KeyVal memory, dynamically. Nginx sees this change, and applies it with no reloads or restarts of NGINX required!
+**Important NOTE:** The first time, an `HTTP POST` is required to ADD a new record to the KeyValue store. Once the record exists, use an `HTTP PATCH` method to update an existing record, which will change the ratio value in KeyVal memory, dynamically. NGINX sees this change, and applies it with no reloads or restarts of NGINX required!
 
 Try a few more ratios, see how it works. If you review the `clusters.conf` file, you will discover what Ratios are provided for you. You can edit these to suit your needs. Also notice the Map directive has a "default" set to "50". So if the Value is blank or set incorrectly, it will Split at a default of 50:50 ratio.
 

docs/http/loadbalancer-cluster1.yaml

@@ -2,7 +2,7 @@
 # Spec -ports name must be in the format of
 # nkl-<upstream-block-name>
 # externalIPs are set to Nginx LB Servers
-# Chris Akker, Jan 2023
+# Chris Akker, Apr 2023
 #
 apiVersion: v1
 kind: Service

docs/http/loadbalancer-cluster2.yaml

@@ -2,7 +2,7 @@
 # Spec -ports name must be in the format of
 # nkl-<upstream-block-name>
 # externalIPs are set to Nginx LB Servers
-# Chris Akker, Jan 2023
+# Chris Akker, Apr 2023
 #
 apiVersion: v1
 kind: Service

docs/media/nkl-stream-add-loadbalancer.png

@@ -140,7 +140,7 @@ https://www.nginx.com/free-trial-request/
 
 <br/>
 
-## 4. Configure Nginx Plus for TCP Load Balancing
+## 4. Configure NGINX Plus for TCP Load Balancing
 
 ### This is the configuration required for the NGINX LB Server, external to the cluster. It must be configured for the following:
 
@@ -460,33 +460,35 @@ spec:
 
 ```
 
-Apply the NKL Compatible LoadBalancer `loadbalancer-nkl.yaml` Service Manifest:
+- Apply the NKL Compatible LoadBalancer `loadbalancer-nkl.yaml` Service Manifest:
 
 ```bash
 kubectl apply -f loadbalancer-nkl.yaml
 ```
 
-![NKL Stream Loadbalancer](..//media/nkl-stream-add-loadbalancer.png)
-
-Legend:
-- Orange is the LoadBalancer Service `External-IP`, which are your Nginx LB Server IP(s).
-- Blue is the `NodePort mapping` created by K8s. The new NKL Controller updates the Nginx LB Server upstreams with these, shown on the dashboard.
-
-<br/>
-
-Verify the LoadBalancer is now defined:
+- Verify the LoadBalancer is now defined:
 
 ```bash
 kubectl get svc nginx-ingress -n nginx-ingress
 ```
 
-The nginx-ingress Service, `ExternalIPs` should match your external Nginx LB Server IP(s):
+The nginx-ingress Service, `ExternalIPs` should match your external NGINX LB Server IP(s):
+
+![NKL Stream Loadbalancer](..//media/nkl-stream-add-loadbalancer.png)
+
+Legend:
+- Orange is the TYPE LoadBalancer Service
+- Red is the LoadBalancer Service `EXTERNAL-IP`, which are your NGINX LB Server IP(s); 10.1.1.4 and 10.1.1.5 in this example.
+- Blue is the `K8s NodePort mapping` for Port 80.
+- Indigo is the `K8s NodePort mapping` for Port 443.
+- Green is the NKL Log messages, creating the upstreams to match.
+- The new NKL Controller updates the NGINX LB Server upstreams with these, shown on the dashboard.
 
-![NKL LoadBalancer](../media/nkl-stream-loadbalancer.png)
+No Reload of NGINX needed! The NKL Controller uses the Plus API to dynamically add/delete/modify the upstreams as nginx-ingress Service changes.
 
 <br/>
 
-### Alternatively, if you want a Service Type NodePort Service
+### Alternatively, if you want a Service Type NodePort
 
 Review the new `nodeport-nkl.yaml` Service defintion file:
 
@@ -540,7 +542,15 @@ kubectl get svc nginx-ingress -n nginx-ingress
 
 <br/>
 
-## 7. Testing NKL Nginx Kubernetes Loadbalancer
+### Deep Dive Explanation
+
+<br/>
+
+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)
+
+<br/>
+
+## 7. Testing NKL NGINX Kubernetes Loadbalancer
 
 <br/>