一、背景介绍
pollo(阿波罗)是携程框架部门研发的配置管理平台,能够集中化管理应用不同环境、不同集群的配置,配置修改后能够实时推送到应用端,并且具备规范的权限、流程治理等特性。
服务端基于 Spring Boot 和 Spring Cloud 开发,打包后可以直接运行,不需要额外安装 Tomcat 等应用容器。
Java 客户端不依赖任何框架,能够运行于所有 Java 运行时环境,同时对 Spring 环境也有较好的支持。
.Net 客户端不依赖任何框架,能够运行于所有 .Net 运行时环境。
本地快速部署请参见 Quick Start
二、配置界面
三、功能介绍
-
统一管理不同环境、不同集群的配置
-
Apollo 提供了一个统一界面集中式管理不同环境(environment)、不同集群(cluster)、不同命名空间(namespace)的配置。
-
同一份代码部署在不同的集群,可以有不同的配置,比如zk的地址等
-
通过命名空间(namespace)可以很方便的支持多个不同应用共享同一份配置,同时还允许应用对共享的配置进行覆盖
-
-
配置修改实时生效(热发布)
- 用户在 Apollo 修改完配置并发布后,客户端能实时(1秒)接收到最新的配置,并通知到应用程序。
-
版本发布管理
- 所有的配置发布都有版本概念,从而可以方便的支持配置的回滚。
-
灰度发布
- 支持配置的灰度发布,比如点了发布后,只对部分应用实例生效,等观察一段时间没问题后再推给所有应用实例。
-
权限管理、发布审核、操作审计
-
应用和配置的管理都有完善的权限管理机制,对配置的管理还分为了编辑和发布两个环节,从而减少人为的错误。
-
所有的操作都有审计日志,可以方便的追踪问题。
-
-
客户端配置信息监控
- 可以方便的看到配置在被哪些实例使用
-
提供Java和.Net原生客户端
-
提供了 Java 和 .Net 的原生客户端,方便应用集成
-
支持 Spring Placeholder 和 Annotation,方便应用使用(需要 Spring 3.1.1+)
-
同时提供了 Http 接口,非 Java 和 .Net 应用也可以方便的使用
-
-
提供开放平台 API
-
Apollo 自身提供了比较完善的统一配置管理界面,支持多环境、多数据中心配置管理、权限、流程治理等特性。
-
不过 Apollo 出于通用性考虑,对配置的修改不会做过多限制,只要符合基本的格式就能够保存。
-
在我们的调研中发现,对于有些使用方,它们的配置可能会有比较复杂的格式,如 xml, json,需要对格式做校验。
-
还有一些使用方如 DAL,不仅有特定的格式,而且对输入的值也需要进行校验后方可保存,如检查数据库、用户名和密码是否匹配。
-
对于这类应用,Apollo 支持应用方通过开放接口在 Apollo 进行配置的修改和发布,并且具备完善的授权和权限控制
-
-
部署简单
-
配置中心作为基础服务,可用性要求非常高,这就要求 Apollo 对外部依赖尽可能地少
-
目前唯一的外部依赖是 MySQL,所以部署非常简单,只要安装好 Java 和 MySQL 就可以让 Apollo 跑起来
-
Apollo 还提供了打包脚本,一键就可以生成所有需要的安装包,并且支持自定义运行时参数
-
四、使用文档
五、设计
六、部署
七、发布历史
八、FAQ
九、安装部署
apollo 依赖环境
java 1.8.2+
mysql 5.7+
为此我们准备2台服务器
10.3.1.141
主要部署服务
mysql
docker run -d -it -p 3306:3306 --name mysql -v /etc/mysql/:/etc/cd/conf.d -v /data/mysql/logs:/logs -v /data/mysql/data:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=123456 --restart always mysql:5.7
初始化数据库脚本
下载脚本 https://github.com/ctripcorp/apollo/tree/master/scripts/sql
执行脚本 apolloconfigdb.sql apolloportaldb.sql
修改环境列表
apollo-adminservice
docker run -d --name apollo-adminservice --net=host --restart always -v /tmp/logs:/opt/logs -e SPRING_DATASOURCE_URL="jdbc:mysql://10.3.1.141:3306/ApolloConfigDB_Dev?characterEncoding=utf8&serverTimezone=GMT&useSSL=false" -e SPRING_DATASOURCE_USERNAME=root -e SPRING_DATASOURCE_PASSWORD=123456 -e EVN=dev apolloconfig/apollo-adminservice
apollo-configserver
docker run -d --name apollo-configservice --net=host --restart always -v /tmp/logs:/opt/logs -e SPRING_DATASOURCE_URL="jdbc:mysql://10.3.1.141:3306/ApolloConfigDB_Dev?characterEncoding=utf8&serverTimezone=GMT&useSSL=false" -e SPRING_DATASOURCE_USERNAME=root -e SPRING_DATASOURCE_PASSWORD=123456 -e EVN=dev apolloconfig/apollo-configservice
apollo-protal
docker run -d --name apollo-adminservice --net=host --restart always -v /tmp/logs:/opt/logs -e SPRING_DATASOURCE_URL="jdbc:mysql://10.3.1.141:3306/ApolloConfigDB_Dev?characterEncoding=utf8&serverTimezone=GMT&useSSL=false" -e SPRING_DATASOURCE_USERNAME=root -e SPRING_DATASOURCE_PASSWORD=123456 -e EVN=dev apolloconfig/apollo-adminservice
10.3.1.184
主要部署服务
apollo-configserver
docker run -d --name apollo-configservice --net=host --restart always -v /tmp/logs:/opt/logs -e SPRING_DATASOURCE_URL="jdbc:mysql://10.3.1.141:3306/ApolloConfigDB_Pro?characterEncoding=utf8&serverTimezone=GMT&useSSL=false" -e SPRING_DATASOURCE_USERNAME=root -e SPRING_DATASOURCE_PASSWORD=123456 -e EVN=pro apolloconfig/apollo-configservice
apollo-adminservice
docker run -d --name apollo-adminservice --net=host --restart always -v /tmp/logs:/opt/logs -e SPRING_DATASOURCE_URL="jdbc:mysql://10.3.1.141:3306/ApolloConfigDB_Pro?characterEncoding=utf8&serverTimezone=GMT&useSSL=false" -e SPRING_DATASOURCE_USERNAME=root -e SPRING_DATASOURCE_PASSWORD=123456 -e EVN=pro apolloconfig/apollo-adminservice
九、.net core 配置使用
依赖携程包
Install-Package Com.Ctrip.Framework.Apollo.Configuration
修改配置文件
"Apollo": { "AppId": "libra", "Env": "DEV", "MetaServer": "http://10.3.1.141:8080", "ConfigServer": [ "http://10.3.1.141:8080" ] }
注入服务
public static IHostBuilder CreateHostBuilder(string[] args) => Microsoft.Extensions.Hosting.Host.CreateDefaultBuilder(args) .ConfigureAppConfiguration((hostingContext, builder) => { LogManager.UseConsoleLogging(LogLevel.Trace); builder.AddApollo(builder.Build().GetSection("Apollo")) .AddDefault() .AddNamespace("TEST1.vb") .AddNamespace("op", Com.Ctrip.Framework.Apollo.Enums.ConfigFileFormat.Json); }) .ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); });
public void ConfigureServices(IServiceCollection services) { services.Configure<ApolloConfig>(Configuration); services.AddControllers(); }
编写测试代码
[ApiController] [Route("[controller]")] public class HomeController : ControllerBase { private readonly IOptionsSnapshot<ApolloConfig> _options; public HomeController(IOptionsSnapshot<ApolloConfig> options) { _options = options; } [HttpGet] public IActionResult Index() { var options = new JsonSerializerOptions { Encoder = JavaScriptEncoder.Create(UnicodeRanges.All) }; return new JsonResult(_options.Value, options); } }
public class ApolloConfig { public string Name { get; set; } public string Gender { get; set; } }