NLB-6740 Updated the README doc

Updating the original NLK README to bring it in line with the latest architectural changes.

Author: arussellf5

README.md

@@ -1,3 +1,4 @@
+<!-- markdownlint-disable-next-line first-line-h1 -->
 [![CI](https://github.com/nginxinc/nginx-loadbalancer-kubernetes/actions/workflows/build-test.yml/badge.svg)](https://github.com/nginxinc/nginx-loadbalancer-kubernetess/actions/workflows/build-test.yml)
 [![Go Report Card](https://goreportcard.com/badge/github.com/nginxinc/nginx-loadbalancer-kubernetes)](https://goreportcard.com/report/github.com/nginxinc/nginx-loadbalancer-kubernetes)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -8,16 +9,13 @@
 [![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://github.com/nginxinc/nginx-loadbalancer-kubernetes/discussions)
 [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 
-
-
 <div style="margin-bottom: 5em;">
     <span>
         <img style="float: left;" src="nlk-logo.svg" width="124" />
         <h2 style="padding: 1.5em">nginx-loadbalancer-kubernetes</h2>
     </span>
 </div>
 
-
 The NGINX Loadbalancer for Kubernetes, or _NLK_, is a Kubernetes controller that provides TCP load balancing external to a Kubernetes cluster running on-premise.
 
 ## Requirements
@@ -70,7 +68,7 @@ NLK itself does not perform load balancing. Rather, NLK allows you to manage Ser
 There are few bits of administrivia to get out of the way before you can start leveraging NLK for your load balancing needs.
 
 As noted above, NLK is intended for when you have one or more Kubernetes clusters running on-premise. In addition to this,
-you need to have at least one NGINX Plus host running outside your cluster (Please refer to the [Roadmap](#Roadmap) for information about other load balancer servers).
+you need to have at least one NGINX Plus host running outside your cluster (Please refer to the [Roadmap](#roadmap) for information about other load balancer servers).
 
 ### Deployment
 
@@ -107,27 +105,27 @@ There is a much more detailed [Installation Reference](docs/README.md) available
 
 1. Clone this repo (optional, you can simply copy the `deployments/` directory)
 
-```git clone [email protected]:nginxinc/nginx-loadbalancer-kubernetes.git```
+    ```git clone [email protected]:nginxinc/nginx-loadbalancer-kubernetes.git```
 
-2. Apply the Namespace
+1. Apply the Namespace
 
-```kubectl apply -f deployments/deployment/namespace.yaml```
+    ```kubectl apply -f deployments/deployment/namespace.yaml```
 
-3. Apply the RBAC resources
+1. Apply the RBAC resources
 
-```./deployments/rbac/apply.sh```
+    ```./deployments/rbac/apply.sh```
 
-4. Update / Apply the ConfigMap (For best results update the `nginx-hosts` values first)
+1. Update / Apply the ConfigMap (For best results update the `nginx-hosts` values first)
 
-```kubectl apply -f deployments/deployment/configmap.yaml```
+    ```kubectl apply -f deployments/deployment/configmap.yaml```
 
-5. Apply the Deployment
+1. Apply the Deployment
 
-```kubectl apply -f deployments/deployment/deployment.yaml```
+    ```kubectl apply -f deployments/deployment/deployment.yaml```
 
-6. Check the logs
+1. Check the logs
 
-```kubectl -n nlk logs -f $(kubectl -n nlk get po -l "app=nlk" --no-headers -o custom-columns=":metadata.name")```
+    ```kubectl -n nlk logs -f $(kubectl -n nlk get po -l "app=nlk" --no-headers -o custom-columns=":metadata.name")```
 
 At this point NLK should be up and running. Now would be a great time to go over to the [Installation Reference](docs/README.md)
 and follow the instructions to deploy a demo application.
@@ -164,11 +162,10 @@ diverse ideas will be key to NLK becoming a solution that is useful to the commu
 when we are able to accept pull requests from the community.
 
 ## Authors
+
 - Chris Akker - Solutions Architect - Community and Alliances @ F5, Inc.
 - Steve Wagner - Solutions Architect - Community and Alliances @ F5, Inc.
 
-<br/>
-
 ## License
 
 [Apache License, Version 2.0](https://github.com/nginxinc/nginx-loadbalancer-kubernetes/blob/main/LICENSE)

docs/README.md

@@ -1,110 +1,78 @@
 # nginx-loadbalancer-kubernetes
 
-<br/>
-
-# Welcome to the Nginx LoadBalancer for Kubernetes Solution!
-
-<br/>
+## Welcome to the NGINX LoadBalancer for Kubernetes Solution
 
 ![Nginx K8s LB](media/nlk-logo.png) | ![Nginx K8s LB](media/nginx-2020.png)
 --- | ---
 
-<br/>
-
-This repo contains source code and documents for a new `Kubernetes Controller from Nginx`, that provides TCP and HTTP load balancing external to a Kubernetes Cluster running On Premises.
-
-<br/>
-
->>**This is a replacement for a Cloud Providers `Service Type Loadbalancer`, that is not available for On Premises Kubernetes Clusters.**
+This repo contains source code and documents for a `Kubernetes Controller from NGINX`, that provides TCP and HTTP load balancing external to a Kubernetes cluster running on premises.
 
-<br/>
-<br/>
+>>**This is a replacement for a cloud provider's `Service Type Loadbalancer`, that is not available for on premises Kubernetes clusters.**
 
+## Overview
 
-# Overview
-
-- `NLK - NGINX Loadbalancer for Kubernetes` is a new K8s Controller from Nginx, that monitors specified K8s Services, and then sends API calls to an external Nginx Plus server to manage Nginx Upstream servers dynamically.
-- This will `synchronize` the K8s Service Endpoint list, with the Nginx LB Server's upstream list.
-- The primary use case and Solution provided is for tracking the K8s` NodePort` IP:Port definitions for the Nginx Ingress Controller's `nginx-ingress Service`.
-- NLK is a native Kubernetes Controller, running, configured and managed with standard K8s commands.
-- NLK paired with the Nginx Plus Server located external to the K8s cluster, this new controller LB function will provide a `TCP Load Balancer Service` for On Premises K8s clusters, which do not have access to a Cloud providers "Service Type LoadBalancer".
-- NLK paired with the Nginx Plus Server located external to the Cluster, using Nginx's advanced HTTP features, provide an `HTTP Load Balancer Service` for Enterprise traffic management solutions, such as:
-    - MultiCluster Active/Active Load Balancing
-    - Horizontal Cluster Scaling
-    - HTTP Split Clients - for A/B, Blue/Green, and Canary test and production traffic steering.  Allows Cluster operations/maintainence like upgrades, patching, expansion and troubleshooting with no downtime or reloads
-    - Advanced TLS Processing - MutualTLS, OCSP, FIPS, dynamic cert loading
-    - Advanced Security features - Oauth, JWT, App Protect WAF Firewall, Rate and Bandwidth limits
-    - Nginx Java Script (NJS) for custom solutions
-    - Nginx Zone Sync of KeyVal data
-
-<br/>
+- `NLK - NGINX Loadbalancer for Kubernetes` is a Kubernetes controller from NGINX that monitors specified Kubernetes services, and then sends API calls to an external NGINX Plus server to manage NGINX Upstream servers dynamically.
+- This will `synchronize` the Kubernetes service's endpoints with the NGINX server's upstream list.
+- One use case is to track the`NodePort` IP:Port definitions for the NGINX Ingress Controller's `nginx-ingress Service`.
+- NLK is a native Kubernetes controller, running, configured and managed with standard Kubernetes commands.
+- When NLK is paired with the NGINX Plus Server located external to the Kubernetes cluster, this controller will provide a `TCP Load Balancer Service` for on premises Kubernetes clusters, which do not have access to a cloud provider's "Service Type LoadBalancer".
+- NLK paired with the NGINX Plus Server located external to the Cluster, using NGINX's advanced HTTP features, provides an `HTTP Load Balancer Service` for enterprise traffic management solutions, such as:
+  - MultiCluster Active/Active Load Balancing
+  - Horizontal Cluster Scaling
+  - HTTP Split Clients - for A/B, Blue/Green, and Canary test and production traffic steering.  Allows Cluster operations/maintainence like upgrades, patching, expansion and troubleshooting with no downtime or reloads
+  - Advanced TLS Processing - MutualTLS, OCSP, FIPS, dynamic cert loading
+  - Advanced Security features - Oauth, JWT, App Protect WAF Firewall, Rate and Bandwidth limits
+  - NGINX Java Script (NJS) for custom solutions
+  - NGINX Zone Sync of KeyVal data
 
 ## NLK Controller Software Design Overview - How it works
 
 [NLK Controller DESIGN and Architecture](DESIGN.md)
 
-<br/>
-
 ## Reference Diagram for NLK TCP Load Balancer Service
 
-<br/>
-
 ![NLK Stream Diagram](media/nlk-blog-diagram-v1.png)
 
-<br/>
-
 ## Sample Screenshots of Solution at Runtime
 
-<br/>
-
 ![NGINX LB ConfigMap](media/nlk-configmap.png)
-### ConfigMap with 2 Nginx LB Servers defined for HA
 
-<br/>
+### ConfigMap with 2 NGINX LB Servers defined for HA
 
 ![NGINX LB Create Nodeport](media/nlk-stream-create-nodeport.png)
-### Nginx LB Server Dashboard, NodePort, and NLK Controller Logging
 
-### Legend:
+### NGINX LB Server Dashboard, NodePort, and NLK Controller Logging
+
+### Legend
+
 - Red - kubectl nodeport commands
 - Blue - nodeport and upstreams for http traffic
 - Indigo - nodeport and upstreams for https traffic
 - Green - NLK log for api calls to LB Server #1
-- Orange - Nginx LB Server upstream dashboard details
+- Orange - NGINX LB Server upstream dashboard details
 - Kubernetes Worker Nodes are 10.1.1.8 and 10.1.1.10
 
-<br/>
-
 The `Installation Guide` for TCP Loadbalancer Solution is located in the tcp folder:
 
 [TCP Installation Guide](tcp/tcp-installation-guide.md)
 
-<br/>
-
 The `Installation Guide` for HTTP Loadbalancer Solution is located in the http folder:
 
 [HTTP Installation Guide](http/http-installation-guide.md)
 
-<br/>
-
 ## Requirements
 
 Please see the /docs folder and Installation Guides for detailed documentation.
 
-<br/>
-
 ## Development
 
 Read the [`CONTRIBUTING.md`](https://github.com/nginxinc/nginx-loadbalancer-kubernetes/blob/main/CONTRIBUTING.md) file.
 
-<br/>
-
 ## Authors
+
 - Chris Akker - Solutions Architect - Community and Alliances @ F5, Inc.
 - Steve Wagner - Solutions Architect - Community and Alliances @ F5, Inc.
 
-<br/>
-
 ## License
 
 [Apache License, Version 2.0](https://github.com/nginxinc/nginx-loadbalancer-kubernetes/blob/main/LICENSE)