Commit a0930872 by Jason Song Committed by GitHub

Update documentation

parent 1b3cb710
......@@ -12,27 +12,62 @@ Apollo
</a>
[![codecov.io](https://codecov.io/github/ctripcorp/apollo/coverage.svg?branch=master)](https://codecov.io/github/ctripcorp/apollo?branch=master)
[Project Site](http://ctripcorp.github.io/apollo/)
#Introduction
Apollo(阿波罗)是携程框架部门研发的配置管理平台,能够集中化管理应用不同环境、不同集群的配置,配置修改后能够实时推送到应用端,并且具备规范的权限、流程治理等特性。
Quickstart
----------
更多介绍参见[Apollo配置中心介绍](https://github.com/ctripcorp/apollo/wiki/Apollo%E9%85%8D%E7%BD%AE%E4%B8%AD%E5%BF%83%E4%BB%8B%E7%BB%8D)
Installation
------------
#Features
* **集中化管理不同环境、不同集群配置**
* Apollo提供了一个统一界面集中式管理不同环境(environment)、不同集群(cluster)、不同命名空间(namespace)的配置。
* 同一份代码部署在不同的集群,可以有不同的配置,比如zk的地址等
* 通过命名空间(namespace)可以很方便的支持多个不同应用共享同一份配置,同时还允许应用对共享的配置进行覆盖
Deployment
----------
* **客户端实时生效**
* 用户在Apollo修改完配置并发布后,客户端能实时(1秒)接收到最新的配置,并通知到应用程序。
Development
-----------
* **版本发布管理**
* 所有的配置发布都有版本概念,从而可以方便的支持配置的回滚。
Contribute
----------
* **灰度发布(开发中)**
* 支持配置的灰度发布,比如点了发布后,只对部分应用实例生效,等观察一段时间没问题后再推给所有应用实例。
- Source Code: https://github.com/ctripcorp/apollo
- Issue Tracker: https://github.com/ctripcorp/apollo/issues
* **授权、审核、审计**
* 应用和配置的管理都有完善的权限管理机制,对配置的管理还分为了编辑和发布两个环节,从而减少人为的错误。
* 所有的操作都有审计日志,可以方便的追踪问题。
License
-------
* **实例配置监控**
* 可以方便的看到配置在被哪些实例使用
The project is licensed under the Apache 2 license.
\ No newline at end of file
* **提供Java原生客户端**
* 提供了Java的原生客户端,方便应用集成
* 同时提供了Http接口,非Java应用也可以方便的使用
* **提供开放平台API**
* Apollo自身提供了比较完善的统一配置管理界面,支持多环境、多数据中心配置管理、权限、流程治理等特性。
* 不过Apollo出于通用性考虑,对配置的修改不会做过多限制,只要符合基本的格式就能够保存。
* 在我们的调研中发现,对于有些使用方,它们的配置可能会有比较复杂的格式,如xml, json,需要对格式做校验。
* 还有一些使用方如DAL,不仅有特定的格式,而且对输入的值也需要进行校验后方可保存,如检查数据库、用户名和密码是否匹配。
* 对于这类应用,Apollo支持应用方通过开放接口在Apollo进行配置的修改和发布,并且具备完善的授权和权限控制
#Usage
1. [应用接入指南](https://github.com/ctripcorp/apollo/wiki/%E5%BA%94%E7%94%A8%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97)
2. [Java客户端使用指南](https://github.com/ctripcorp/apollo/wiki/Java%E5%AE%A2%E6%88%B7%E7%AB%AF%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97)
3. [其它语言客户端接入指南](https://github.com/ctripcorp/apollo/wiki/%E5%85%B6%E5%AE%83%E8%AF%AD%E8%A8%80%E5%AE%A2%E6%88%B7%E7%AB%AF%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97)
#Design
* [Apollo配置中心设计](https://github.com/ctripcorp/apollo/wiki/Apollo%E9%85%8D%E7%BD%AE%E4%B8%AD%E5%BF%83%E8%AE%BE%E8%AE%A1)
#Deployment
* 本地启动Quickstart(敬请期待)
* 分布式部署指南(敬请期待)
#FAQ
* [常见问题回答](https://github.com/ctripcorp/apollo/wiki/FAQ)
#Contribution
* Source Code: https://github.com/ctripcorp/apollo
* Issue Tracker: https://github.com/ctripcorp/apollo/issues
#License
The project is licensed under the [Apache 2 license](https://github.com/ctripcorp/apollo/blob/master/LICENSE).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment