Skip to content

Commit

Permalink
Merge pull request #55 from Tencent/1.13.x
Browse files Browse the repository at this point in the history
英文版本readme调整
  • Loading branch information
DeveloperJim committed Jun 26, 2019
2 parents c502c99 + f62f472 commit bf46118
Show file tree
Hide file tree
Showing 3 changed files with 108 additions and 40 deletions.
3 changes: 2 additions & 1 deletion Makefile
Expand Up @@ -55,7 +55,8 @@ pre:
mkdir -p ${CONFPATH}
mkdir -p ${EXPORTPATH}
cp -R ./install/cmd/conf/* ${CONFPATH}/
cd ./vendor/github.com && ln -sf Sirupsen sirupsen && cd -
if [[ ! -d ./vendor/github.com/sirupsen ]]; then ln -sf ./vendor/github.com/Sirupsen ./vendor/github.com/sirupsen; fi
if [[ ! -d ./vendor/github.com/Sirupsen ]]; then ln -sf ./vendor/github.com/sirupsen ./vendor/github.com/Sirupsen; fi

api:pre
go build ${LDFLAG} -o ${BINARYPATH}/bcs-api ./bcs-services/bcs-api/main.go
Expand Down
73 changes: 34 additions & 39 deletions README.md
@@ -1,69 +1,64 @@
![蓝鲸容器管理平台.png](./docs/logo/bcs_zh.png)
![BCS.png](./docs/logo/logo_en.png)
---
[![license](https://img.shields.io/badge/license-mit-brightgreen.svg?style=flat)](https://github.com/Tencent/bk-bcs/blob/master/LICENSE)[![Release Version](https://img.shields.io/badge/release-1.12.x-brightgreen.svg)](https://github.com/Tencent/bk-bcs/releases) ![BK Pipelines Status](https://api.bkdevops.qq.com/process/api/external/pipelines/projects/bcs/p-95397dbecda4442795dd0125a33069cb/badge?X-DEVOPS-PROJECT-ID=bcs) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/bk-bcs/pulls)
蓝鲸容器管理平台(Blueking Container Service,简称BCS)是蓝鲸体系下,以容器技术为基础,为微服务业务提供编排管理的基础服务平台。
[![license](https://img.shields.io/badge/license-mit-brightgreen.svg?style=flat)](https://github.com/Tencent/bk-bcs/blob/master/LICENSE)[![Release Version](https://img.shields.io/badge/release-1.12.x-brightgreen.svg)](https://github.com/Tencent/bk-bcs/releases) ![BK Pipelines Status](https://api.bkdevops.qq.com/process/api/external/pipelines/projects/bcs/p-c03c759b697f494ab14e01018eccb052/badge?X-DEVOPS-PROJECT-ID=bcs) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/bk-bcs/pulls)

蓝鲸容器管理平台提供了基于原生k8s和mesos+bk-framework的双引擎驱动的容器编排方案,用户可以选择使用其中一种来编排自己的应用。其中k8s方式以社区方案为主,除提供原生功能支持外,还实现了原生k8s与蓝鲸体系的无缝结合,用户可以在蓝鲸体系下以与传统无差异的方式体验容器技术和k8s社区带来的便利。mesos+bk-framwork方案是蓝鲸为需要深度定制的用户准备的可进行二次开发的容器编排方案,如果你需要打造极具个性化,需要面向特殊应用场景的容器平台,mesos+bk-framework方案是不二选择。
[中文文档](./README_cn.md)

除编排方案外,蓝鲸容器管理平台还提供了无差异的服务治理方案,为业务提供服务注册与服务发现、负载均衡、DNS、流量代理等服务。
BlueKing Container Service (BCS) is a container management and orchestration platform for the micro-services under the BlueKing ecosystem.

本次开源的版本,与蓝鲸社区版中的蓝鲸容器管理平台版本保持一致并且同步更新。并且蓝鲸社区版内会有内置的SaaS对接蓝鲸容器管理平台,为用户提供容器编排的界面化操作。
BlueKing Container Service provides a two-engine-driven container orchestration scheme based on native Kubernetes and mesos `bk-framework`, and users can choose to either one of them to orchestrate their own applications. The Kubernetes method is mainly based on Kubernetes solution. In addition to providing native functional support, it also provides seamless integration between the native Kubernetes cluster and the BlueKing platform. Users can experience container technology with Kubernetes community edition in the BlueKing platform in a way that is indistinguishable and convenient. The mesos `bk-framwork` solution is a container orchestration program for BlueKing that capable of customization. If you need to create a highly personalized container platform for special application scenarios, the mesos `bk-framework` solution is a great choice.

In addition to the orchestration program, the BlueKing Container Service also provides an abstract service management solution to provide services such as load balancing, service registration, service discovery, DNS, and traffic proxies.

The open source version of the BlueKing Container Service is consistent with the BlueKing Community Edition and is updated synchronously. BlueKing Community Edition will have a built-in SaaS (Software As A Service) to communicate with BCS, this will provide users with interface to view container operations.

## Overview

* [架构设计](./docs/overview/architecture.md)
* [代码结构](./docs/overview/code_directory.md)
* [功能说明](./docs/overview/function.md)
* [Architecture Design](./docs/overview/architecture.md)
* [code structure](./docs/overview/code_directory.md)
* [Function Description](./docs/overview/function.md)

## Features

* 支持基于k8s和Mesos双引擎编排
* 支持多集群管理
* 支持插件化自定义编排调度策略
* 支持服务升级,扩缩容,滚动升级,蓝绿发布等
* 支持configmap,secret,磁盘卷挂载,共享盘挂载等
* 支持服务发现,域名解析,访问代理等基础服务治理方案
* 支持可扩展的资源配额定义
* 支持容器内IPC机制
* 支持多种容器网络方案
* Support for dual engine orchestration based on Kubernetes and Mesos
* Support multi-cluster management
* Support plug-in custom orchestration scheduling strategy
* Support service upgrade, expansion and expansion, rolling upgrade, blue/green deploy strategy, etc.
* Support configmap, secret, disk volume mount, shared disk mount, etc.
* Support basic service management solutions such as service discovery, domain name resolution, and access agents, etc
* Support for scalable resource quota definitions
* Support in-container IPC mechanism
* Support multiple container network solutions (CNI)

如果想了解以上功能的详细说明,请参考蓝鲸容器管理平台[白皮书](https://docs.bk.tencent.com/bcs/)
For a detailed description of the above features, please refer to the BlueKing Container Management Platform [white paper](https://docs.bk.tencent.com/bcs/)

## Getting Started

> 容器管理平台是蓝鲸智云社区版V5.1以上推出的产品,后台服务可以独立部署与使用。如果需要SaaS的支持,则需要与蓝鲸社区版软件配合使用。
> 目前社区版5.1在灰度内测中,若想体验,请填写问卷留下邮箱等信息,蓝鲸将在1-2个工作日通过邮箱方式,交付软件。感谢对蓝鲸的支持与理解。
> 问卷链接:[https://wj.qq.com/s2/3830461/a8bc/](https://wj.qq.com/s2/3830461/a8bc/)
> 蓝鲸社区版5.1完全开放下载时间为2019-07-05
* [下载与编译](docs/install/source_compile.md)
* [安装部署](docs/install/deploy-guide.md)
* [API使用说明](./docs/apidoc/api.md)
* [Download and Compile](docs/install/source_compile.md)
* [Installation Deployment](docs/install/deploy-guide.md)
* [API Usage Notes](./docs/apidoc/api.md)

## Version Plan

* [版本详情](./docs/version/README.md)
* [Version Details](./docs/version/README.md)

## Contributing

对于项目感兴趣,想一起贡献并完善项目请参阅[contributing](./CONTRIBUTING.md)

[腾讯开源激励计划](https://opensource.tencent.com/contribution) 鼓励开发者的参与和贡献,期待你的加入。
If you are interested in this project and want to contribute and improve the project together, please refer to [contributing](./CONTRIBUTING.md).
[Tencent Open Source Incentive Program](https://opensource.tencent.com/contribution) We encourage developers to participate and contribute, and look forward to your joining us.

## Support

* 参考bk-bcs[安装文档](docs/install/deploy-guide.md)
* 阅读 [源码](https://github.com/Tencent/bk-bcs)
* 阅读 [wiki](https://github.com/Tencent/bk-bcs/wiki) 或者寻求帮助
* 了解蓝鲸社区相关信息:蓝鲸社区版交流QQ群 495299374
* 直接反馈issue,我们会定期查看与答复
* Refer to `bk-bcs`[installation documentation](docs/install/deploy-guide.md)
* Read [source code](https://github.com/Tencent/bk-bcs)
* Read [wiki](https://github.com/Tencent/bk-bcs/wiki) or ask for help
* Learn about the BlueKing Community: QQ group 495299374
* Issues, we will check and reply regularly

## FAQ

[https://github.com/Tencent/bk-bcs/wiki/FAQ](https://github.com/Tencent/bk-bcs/wiki/FAQ)

## License

bk-bcs是基于MIT协议, 详细请参考[LICENSE](./LICENSE.TXT)
Bk-bcs is based on the MIT protocol. Please refer to [LICENSE](./LICENSE.TXT) for details.
72 changes: 72 additions & 0 deletions README_cn.md
@@ -0,0 +1,72 @@
![蓝鲸容器管理平台.png](./docs/logo/bcs_zh.png)
---
[![license](https://img.shields.io/badge/license-mit-brightgreen.svg?style=flat)](https://github.com/Tencent/bk-bcs/blob/master/LICENSE)[![Release Version](https://img.shields.io/badge/release-1.12.x-brightgreen.svg)](https://github.com/Tencent/bk-bcs/releases) ![BK Pipelines Status](https://api.bkdevops.qq.com/process/api/external/pipelines/projects/bcs/p-c03c759b697f494ab14e01018eccb052/badge?X-DEVOPS-PROJECT-ID=bcs) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/bk-bcs/pulls)

[EnglishDocs](./README.md)

蓝鲸容器管理平台(Blueking Container Service,简称BCS)是蓝鲸体系下,以容器技术为基础,为微服务业务提供编排管理的基础服务平台。

蓝鲸容器管理平台提供了基于原生k8s和mesos+bk-framework的双引擎驱动的容器编排方案,用户可以选择使用其中一种来编排自己的应用。其中k8s方式以社区方案为主,除提供原生功能支持外,还实现了原生k8s与蓝鲸体系的无缝结合,用户可以在蓝鲸体系下以与传统无差异的方式体验容器技术和k8s社区带来的便利。mesos+bk-framwork方案是蓝鲸为需要深度定制的用户准备的可进行二次开发的容器编排方案,如果你需要打造极具个性化,需要面向特殊应用场景的容器平台,mesos+bk-framework方案是不二选择。

除编排方案外,蓝鲸容器管理平台还提供了无差异的服务治理方案,为业务提供服务注册与服务发现、负载均衡、DNS、流量代理等服务。

本次开源的版本,与蓝鲸社区版中的蓝鲸容器管理平台版本保持一致并且同步更新。并且蓝鲸社区版内会有内置的SaaS对接蓝鲸容器管理平台,为用户提供容器编排的界面化操作。

## Overview

* [架构设计](./docs/overview/architecture.md)
* [代码结构](./docs/overview/code_directory.md)
* [功能说明](./docs/overview/function.md)

## Features

* 支持基于k8s和Mesos双引擎编排
* 支持多集群管理
* 支持插件化自定义编排调度策略
* 支持服务升级,扩缩容,滚动升级,蓝绿发布等
* 支持configmap,secret,磁盘卷挂载,共享盘挂载等
* 支持服务发现,域名解析,访问代理等基础服务治理方案
* 支持可扩展的资源配额定义
* 支持容器内IPC机制
* 支持多种容器网络方案

如果想了解以上功能的详细说明,请参考蓝鲸容器管理平台[白皮书](https://docs.bk.tencent.com/bcs/)

## Getting Started

> 容器管理平台是蓝鲸智云社区版V5.1以上推出的产品,后台服务可以独立部署与使用。如果需要SaaS的支持,则需要与蓝鲸社区版软件配合使用。
> 目前社区版5.1在灰度内测中,若想体验,请填写问卷留下邮箱等信息,蓝鲸将在1-2个工作日通过邮箱方式,交付软件。感谢对蓝鲸的支持与理解。
> 问卷链接:[https://wj.qq.com/s2/3830461/a8bc/](https://wj.qq.com/s2/3830461/a8bc/)
> 蓝鲸社区版5.1完全开放下载时间为2019-07-05
* [下载与编译](docs/install/source_compile.md)
* [安装部署](docs/install/deploy-guide.md)
* [API使用说明](./docs/apidoc/api.md)

## Version Plan

* [版本详情](./docs/version/README.md)

## Contributing

对于项目感兴趣,想一起贡献并完善项目请参阅[contributing](./CONTRIBUTING.md)

[腾讯开源激励计划](https://opensource.tencent.com/contribution) 鼓励开发者的参与和贡献,期待你的加入。

## Support

* 参考bk-bcs[安装文档](docs/install/deploy-guide.md)
* 阅读 [源码](https://github.com/Tencent/bk-bcs)
* 阅读 [wiki](https://github.com/Tencent/bk-bcs/wiki) 或者寻求帮助
* 了解蓝鲸社区相关信息:蓝鲸社区版交流QQ群 495299374
* 直接反馈issue,我们会定期查看与答复

## FAQ

[https://github.com/Tencent/bk-bcs/wiki/FAQ](https://github.com/Tencent/bk-bcs/wiki/FAQ)

## License

bk-bcs是基于MIT协议, 详细请参考[LICENSE](./LICENSE.TXT)

0 comments on commit bf46118

Please sign in to comment.