Skip to content

Commit

Permalink
Merge pull request #246 from liangyuanpeng/update_readme
Browse files Browse the repository at this point in the history
Update README for cncf project and add chinese README
  • Loading branch information
ks-ci-bot committed Feb 25, 2022
2 parents ee156da + c019e0f commit 3687c2c
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 20 deletions.
28 changes: 8 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

![OpenELB Logo](./doc/logo/color-horizontal.svg)

OpenELB is an open-source load balancer implementation designed for exposing the LoadBalancer type of Kubernetes services in bare metal, edge, and virtualization environments.
[中文](README_zh.md)
OpenELB is an open-source load balancer implementation designed for exposing the LoadBalancer type of Kubernetes services in bare metal, edge, and virtualization environments.Hosted by [CNCF](https://www.cncf.io/) as a [Sandbox Project](https://www.cncf.io/sandbox-projects/)

## Why OpenELB

Expand All @@ -20,13 +21,13 @@ In cloud-based Kubernetes clusters, Services are usually exposed by using load b

## Quickstart

- [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/)
- [Install OpenELB on Kubernetes](https://openelb.github.io/docs/getting-started/installation/install-porter-on-kubernetes/)
- [Install OpenELB on K3s](https://openelb.github.io/docs/getting-started/installation/install-porter-on-k3s/)
- [Install OpenELB on KubeSphere](https://openelb.github.io/docs/getting-started/installation/install-porter-on-kubesphere/)

## Documentation

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

## Adopters

Expand All @@ -38,21 +39,8 @@ OpenELB has been adopted by [many companies](./ADOPTERS.md) all over the world.

## Support, Discussion and Contributing

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 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/>
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>

* 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.(openelb slack channel from kubernetes will be soon)
* You have code or documents for OpenELB? Contributions are always welcome! See [Building and Contributing](https://openelb.github.io/docs/building-and-contributing/) to obtain guidance.

## License

Expand Down
46 changes: 46 additions & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# OpenELB

![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/kubesphere/openelb) ![go report](https://goreportcard.com/badge/github.com/kubesphere/openelb)

![OpenELB Logo](./doc/logo/color-horizontal.svg)

OpenELB 是一个开源的负载均衡器实现,可以在裸金属服务器、边缘以及虚拟化环境中使用 LoadBalancer 类型的Service.目前作为[沙箱项目](https://www.cncf.io/sandbox-projects/)托管于[CNCF](https://www.cncf.io/).

## 为什么选择OpenELB

在云服务环境中的 Kubernetes 集群里,通常可以用云服务提供商提供的负载均衡服务来暴露 Service,但是在本地没办法这样操作.而 OpenELB 可以让用户在裸金属服务器、边缘以及虚拟化环境中创建 LoadBalancer 类型的 Service 来暴露服务,并且可以做到和云环境中的用户体验是一致的.

## 核心功能

- BGP 模式和二层网络模式下的负载均衡
- ECMP 路由和负载均衡
- IP 池管理
- 基于 CRD 来管理 BGP 配置
- 支持 Helm Chart 方式安装

## 快速入门

- [在 Kubernetes 中安装 OpenELB](https://openelb.github.io/docs/getting-started/installation/install-porter-on-kubernetes/)
- [在 K3s 中安装 OpenELB](https://openelb.github.io/docs/getting-started/installation/install-porter-on-k3s/)
- [在 KubeSphere 中安装 OpenELB](https://openelb.github.io/docs/getting-started/installation/install-porter-on-kubesphere/)

## 文档

您可以按照[OpenELB 文档](https://openelb.github.io/docs/)中的步骤来学习如何在云服务 K8S 中部署 OpenELB.

## 采用者

OpenELB 已经被采用在[很多公司](./ADOPTERS.md),如果您也正在使用 OpenELB,欢迎加入到用户社区并且把您的logo添加到[采用者列表](./ADOPTERS.md)!

## 开发计划

[OpenELB 开发计划](doc/roadmap.md)列出了每个里程碑下的功能以及bug修复,如果您有新的想法、功能需求或者建议,欢迎提交proposal.

## 参与贡献以及讨论

* 加入[KubeSphere Slack Channel](https://kubesphere.slack.com/join/shared_invite/enQtNTE3MDIxNzUxNzQ0LTZkNTdkYWNiYTVkMTM5ZThhODY1MjAyZmVlYWEwZmQ3ODQ1NmM1MGVkNWEzZTRhNzk0MzM5MmY4NDc3ZWVhMjE#/)来咨询问题或告诉我们您正在使用OpenELB.(很快将会有kubernetes下的slack channel)
* 欢迎任何文档完善以及代码贡献!具体可以看[贡献指南](https://openelb.github.io/docs/building-and-contributing/).

## License

OpenELB is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full license text.

0 comments on commit 3687c2c

Please sign in to comment.