提交 01b5c2a0 编写于 作者: J Jason Song

add English version of readme

上级 de05540e
......@@ -8,129 +8,109 @@
[![codecov.io](https://codecov.io/github/ctripcorp/apollo/coverage.svg?branch=master)](https://codecov.io/github/ctripcorp/apollo?branch=master)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
Apollo(阿波罗)是携程框架部门研发的分布式配置中心,能够集中化管理应用不同环境、不同集群的配置,配置修改后能够实时推送到应用端,并且具备规范的权限、流程治理等特性,适用于微服务配置管理场景。
Apollo is a reliable configuration management system. It can centrally manage the configurations of different applications and different clusters. It is suitable for microservice configuration management scenarios.
服务端基于Spring Boot和Spring Cloud开发,打包后可以直接运行,不需要额外安装Tomcat等应用容器。
The server side is developed based on Spring Boot and Spring Cloud, which can simply run without the need to install additional application containers such as Tomcat.
Java客户端不依赖任何框架,能够运行于所有Java运行时环境,同时对Spring/Spring Boot环境也有较好的支持。
The Java SDK does not rely on any framework and can run in all Java runtime environments. It also has good support for Spring/Spring Boot environments.
.Net客户端不依赖任何框架,能够运行于所有.Net运行时环境。
The .Net SDK does not rely on any framework and can run in all .Net runtime environments.
更多产品介绍参见[Apollo配置中心介绍](https://ctripcorp.github.io/apollo/#/zh/design/apollo-introduction)
For more detials of the product introduction, please refer [Introduction to Apollo Configuration Center](https://ctripcorp.github.io/apollo/#/zh/design/apollo-introduction).
本地快速部署请参见[Quick Start](https://ctripcorp.github.io/apollo/#/zh/deployment/quick-start)
For local demo purpose, please refer [Quick Start](https://ctripcorp.github.io/apollo/#/zh/deployment/quick-start).
演示环境(Demo):
- [106.54.227.205](http://106.54.227.205/)
- 账号/密码:apollo/admin
> 如访问github速度缓慢,可以访问[gitee镜像](https://gitee.com/nobodyiam/apollo),不定期同步
Demo Environment:
- [http://106.54.227.205](http://106.54.227.205/)
- User/Password: apollo/admin
# Screenshots
![配置界面](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/apollo-home-screenshot.jpg)
![Screenshot](https://raw.githubusercontent.com/ctripcorp/apollo/master/docs/en/images/apollo-home-screenshot.jpg)
# Features
* **统一管理不同环境、不同集群的配置**
* Apollo提供了一个统一界面集中式管理不同环境(environment)、不同集群(cluster)、不同命名空间(namespace)的配置。
* 同一份代码部署在不同的集群,可以有不同的配置,比如zk的地址等
* 通过命名空间(namespace)可以很方便的支持多个不同应用共享同一份配置,同时还允许应用对共享的配置进行覆盖
* 配置界面支持多语言(中文,English)
* **配置修改实时生效(热发布)**
* 用户在Apollo修改完配置并发布后,客户端能实时(1秒)接收到最新的配置,并通知到应用程序。
* **版本发布管理**
* 所有的配置发布都有版本概念,从而可以方便的支持配置的回滚。
* **灰度发布**
* 支持配置的灰度发布,比如点了发布后,只对部分应用实例生效,等观察一段时间没问题后再推给所有应用实例。
* **权限管理、发布审核、操作审计**
* 应用和配置的管理都有完善的权限管理机制,对配置的管理还分为了编辑和发布两个环节,从而减少人为的错误。
* 所有的操作都有审计日志,可以方便的追踪问题。
* **客户端配置信息监控**
* 可以方便的看到配置在被哪些实例使用
* **提供Java和.Net原生客户端**
* 提供了Java和.Net的原生客户端,方便应用集成
* 支持Spring Placeholder,Annotation和Spring Boot的ConfigurationProperties,方便应用使用(需要Spring 3.1.1+)
* 同时提供了Http接口,非Java和.Net应用也可以方便的使用
* **提供开放平台API**
* Apollo自身提供了比较完善的统一配置管理界面,支持多环境、多数据中心配置管理、权限、流程治理等特性。
* 不过Apollo出于通用性考虑,对配置的修改不会做过多限制,只要符合基本的格式就能够保存。
* 在我们的调研中发现,对于有些使用方,它们的配置可能会有比较复杂的格式,如xml, json,需要对格式做校验。
* 还有一些使用方如DAL,不仅有特定的格式,而且对输入的值也需要进行校验后方可保存,如检查数据库、用户名和密码是否匹配。
* 对于这类应用,Apollo支持应用方通过开放接口在Apollo进行配置的修改和发布,并且具备完善的授权和权限控制
* **部署简单**
* 配置中心作为基础服务,可用性要求非常高,这就要求Apollo对外部依赖尽可能地少
* 目前唯一的外部依赖是MySQL,所以部署非常简单,只要安装好Java和MySQL就可以让Apollo跑起来
* Apollo还提供了打包脚本,一键就可以生成所有需要的安装包,并且支持自定义运行时参数
* **Unified management of the configurations of different environments and different clusters**
* Apollo provides a unified interface to centrally manage the configurations of different environments, different clusters, and different namespaces
* The same codebase could have different configurations when deployed in different clusters
* With the namespace concept, it is easy to support multiple applications to share the same configurations, while also allowing them to customize the configurations
* Multiple languages is provided in user interface (currently Chinese and English)
* **Configuration changes takes effect in real time (hot release)**
* After the user modified the configuration and released it in Apollo, the sdk will receive the latest configurations in real time (1 second) and notify the application
* **Release version management**
* Every configuration releases are versioned, which is friendly to support configuration rollback
* **Grayscale release**
* Support grayscale configuration release, for example, after clicking release, it will only take effect for some application instances. After a period of observation, we could push the configurations to all application instances if there is no problem
* **Authorization management, release approval and operation audit**
* Great authorization mechanism is designed for applications and configurations management, and the management of configurations is divided into two operations: editing and publishing, therefore greatly reducing human errors
* All operations have audit logs for easy tracking of problems
* **Client side configuration information monitoring**
* It's very easy to see which instances are using the configurations and what versions they are using
* **Rich SDKs available**
* Provides native sdks of Java and .Net to facilitate application integration
* Support Spring Placeholder, Annotation and Spring Boot ConfigurationProperties for easy application use (requires Spring 3.1.1+)
* Http APIs are provided, so non-Java and .Net applications can integrate conveniently
* Rich third party sdks are also available, e.g. Golang, Python, NodeJS, PHP, C, etc
* **Open platform API**
* Apollo itself provides a unified configuration management interface, which supports features such as multi-environment, multi-data center configuration management, permissions, and process governance
* However, for the sake of versatility, Apollo will not put too many restrictions on the modification of the configuration, as long as it conforms to the basic format, it can be saved.
* In our research, we found that for some users, their configurations may have more complicated formats, such as xml, json, and the format needs to be verified
* There are also some users such as DAL, which not only have a specific format, but also need to verify the entered value before saving, such as checking whether the database, username and password match
* For this type of application, Apollo allows the application to modify and release configurations through open APIs, which has great authorization and permission control mechanism built in
* **Simple deployment**
* As an infrastructure service, the configuration center has very high availability requirements, which forces Apollo to rely on external dependencies as little as possible
* Currently, the only external dependency is MySQL, so the deployment is very simple. Apollo can run as long as Java and MySQL are installed
* Apollo also provides a packaging script, which can generate all required installation packages with just one click, and supports customization of runtime parameters
# Usage
1. [应用接入指南](https://ctripcorp.github.io/apollo/#/zh/usage/apollo-user-guide)
2. [Java客户端使用指南](https://ctripcorp.github.io/apollo/#/zh/usage/java-sdk-user-guide)
3. [.Net客户端使用指南](https://ctripcorp.github.io/apollo/#/zh/usage/dotnet-sdk-user-guide)
4. [其它语言客户端接入指南](https://ctripcorp.github.io/apollo/#/zh/usage/other-language-client-user-guide)
5. [Apollo开放平台接入指南](https://ctripcorp.github.io/apollo/#/zh/usage/apollo-open-api-platform)
6. [Apollo使用场景和示例代码](https://github.com/ctripcorp/apollo-use-cases)
7. [Apollo实践案例](https://ctripcorp.github.io/apollo/#/zh/usage/apollo-user-practices)
8. [Apollo安全相关最佳实践](https://ctripcorp.github.io/apollo/#/zh/usage/apollo-user-guide?id=_71-%e5%ae%89%e5%85%a8%e7%9b%b8%e5%85%b3)
1. [Apollo User Guide](https://ctripcorp.github.io/apollo/#/zh/usage/apollo-user-guide)
2. [Java SDK User Guide](https://ctripcorp.github.io/apollo/#/zh/usage/java-sdk-user-guide)
3. [.Net SDK user Guide](https://ctripcorp.github.io/apollo/#/zh/usage/dotnet-sdk-user-guide)
4. [Third Party SDK User Guide](https://ctripcorp.github.io/apollo/#/zh/usage/third-party-sdks-user-guide)
5. [Other Language Client User Guide](https://ctripcorp.github.io/apollo/#/zh/usage/other-language-client-user-guide)
6. [Apollo Open APIs](https://ctripcorp.github.io/apollo/#/zh/usage/apollo-open-api-platform)
7. [Apollo Use Cases](https://github.com/ctripcorp/apollo-use-cases)
8. [Apollo User Practices](https://ctripcorp.github.io/apollo/#/zh/usage/apollo-user-practices)
9. [Apollo Security Best Practices](https://ctripcorp.github.io/apollo/#/zh/usage/apollo-user-guide?id=_71-%e5%ae%89%e5%85%a8%e7%9b%b8%e5%85%b3)
# Design
* [Apollo配置中心设计](https://ctripcorp.github.io/apollo/#/zh/design/apollo-design)
* [Apollo核心概念之“Namespace”](https://ctripcorp.github.io/apollo/#/zh/design/apollo-core-concept-namespace)
* [Apollo配置中心架构剖析](https://mp.weixin.qq.com/s/-hUaQPzfsl9Lm3IqQW3VDQ)
* [Apollo源码解析](http://www.iocoder.cn/categories/Apollo/)(据说Apollo非常适合作为初学者第一个通读源码学习的分布式中间件产品)
* [Apollo Design](https://ctripcorp.github.io/apollo/#/zh/design/apollo-design)
* [Apollo Core Concept - Namespace](https://ctripcorp.github.io/apollo/#/zh/design/apollo-core-concept-namespace)
* [Apollo Architecture Analysis](https://mp.weixin.qq.com/s/-hUaQPzfsl9Lm3IqQW3VDQ)
* [Apollo Source Code Explanation](http://www.iocoder.cn/categories/Apollo/)
# Development
* [Apollo开发指南](https://ctripcorp.github.io/apollo/#/zh/development/apollo-development-guide)
* [Apollo Development Guide](https://ctripcorp.github.io/apollo/#/zh/development/apollo-development-guide)
* Code Styles
* [Eclipse Code Style](https://github.com/ctripcorp/apollo/blob/master/apollo-buildtools/style/eclipse-java-google-style.xml)
* [Intellij Code Style](https://github.com/ctripcorp/apollo/blob/master/apollo-buildtools/style/intellij-java-google-style.xml)
# Deployment
* [Quick Start](https://ctripcorp.github.io/apollo/#/zh/deployment/quick-start)
* [分布式部署指南](https://ctripcorp.github.io/apollo/#/zh/deployment/distributed-deployment-guide)
* [Distributed Deployment Guide](https://ctripcorp.github.io/apollo/#/zh/deployment/distributed-deployment-guide)
# Release Notes
* [版本发布历史](https://github.com/ctripcorp/apollo/releases)
* [Releases](https://github.com/ctripcorp/apollo/releases)
# FAQ
* [常见问题回答](https://ctripcorp.github.io/apollo/#/zh/faq/faq)
* [部署&开发遇到的常见问题](https://ctripcorp.github.io/apollo/#/zh/faq/common-issues-in-deployment-and-development-phase)
* [FAQ](https://ctripcorp.github.io/apollo/#/zh/faq/faq)
* [Common Issues in Deployment & Development Phase](https://ctripcorp.github.io/apollo/#/zh/faq/common-issues-in-deployment-and-development-phase)
# Presentation
* [携程开源配置中心Apollo的设计与实现](http://www.itdks.com/dakalive/detail/3420)
* [Design and Implementation Details of Apollo](http://www.itdks.com/dakalive/detail/3420)
* [Slides](https://myslide.cn/slides/10168)
* [配置中心,让微服务更『智能』](https://2018.qconshanghai.com/presentation/799)
* [Configuration Center Makes Microservices Smart](https://2018.qconshanghai.com/presentation/799)
* [Slides](https://myslide.cn/slides/10035)
# Publication
* [开源配置中心Apollo的设计与实现](https://www.infoq.cn/article/open-source-configuration-center-apollo)
* [配置中心,让微服务更『智能』](https://mp.weixin.qq.com/s/iDmYJre_ULEIxuliu1EbIQ)
# Support
<table>
<thead>
<th>Apollo技术支持②群<br />群号:904287263(未满)</th>
<th>Apollo技术支持⑤群<br />群号:914839843(已满)</th>
<th>Apollo技术支持④群<br />群号:516773934(已满)</th>
<th>Apollo技术支持③群<br />群号:742035428(已满)</th>
<th>Apollo技术支持①群<br />群号:375526581(已满)</th>
</thead>
<tbody>
<tr>
<td><img src="https://raw.githubusercontent.com/ctripcorp/apollo-community/master/images/tech-support/tech-support-qq-2.png" alt="tech-support-qq-2"></td>
<td><img src="https://raw.githubusercontent.com/ctripcorp/apollo-community/master/images/tech-support/tech-support-qq-5.png" alt="tech-support-qq-5"></td>
<td><img src="https://raw.githubusercontent.com/ctripcorp/apollo-community/master/images/tech-support/tech-support-qq-4.png" alt="tech-support-qq-4"></td>
<td><img src="https://raw.githubusercontent.com/ctripcorp/apollo-community/master/images/tech-support/tech-support-qq-3.png" alt="tech-support-qq-3"></td>
<td><img src="https://raw.githubusercontent.com/ctripcorp/apollo-community/master/images/tech-support/tech-support-qq-1.png" alt="tech-support-qq-1"></td>
</tr>
</tbody>
</table>
* [Design and Implementation Details of Apollo](https://www.infoq.cn/article/open-source-configuration-center-apollo)
* [Configuration Center Makes Microservices Smart](https://mp.weixin.qq.com/s/iDmYJre_ULEIxuliu1EbIQ)
# Contribution
......@@ -145,7 +125,7 @@ The project is licensed under the [Apache 2 license](https://github.com/ctripcor
# Known Users
> 按照登记顺序排序,更多接入公司,欢迎在[https://github.com/ctripcorp/apollo/issues/451](https://github.com/ctripcorp/apollo/issues/451)登记(仅供开源用户参考)
> Sorted by registration order,users are welcome to register in [https://github.com/ctripcorp/apollo/issues/451](https://github.com/ctripcorp/apollo/issues/451) (reference purpose only for the community)
<table>
<tr>
......@@ -555,7 +535,7 @@ The project is licensed under the [Apache 2 license](https://github.com/ctripcor
# Awards
<img src="https://raw.githubusercontent.com/ctripcorp/apollo-community/master/images/awards/oschina-2018-award.jpg" width="240px" alt="2018 年度最受欢迎中国开源软件">
<img src="https://raw.githubusercontent.com/ctripcorp/apollo-community/master/images/awards/oschina-2018-award.jpg" width="240px" alt="The most popular Chinese open source software in 2018">
# Stargazers over time
......
English version documentation of Apollo
\ No newline at end of file
<img src="https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/logo/logo-simple.png" alt="apollo-logo" width="40%">
# Introduction
Apollo is a reliable configuration management system. It can centrally manage the configurations of different applications and different clusters. It is suitable for microservice configuration management scenarios.
The server side is developed based on Spring Boot and Spring Cloud, which can simply run without the need to install additional application containers such as Tomcat.
The Java SDK does not rely on any framework and can run in all Java runtime environments. It also has good support for Spring/Spring Boot environments.
The .Net SDK does not rely on any framework and can run in all .Net runtime environments.
For more detials of the product introduction, please refer [Introduction to Apollo Configuration Center](https://ctripcorp.github.io/apollo/#/zh/design/apollo-introduction).
For local demo purpose, please refer [Quick Start](https://ctripcorp.github.io/apollo/#/zh/deployment/quick-start).
Demo Environment:
- [http://106.54.227.205](http://106.54.227.205/)
- User/Password: apollo/admin
# Screenshots
![Screenshot](https://raw.githubusercontent.com/ctripcorp/apollo/master/docs/en/images/apollo-home-screenshot.jpg)
# Features
* **Unified management of the configurations of different environments and different clusters**
* Apollo provides a unified interface to centrally manage the configurations of different environments, different clusters, and different namespaces
* The same codebase could have different configurations when deployed in different clusters
* With the namespace concept, it is easy to support multiple applications to share the same configurations, while also allowing them to customize the configurations
* Multiple languages is provided in user interface (currently Chinese and English)
* **Configuration changes takes effect in real time (hot release)**
* After the user modified the configuration and released it in Apollo, the sdk will receive the latest configurations in real time (1 second) and notify the application
* **Release version management**
* Every configuration releases are versioned, which is friendly to support configuration rollback
* **Grayscale release**
* Support grayscale configuration release, for example, after clicking release, it will only take effect for some application instances. After a period of observation, we could push the configurations to all application instances if there is no problem
* **Authorization management, release approval and operation audit**
* Great authorization mechanism is designed for applications and configurations management, and the management of configurations is divided into two operations: editing and publishing, therefore greatly reducing human errors
* All operations have audit logs for easy tracking of problems
* **Client side configuration information monitoring**
* It's very easy to see which instances are using the configurations and what versions they are using
* **Rich SDKs available**
* Provides native sdks of Java and .Net to facilitate application integration
* Support Spring Placeholder, Annotation and Spring Boot ConfigurationProperties for easy application use (requires Spring 3.1.1+)
* Http APIs are provided, so non-Java and .Net applications can integrate conveniently
* Rich third party sdks are also available, e.g. Golang, Python, NodeJS, PHP, C, etc
* **Open platform API**
* Apollo itself provides a unified configuration management interface, which supports features such as multi-environment, multi-data center configuration management, permissions, and process governance
* However, for the sake of versatility, Apollo will not put too many restrictions on the modification of the configuration, as long as it conforms to the basic format, it can be saved.
* In our research, we found that for some users, their configurations may have more complicated formats, such as xml, json, and the format needs to be verified
* There are also some users such as DAL, which not only have a specific format, but also need to verify the entered value before saving, such as checking whether the database, username and password match
* For this type of application, Apollo allows the application to modify and release configurations through open APIs, which has great authorization and permission control mechanism built in
* **Simple deployment**
* As an infrastructure service, the configuration center has very high availability requirements, which forces Apollo to rely on external dependencies as little as possible
* Currently, the only external dependency is MySQL, so the deployment is very simple. Apollo can run as long as Java and MySQL are installed
* Apollo also provides a packaging script, which can generate all required installation packages with just one click, and supports customization of runtime parameters
# Usage
1. [Apollo User Guide](https://ctripcorp.github.io/apollo/#/zh/usage/apollo-user-guide)
2. [Java SDK User Guide](https://ctripcorp.github.io/apollo/#/zh/usage/java-sdk-user-guide)
3. [.Net SDK user Guide](https://ctripcorp.github.io/apollo/#/zh/usage/dotnet-sdk-user-guide)
4. [Third Party SDK User Guide](https://ctripcorp.github.io/apollo/#/zh/usage/third-party-sdks-user-guide)
5. [Other Language Client User Guide](https://ctripcorp.github.io/apollo/#/zh/usage/other-language-client-user-guide)
6. [Apollo Open APIs](https://ctripcorp.github.io/apollo/#/zh/usage/apollo-open-api-platform)
7. [Apollo Use Cases](https://github.com/ctripcorp/apollo-use-cases)
8. [Apollo User Practices](https://ctripcorp.github.io/apollo/#/zh/usage/apollo-user-practices)
9. [Apollo Security Best Practices](https://ctripcorp.github.io/apollo/#/zh/usage/apollo-user-guide?id=_71-%e5%ae%89%e5%85%a8%e7%9b%b8%e5%85%b3)
# Design
* [Apollo Design](https://ctripcorp.github.io/apollo/#/zh/design/apollo-design)
* [Apollo Core Concept - Namespace](https://ctripcorp.github.io/apollo/#/zh/design/apollo-core-concept-namespace)
* [Apollo Architecture Analysis](https://mp.weixin.qq.com/s/-hUaQPzfsl9Lm3IqQW3VDQ)
* [Apollo Source Code Explanation](http://www.iocoder.cn/categories/Apollo/)
# Development
* [Apollo Development Guide](https://ctripcorp.github.io/apollo/#/zh/development/apollo-development-guide)
* Code Styles
* [Eclipse Code Style](https://github.com/ctripcorp/apollo/blob/master/apollo-buildtools/style/eclipse-java-google-style.xml)
* [Intellij Code Style](https://github.com/ctripcorp/apollo/blob/master/apollo-buildtools/style/intellij-java-google-style.xml)
# Deployment
* [Quick Start](https://ctripcorp.github.io/apollo/#/zh/deployment/quick-start)
* [Distributed Deployment Guide](https://ctripcorp.github.io/apollo/#/zh/deployment/distributed-deployment-guide)
# Release Notes
* [Releases](https://github.com/ctripcorp/apollo/releases)
# FAQ
* [FAQ](https://ctripcorp.github.io/apollo/#/zh/faq/faq)
* [Common Issues in Deployment & Development Phase](https://ctripcorp.github.io/apollo/#/zh/faq/common-issues-in-deployment-and-development-phase)
# Presentation
* [Design and Implementation Details of Apollo](http://www.itdks.com/dakalive/detail/3420)
* [Slides](https://myslide.cn/slides/10168)
* [Configuration Center Makes Microservices Smart](https://2018.qconshanghai.com/presentation/799)
* [Slides](https://myslide.cn/slides/10035)
# Publication
* [Design and Implementation Details of Apollo](https://www.infoq.cn/article/open-source-configuration-center-apollo)
* [Configuration Center Makes Microservices Smart](https://mp.weixin.qq.com/s/iDmYJre_ULEIxuliu1EbIQ)
# Contribution
Please make sure to read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making a pull request.
Thanks for all the people who contributed to Apollo!
<a href="https://github.com/ctripcorp/apollo/graphs/contributors"><img src="https://opencollective.com/apollo/contributors.svg?width=880&button=false" /></a>
# License
The project is licensed under the [Apache 2 license](https://github.com/ctripcorp/apollo/blob/master/LICENSE).
- Getting started
- [Quick start](en/quick-start.md)
- [**Home**](en/README.md)
- [Releases](https://github.com/ctripcorp/apollo/releases)
\ No newline at end of file
此差异已折叠。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册