Written readme-en. (#165)

* Written readme-en. Signed-off-by: Patrick-LuoYu <[email protected]> * Fixed minor issues. Signed-off-by: Patrick-LuoYu <[email protected]>
openelb · Feb 8, 2021 · d91a370 · d91a370
1 parent 4055c34
commit d91a370
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 129 deletions.
diff --git a/README.md b/README.md
@@ -1,87 +1,36 @@
 ![GitHub version](https://img.shields.io/badge/version-v0.0.1-brightgreen.svg?logo=appveyor&longCache=true&style=flat)
 ![go report](https://goreportcard.com/badge/github.com/kubesphere/porter)
 
-# Porter
+# Porter: Load Balancer Implementation for Bare Metal
 
 ![logo](doc/img/porter-logo.png)
 
-> English | [中文](README_zh.md)
-
-## What is Porter
-
-[Porter](https://porter.kubesphere.io/) is an open source load balancer designed for bare metal Kubernetes clusters. It's implemented by physical switch, and uses BGP and ECMP to achieve the best performance and high availability.
+Porter is an open-source load balancer implementation designed for bare-metal Kubernetes clusters.
 
 ## Why Porter
 
-As we know, In the cloud-hosted Kubernetes cluster, the cloud providers (AWS, GCP, Azure, etc.) usually provide the Load Balancer to assign IPs and expose the service to outside.
-
-However, the service is hard to expose in a bare metal cluster since Kubernetes does not provide a load-balancer solution for bare metal environment. Fortunately, Porter allows you to create Kubernetes services of type "LoadBalancer" in bare metal clusters, which makes you have consistent experience with the cloud.
+In cloud-based Kubernetes clusters, services are usually exposed by using load balancers provided by cloud vendors. However, cloud-based load balancers are unavailable in bare-metal environments. Porter allows users to create LoadBalancer services in bare-metal environments for external access, and provides the same user experience as cloud-based load balancers.
 
 ## Core Features
 
-- ECMP routing load balancing
-- BGP dynamic routing configuration
-- EIP management
-- LoadBalancerIP assignment in Kubernetes services
-- Installation with Helm Chart
-- Dynamic BGP server configuration through CRD
-- Dynamic BGP peer configuration through CRD
-
-## Principle
-
-The following figure describes the principle of Porter. Assuming there is a distributed service deployed on node1 (192.168.0.2) and node2 (192.168.0.6). The service needs to be accessed through EIP `1.1.1.1`. After deploying the Example Service, Porter will automatically synchronize routing information to the leaf switch, and then synchronize to the spine and border switch, thus external users can access the service through EIP `1.1.1.1`.
-
-![node architecture](doc/img/node-arch.png)
-
-## Deployment Architecture
-
-Porter serves as a Load-Balancer plugin, monitoring the changes of the service in the cluster through a `Manager`, and advertises related routes. At the same time, all the nodes in the cluster are deployed with an agent. Each time an EIP is used, a host routing rule will be added to the host, diverting the IP packets sent to the EIP to the local.
-
-### Components
-
-Porter has two components:
-
-- LB Controller & Agent: The controller is responsible for synchronizing BGP routes to the physical switch; The agent is deployed to each node as DaemonSet to maintain the drainage rules;
-
-- EIP service, including the EIP pool management and EIP controller, the controller is responsible for dynamically updating the EIP information of the service.
+- BGP mode and Layer 2 mode
+- ECMP routing and load balancing
+- IP address pool management
+- BGP configuration using CRDs
+- Installation using Helm and KubeSphere
 
-![porter deployment](doc/img/porter-deployment.png)
-
-## Logic
-
-When Porter is deployed as a service in Kubernetes cluster, it establishes a BGP connection with the cluster's border router (Layer 3 switch). When a service with a specific annotation (e.g. `lb.kubesphere.io/v1apha1: porter`) has been created in the cluster, the service is dynamically assigned an EIP (users can also specify EIP by themselves). The LB controller creates a route and forwards the route to the public network (or private network) through BGP, so that the service can be accessed externally.
-
-The Porter LB controller is a custom controller based on the [Kubernetes controller runtime](https://github.com/kubernetes-sigs/controller-runtime), which automatically update the routing information by watching changes of the service.
-
-![porter architecture](doc/img/porter-arch.png)
-
-## Installation
-
-1. [Deploy Porter on Bare Metal Kubernetes Cluster](doc/deploy.md)
-2. [Test Porter with a Simulated Router](doc/simulate_with_bird.md)
-
-## Build
-
-See [How to Build Porter Project](doc/how-to-build.md) for more details.
-
-## Compared with MetalLB
+## Documentation
 
-Apparently, Porter is similar to MetalLB, both are service proxy, and they are designed for bare metal Kubernetes clusters as well.
+Without a bare-metal environment yet? Doesn't matter!
 
-### Pros
-- Support most BGP features and multiple network architectures.
-- A Kubernetes-friendly tool based on CRD-Controller that can be controlled entirely by kubectl.
-- The configuration file can be updated dynamically without any restart. BGP configurations are automatically updated based on the network environment. Various BGP features can be dynamically adopted.
-- Provide Passive mode and support DNAT.
-- Conflicts with Calico can be handled in a more friendly way.
+You can learn how to use Porter in a cloud-based Kubernetes cluster by following the [Porter Documentation](./doc/index.md).
 
-### Cons
-- Support Linux only.
+## Support, Discussion and Contributing
 
-## Documentation
+Porter is a sub-project of [KubeSphere](https://github.com/kubesphere/kubesphere).
 
-- [Porter Documentation (En)](doc)
-- [Porter Documentation (中)](doc/zh)
+* Join us at the [KubeSphere Slack Channel](https://kubesphere.slack.com/join/shared_invite/enQtNTE3MDIxNzUxNzQ0LTZkNTdkYWNiYTVkMTM5ZThhODY1MjAyZmVlYWEwZmQ3ODQ1NmM1MGVkNWEzZTRhNzk0MzM5MmY4NDc3ZWVhMjE#/) to get support or simply tell us that you are using Porter.
+* You have code or documents for Porter? We ❤️ all sorts of contributions! You can [build the Porter project](/doc/how-to-build.md) and send us pull requests.
 
 ## Landscapes
 
@@ -95,4 +44,4 @@ Porter is a promising newcomer in service proxy, which enriches the <a href="htt
 
 ## License
 
-**Porter** is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full license text.
+**Porter** is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full license text.
diff --git a/README_zh.md b/README_zh.md