前言
众所周知Apollo是携程开源的配置中心,所以中文文档也比较完善,因此这里就不过多赘述细节了。本文的主要目的是记录下如何在CentOS8下分布式部署Apollo配置中心。Apollo的功能亮点:
- 统一管理不同环境、不同集群的配置
- 配置修改实时生效(热发布)
- 版本发布管理
- 灰度发布
- 权限管理、发布审核、操作审计
- 客户端配置信息监控
- 提供Java和.Net原生客户端
- 提供开放平台API
- 部署相对简单
- 中文文档完善
官方的分布式部署文档:
如果只是想在本地开发时快速搭建一个Apollo环境的话,参考官方的Quick Start即可:
准备工作
下图是Apollo架构模块的概览:
上图简要描述了Apollo的总体设计,我们可以从下往上看:
- Config Service提供配置的读取、推送等功能,服务对象是Apollo客户端
- Admin Service提供配置的修改、发布等功能,服务对象是Apollo Portal(管理界面)
- Config Service和Admin Service都是多实例、无状态部署,所以需要将自己注册到Eureka中并保持心跳
- 在Eureka之上我们架了一层Meta Server用于封装Eureka的服务发现接口
- Client通过域名访问Meta Server获取Config Service服务列表(IP+Port),而后直接通过IP+Port访问服务,同时在Client侧会做load balance、错误重试
- Portal通过域名访问Meta Server获取Admin Service服务列表(IP+Port),而后直接通过IP+Port访问服务,同时在Portal侧会做load balance、错误重试
- 为了简化部署,我们实际上会把Config Service、Eureka和Meta Server三个逻辑角色部署在同一个JVM进程中
因此,我们通常主要是部署两个节点负责不同的角色:ConfigServer(包含config service、admin service、meta server)节点和PortalServer节点。首先使用虚拟化软件创建两个CentOS8虚拟机,我这里用的是VMware:
- Config-Server的IP:192.168.243.159
- Portal-Server的IP:192.168.243.158
由于Apollo是基于Java的Spring Boot框架编写的,以及依赖了MySQL做数据存储。所以在这两台虚拟机上,我已经提前安装好了MySQL和JDK。
官方对运行时环境的要求是:
- Apollo服务端:JDK 1.8+
- Apollo客户端:JDK 1.7+
- MySQL:5.6.5+
- 建议OS:CentOS7
而我这里的运行时环境是:
- Apollo服务端:JDK 11
- Apollo客户端:JDK 11
- MySQL 8.0.18
- OS:CentOS8
如下:
[root@config-server ~]# java -version
java version "11.0.5" 2019-10-15 LTS
Java(TM) SE Runtime Environment 18.9 (build 11.0.5+10-LTS)
Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.5+10-LTS, mixed mode)
[root@config-server ~]# mysql --version
mysql Ver 8.0.18 for Linux on x86_64 (Source distribution)
[root@config-server ~]# cat /etc/redhat-release
CentOS Linux release 8.0.1905 (Core)
[root@config-server ~]#
创建数据库
完成准备工作后,第一步是创建相应的数据库。因为Apollo依赖于MySQL数据库,所以需要事先创建并完成库表的初始化。分布式部署Apollo服务需要将ApolloPortalDB
和ApolloConfigDB
两个数据库分别在不同的MySQL实例上创建。
当然,如果不需要分开管理的话,也可以在一个MySQL实例中创建。官方把数据库、表的创建和样例数据都分别准备了SQL文件,我们只需要导入数据库即可。SQL文件的地址如下:
需要注意的是ApolloPortalDB
只需要在生产环境部署一个即可,而ApolloConfigDB
需要在每个环境部署一套,如fat、uat和pro环境分别部署3套ApolloConfigDB
。我这里是在Config-Server和Portal-Server分别部署了一个MySQL实例。
将两个SQL文件分别导入两个数据库成功后,创建的数据库、表如下:
获取安装包
需要的安装包共有3个:
- apollo-configservice
- apollo-adminservice
- apollo-portal
可以直接下载官方提供的安装包,也可以自己通过源码构建。由于没有修改源码的需求,所以我这里直接下载安装包。下载地址见Github Releases。
复制下载链接在服务器上使用wget
命令下载或者在本地下载好后上传到服务器。config-server的安装包如下:
[root@config-server ~]# cd /usr/local/src
[root@config-server /usr/local/src]# ls
apollo-adminservice-1.7.1-github.zip apollo-configservice-1.7.1-github.zip
[root@config-server /usr/local/src]#
portal-server的安装包如下:
[root@portal-server ~]# cd /usr/local/src
[root@portal-server /usr/local/src]# ls
apollo-portal-1.7.1-github.zip
[root@portal-server /usr/local/src]#
部署Apollo Config Server
将压缩包,解压到合适的目录下:
[root@config-server /usr/local/src]# mkdir /usr/local/apollo-configservice
[root@config-server /usr/local/src]# unzip apollo-configservice-1.7.1-github.zip -d /usr/local/apollo-configservice
[root@config-server /usr/local/src]# mkdir /usr/local/apollo-adminservice
[root@config-server /usr/local/src]# unzip apollo-adminservice-1.7.1-github.zip -d /usr/local/apollo-adminservice/
[root@config-server /usr/local/src]# ls /usr/local/apollo-configservice
apollo-configservice-1.7.1.jar apollo-configservice-1.7.1-sources.jar apollo-configservice.conf config scripts
[root@config-server /usr/local/src]# ls /usr/local/apollo-adminservice/
apollo-adminservice-1.7.1.jar apollo-adminservice-1.7.1-sources.jar apollo-adminservice.conf config scripts
[root@config-server /usr/local/src]#
配置apollo-configservice的数据库连接信息:
[root@config-server /usr/local/src]# cd /usr/local/apollo-configservice/
[root@config-server /usr/local/apollo-configservice]# vim config/application-github.properties
# DataSource
spring.datasource.url = jdbc:mysql://localhost:3306/ApolloConfigDB?characterEncoding=utf8&serverTimezone=Asia/Shanghai&useSSL=false
spring.datasource.username = root
spring.datasource.password = 123456a.
- 填写正确的
ApolloConfigDB
数据库连接串信息,注意用户名和密码后面不要有空格!
配置apollo-adminservice的数据库连接信息:
[root@config-server /usr/local/apollo-configservice]# cd ../apollo-adminservice/
[root@config-server /usr/local/apollo-adminservice]# vim config/application-github.properties
# DataSource
spring.datasource.url = jdbc:mysql://localhost:3306/ApolloConfigDB?characterEncoding=utf8&serverTimezone=Asia/Shanghai&useSSL=false
spring.datasource.username = root
spring.datasource.password = 123456a.
- 填写正确的
ApolloConfigDB
数据库连接串信息,注意用户名和密码后面不要有空格!
如果需要调整apollo-configservice和apollo-adminservice的JVM启动参数、服务监听端口以及日志文件存放目录等配置,可以在其安装目录下的scripts/startup.sh
脚本中进行修改:
- 如果需要修改JVM参数,可以修改
scripts/startup.sh
的JAVA_OPTS
部分 - 如要调整服务的日志输出路径,可以修改
scripts/startup.sh
和apollo-configservice.conf
中的LOG_DIR
- 如要调整服务的监听端口,可以修改
scripts/startup.sh
中的SERVER_PORT
。另外由于apollo-configservice同时承担meta server职责,如果要修改端口,注意要同时修改ApolloConfigDB.ServerConfig
表中的eureka.service.url
配置项以及apollo-portal和apollo-client中的使用到的meta server信息
启动apollo-configservice:
[root@config-server /usr/local/apollo-configservice]# scripts/startup.sh
2020年 11月 10日 星期二 16:34:22 CST ==== Starting ====
Started [20958]
Waiting for server startup...
2020年 11月 10日 星期二 16:34:38 CST Server started in 15 seconds!
[root@config-server /usr/local/apollo-configservice]#
检查是否启动成功:
[root@config-server /usr/local/apollo-configservice]# jps
1655 apollo-configservice.jar
1807 Jps
[root@config-server /usr/local/apollo-configservice]# netstat -lntp |grep 8080
tcp6 0 0 :::8080 :::* LISTEN 1655/java
[root@config-server /usr/local/apollo-configservice]#
启动apollo-adminservice:
[root@config-server /usr/local/apollo-adminservice]# scripts/startup.sh
2020年 11月 10日 星期二 16:39:46 CST ==== Starting ====
Started [1886]
Waiting for server startup...
2020年 11月 10日 星期二 16:40:01 CST Server started in 15 seconds!
[root@config-server /usr/local/apollo-adminservice]#
检查是否启动成功:
[root@config-server /usr/local/apollo-adminservice]# jps
1655 apollo-configservice.jar
2012 Jps
1886 apollo-adminservice.jar
[root@config-server /usr/local/apollo-adminservice]# netstat -lntp |grep 8090
tcp6 0 0 :::8090 :::* LISTEN 1886/java
[root@config-server /usr/local/apollo-adminservice]#
若想要停止服务则是执行相应服务目录下的scripts/shutdown.sh
脚本即可。
部署Apollo Portal Server
与上一小节类似,将压缩包,解压到合适的目录下:
[root@portal-server /usr/local/src]# mkdir /usr/local/apollo-portal
[root@portal-server /usr/local/src]# unzip apollo-portal-1.7.1-github.zip -d /usr/local/apollo-portal/
[root@portal-server /usr/local/src]# ls /usr/local/apollo-portal/
apollo-portal-1.7.1.jar apollo-portal-1.7.1-sources.jar apollo-portal.conf config scripts
[root@portal-server /usr/local/src]#
配置apollo-portal的数据库连接信息:
[root@portal-server /usr/local/src]# cd /usr/local/apollo-portal/
[root@portal-server /usr/local/apollo-portal]# vim config/application-github.properties
# DataSource
spring.datasource.url = jdbc:mysql://localhost:3306/ApolloPortalDB?characterEncoding=utf8&serverTimezone=Asia/Shanghai&useSSL=false
spring.datasource.username = root
spring.datasource.password = 123456a.
然后就是配置apollo-portal的meta service信息。Apollo Portal需要在不同的环境访问不同的meta service(apollo-configservice)地址,所以我们需要在配置中提供这些信息。
默认情况下,meta service和config service是部署在同一个JVM进程,所以meta service的地址就是config service的地址。配置项的格式为${env}.meta=http://${config-service-url:port}
,如下所示:
[root@portal-server /usr/local/apollo-portal]# vim config/apollo-env.properties
dev.meta=http://192.168.243.159:8080
- 如果某个环境不需要,也可以直接删除对应的配置项,我这里是将默认的其他环境删除了,只配置了
dev.meta
除了通过apollo-env.properties
方式配置meta service以外,apollo也支持在运行时指定meta service(优先级比apollo-env.properties
高):
- 通过Java System Property
${env}_meta
指定
- 可以通过Java的System Property
${env}_meta
来指定 - 如
java -Ddev_meta=http://config-service-url -jar xxx.jar
- 也可以通过程序指定,如
System.setProperty("dev_meta", "http://config-service-url");
- 通过操作系统的System Environment
${ENV}_META
指定
- 如
DEV_META=http://config-service-url
- 注意key为全大写,且中间是“_”分隔
启动apollo-portal:
[root@portal-server /usr/local/apollo-portal]# scripts/startup.sh
2020年 11月 10日 星期二 16:56:36 CST ==== Starting ====
Started [21010]
Waiting for server startup........
2020年 11月 10日 星期二 16:57:17 CST Server started in 40 seconds!
[root@portal-server /usr/local/apollo-portal]#
检查是否启动成功:
[root@portal-server /usr/local/apollo-portal]# jps
21010 apollo-portal.jar
21162 Jps
[root@portal-server /usr/local/apollo-portal]# netstat -lntp |grep 8070
tcp6 0 0 :::8070 :::* LISTEN 21010/java
[root@portal-server /usr/local/apollo-portal]#
启动成功后,通过浏览器访问portal-server的8070端口:
- 默认用户名密码为:apollo/admin
登录成功后,进入首页:
然后可以进入示例项目中进行一些测试,看看是否正常可用:
至此我们就完成了Apollo的分布式部署,这里只是部署了一套环境,如果有多套环境,只需要重复部署Apollo Config Server小节的步骤部署多个Config Server节点即可。然后在Portal Server的apollo-env.properties
配置文件中配置好这些个Config Server节点的访问地址。