Skip to content

Commit 5b8fe36

Browse files
committed
doc/diagram updates
1 parent a2e9e7a commit 5b8fe36

15 files changed

+429
-310
lines changed

README.md

+17-11
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,39 @@
1-
[![Go Report Card](https://goreportcard.com/badge/nginxinc/nginx-k8s-edge-controller)](https://goreportcard.com/report/nginxinc/nginx-k8s-edge-controller)
2-
31
# nginx-k8s-edge-controller
42

53
## Welcome to the Nginx Kubernetes Load Balancer project !
64

75
<br/>
86

9-
This repo contains source code and documents for a new Kubernetes Controller, that provides TCP load balancing external to a k8s cluster. It is a replacement for a Cloud Providers "Service Type Loadbalancer", that is missing from On Premises Kubernetes Clusters.
7+
This repo contains source code and documents for a new Kubernetes Controller, that provides TCP load balancing external to a Kubernetes Cluster running On Premises.
8+
9+
<br/>
10+
11+
>>**This is a replacement for a Cloud Providers "Service Type Loadbalancer", that is missing from On Premises Kubernetes Clusters.**
1012
1113
<br/>
1214

1315
## Overview
1416

15-
- Create a new K8s Controller, that will monitor specified k8s Service Endpoints, and then send API calls to an external NginxPlus server to manage Nginx Upstream server blocks.
16-
- This is will synchronize the K8s Service Endpoint list, with the Nginx LB server's Upstream block server list.
17+
- Create a new K8s Controller, that will monitor specified k8s Services, and then send API calls to an external Nginx Plus server to manage Nginx Upstream servers automatically.
18+
- This is will `synchronize` the K8s Service Endpoint list, with the Nginx LB server's Upstream server list.
1719
- The primary use case is for tracking the NodePort IP:Port definitions for the Nginx Ingress Controller's `nginx-ingress Service`.
18-
- With the NginxPlus Server located external to the K8s cluster, this new controller LB function would provide an alternative TCP "Load Balancer Service" for On Premises k8s clusters, which do not have access to a Cloud providers "Service Type LoadBalancer".
19-
- Make the solution a native Kubernetes Component, configured and managed with standard K8s tools.
20+
- With the Nginx Plus Server located external to the K8s cluster, this new controller LB function would provide an alternative TCP "Load Balancer Service" for On Premises K8s clusters, which do not have access to a Cloud providers "Service Type LoadBalancer".
21+
- Make the solution a native Kubernetes Component, running, configured and managed with standard K8s commands.
2022

2123
<br/>
2224

2325
## Reference Diagram
2426

2527
<br/>
2628

27-
![NGINX LB Server](docs/media/nginxlb-nklv1.png)
29+
![NGINX LB Server](docs/media/nginxlb-nklv2.png)
2830

2931
<br/>
3032

3133
## Sample Screenshots of Runtime
3234

35+
<br/>
36+
3337
### Configuration with 2 Nginx LB Servers defined (HA):
3438

3539
![NGINX LB ConfigMap](docs/media/nkl-pod-configmap.png)
@@ -46,23 +50,25 @@ Legend:
4650
- Indigo - nodeport and upstreams for https traffic
4751
- Green - logs for api calls to LB Server #1
4852
- Orange - Nginx LB Server upstream dashboard details
49-
- Kubernetes nodes are 10.1.1.8 and 10.1.1.10
53+
- Kubernetes Worker Nodes are 10.1.1.8 and 10.1.1.10
5054

5155
<br/>
5256

5357
## Requirements
5458

5559
Please see the /docs folder for detailed documentation.
5660

61+
<br/>
62+
5763
## Installation
5864

59-
Please see the /docs folder for detailed documentation.
65+
Please see the /docs folder for Installation Guide.
6066

6167
<br/>
6268

6369
## Development
6470

65-
No contributions are being accepted at this time.
71+
Contributions are being accepted at this time.
6672
Read the [`CONTRIBUTING.md`](https://github.com/nginxinc/nginx-k8s-edge-controller/blob/main/CONTRIBUTING.md) file.
6773

6874
<br/>

docs/Installation.md

-231
This file was deleted.

0 commit comments

Comments
 (0)