-
介绍
Apollo(阿波罗)是一款可靠的分布式配置管理中心,诞生于携程框架研发部,能够集中化管理应用不同环境、不同集群的配置,配置修改后能够实时推送到应用端,并且具备规范的权限、流程治理等特性,适用于微服务配置管理场景。
服务端基于Spring Boot和Spring Cloud开发,打包后可以直接运行,不需要额外安装Tomcat等应用容器。
-
安装
准备工作:
1、java版本
Apollo服务端:1.8+
Apollo客户端:1.8+
如需运行在 Java 1.7 运行时环境,请使用 1.x 版本的 apollo 客户端,如 1.9.1。
2、Mysql版本
版本要求:5.6.5+
3、下载 Quick Start安装包
GitHub - apolloconfig/apollo-quick-start: Apollo Quick Start
通过网盘链接下载,提取码: 9wwe
手动打包:Quick Start只针对本地测试使用,所以一般用户不需要自己下载源码打包,只需要下载已经打好的包即可。手动打包以参考如下步骤:
- 修改apollo-configservice, apollo-adminservice和apollo-portal的pom.xml,注释掉spring-boot-maven-plugin和maven-assembly-plugin
- 在根目录下执行
mvn clean package -pl apollo-assembly -am -DskipTests=true
- 复制apollo-assembly/target下的jar包,rename为apollo-all-in-one.jar
4、创建数据库
Apollo服务端共需要两个数据库:ApolloPortalDB
和ApolloConfigDB
,我们把数据库、表的创建和样例数据都分别准备了sql文件,只需要导入数据库即可。
Apollo服务端需要知道如何连接到你前面创建的数据库,所以需要编辑demo.sh,修改ApolloPortalDB和ApolloConfigDB相关的数据库连接串信息。
#apollo config db info
apollo_config_db_url="jdbc:mysql://localhost:3306/ApolloConfigDB?characterEncoding=utf8&serverTimezone=Asia/Shanghai"
apollo_config_db_username=用户名
apollo_config_db_password=密码(如果没有密码,留空即可)
# apollo portal db info
apollo_portal_db_url="jdbc:mysql://localhost:3306/ApolloPortalDB?characterEncoding=utf8&serverTimezone=Asia/Shanghai"
apollo_portal_db_username=用户名
apollo_portal_db_password=密码(如果没有密码,留空即可)
启动脚本:./demo.sh start。
另外需要注意的是Quick Start不支持增加环境,只有通过分布式部署才可以新增环境。
-
使用
打开
点击SampleApp进入配置界面,可以看到当前有一个配置timeout=100。
1、我们可以使用Demo客户端来演示从Apollo配置中心获取配置。程序很简单,就是用户输入一个key的名字,程序会输出这个key对应的值。运行./demo.sh client
启动Demo客户端:
> timeout
> [SimpleApolloConfigDemo] Loading key : timeout with value: 100
2、如果是maven项目,需要依赖apollo客户端的依赖。
运行命令,必需加入参数:
// id 是apollo 项目的appid,Denv是环境,dev_meta是dev环境的访问路径
// VM options:
-Dapp.id=apollo-quickstart -Denv=DEV -Ddev_meta=http://localhost:8080
然后可以在main方法中直接获取apollo的配置信息。
import com.ctrip.framework.apollo.Config;
import com.ctrip.framework.apollo.ConfigService
public static void main(String[] args){
Config appConfig = ConfigService.getAppConfig();
String value = appConfig.getProperty("timeout",null);
}
3、结合springboot项目
需要在application.properties中配置apollo
app.id = 项目appid
#启动apollo
apollo.bootstrap.enabled = true
#namespace,多个以“,”分隔
apollo.bootstrap.namespace = application,micro_service,
配置 apollo meta server
可以在 运行命令中,加上参数:-Dapollo.meta=http://localhost:8080
第二种可以在resources目录下新建apollo-env.properties文件种配置:
dev.meta=http://localhost:8080
在启动类中配置apollo注解,@EnableApolloConfig
通过@Value注解获取apollo上面发布的配置信息:通过${名称}的方式获取
-
总结
统一管理不同环境、不同集群的配置
- 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还提供了打包脚本,一键就可以生成所有需要的安装包,并且支持自定义运行时参数
代码:https://gitee.com/robots2/apollo
参考文档:https://www.apolloconfig.com/#/zh/README
入门视频: Apollo分布式配置实战课程