Skip to content

rename porterlb to openelb #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zheng1 merged 1 commit into from
Jul 7, 2021
Merged

rename porterlb to openelb #207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ADOPTERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
PorterLB has been adopted by many companies. If you are using PorterLB in your organization, welcome to join the end user community and add your logo to the list!
OpenELB has been adopted by many companies. If you are using OpenELB in your organization, welcome to join the end user community and add your logo to the list!


<img alt="Baiwang-580" width="150px" src="./doc/img/adopters/baiwang-580.png"><img alt="Benlai" width="150px" src="./doc/img/adopters/benlai.png">
Expand Down
1 change: 1 addition & 0 deletions OWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ reviewers:
- zheng1 #oncall
- duanjiong
- rayzhou2017
- feynmanzhou
37 changes: 17 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,62 +1,59 @@
![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/porterlb)
![go report](https://goreportcard.com/badge/github.com/kubesphere/openelb)

# PorterLB: Load Balancer Implementation for Bare Metal
# OpenELB: Load Balancer Implementation for Bare Metal

![logo](doc/img/porter-logo.png)
OpenELB is an open-source load balancer implementation designed for exposing the LoadBlancer type of Kubernetes services in bare metal, edge, and virtualization environments.
## Why OpenELB

PorterLB is an open-source load balancer implementation designed for bare-metal Kubernetes clusters.

## Why PorterLB

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. PorterLB allows users to create **LoadBalancer Services** in bare-metal environments for external access, and provides the same user experience as cloud-based load balancers.
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 or on-premise environments. OpenELB allows users to create **LoadBalancer Services** in bare-metal, egde, and virtualization environments for external access, and provides the same user experience as cloud-based load balancers.

## Core Features

- Load balancing in BGP mode and Layer 2 mode
- ECMP routing and load balancing
- IP address pool management
- BGP configuration using CRDs
- Installation using Helm and KubeSphere
- Installation using Helm Chart

## Quickstart

- [Install PorterLB on Kubernetes](https://porterlb.io/docs/getting-started/installation/install-porter-on-kubernetes/)
- [Install PorterLB on K3s](https://porterlb.io/docs/getting-started/installation/install-porter-on-k3s/)
- [Install PorterLB on KubeSphere](https://porterlb.io/docs/getting-started/installation/install-porter-on-kubesphere/)
- [Install OpenELB on Kubernetes](https://porterlb.io/docs/getting-started/installation/install-porter-on-kubernetes/)
- [Install OpenELB on K3s](https://porterlb.io/docs/getting-started/installation/install-porter-on-k3s/)
- [Install OpenELB on KubeSphere](https://porterlb.io/docs/getting-started/installation/install-porter-on-kubesphere/)

## Documentation

Without a bare-metal environment yet? Doesn't matter!

You can learn how to use PorterLB in a cloud-based Kubernetes cluster by following the [PorterLB Documentation](https://porterlb.io/docs/).
You can learn how to use OpenELB in a cloud-based Kubernetes cluster by following the [OpenELB Documentation](https://porterlb.io/docs/).

## Adopters

PorterLB has been adopted by [many companies](./ADOPTERS.md) all over the world. If you are using PorterLB in your organization, welcome to join the end user community and add your logo to the [list](./ADOPTERS.md)!
OpenELB has been adopted by [many companies](./ADOPTERS.md) all over the world. If you are using OpenELB in your organization, welcome to join the end user community and add your logo to the [list](./ADOPTERS.md)!

## Roadmap

[PorterLB Roadmap](doc/roadmap.md) lists the features and bug fixes for each milestone. If you have any new ideas, feature requests or suggestions, please submit a proposal.
[OpenELB Roadmap](doc/roadmap.md) lists the features and bug fixes for each milestone. If you have any new ideas, feature requests or suggestions, please submit a proposal.

## Support, Discussion and Contributing

PorterLB is a sub-project of [KubeSphere](https://github.com/kubesphere/kubesphere).
OpenELB is a sub-project of [KubeSphere](https://github.com/kubesphere/kubesphere).

* 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 PorterLB.
* You have code or documents for PorterLB? Contributions are always welcome! See [Building and Contributing](https://porterlb.io/docs/building-and-contributing/) to obtain guidance.
* 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 OpenELB.
* You have code or documents for OpenELB? Contributions are always welcome! See [Building and Contributing](https://porterlb.io/docs/building-and-contributing/) to obtain guidance.

## Landscapes

<p align="center">
<br/><br/>
<img src="https://landscape.cncf.io/images/left-logo.svg" width="150"/>&nbsp;&nbsp;<img src="https://landscape.cncf.io/images/right-logo.svg" width="200"/>&nbsp;&nbsp;
<br/><br/>
PorterLB is a promising newcomer in Service proxy, which enriches the <a href="https://landscape.cncf.io/landscape=observability-and-analysis&license=apache-license-2-0">CNCF CLOUD NATIVE Landscape.
OpenELB is a promising newcomer in Service proxy, which enriches the <a href="https://landscape.cncf.io/landscape=observability-and-analysis&license=apache-license-2-0">CNCF CLOUD NATIVE Landscape.
</a>
</p>


## License

PorterLB is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full license text.
OpenELB is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full license text.
4 changes: 2 additions & 2 deletions doc/roadmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ PorterLB Roadmap lists the features and Bugfix for each milestone.

| Edition | Schedule |
|---|---|
| Release v0.6.0| Oct, 2021 |
| Release v0.5.0| July, 2021 |
| Release v0.6.0| Nov, 2021 |
| Release v0.5.0| Aug, 2021 |
| Release v0.4.0| Mar, 2021 |
| Release v0.3.1| Aug, 2020 |
| Release v0.3.0| Aug, 2020 |
Expand Down