apollo(阿波罗) 分布式部署指南

• 一、准备工作
  • 1.1 运行时环境
  • 1.2 MySQL
  • 1.3 环境
  • 1.4 网络策略
• 二、部署步骤
  • 2.1 创建数据库
    • 2.1.1 创建ApolloPortalDB
    • 2.1.2 创建ApolloConfigDB
    • 2.1.3 调整服务端配置
  • 2.2 虚拟机/物理机部署
    • 2.2.1 获取安装包
    • 2.2.2 部署Apollo服务端
  • 2.3 Docker部署
  • 2.4 Kubernetes部署
    • 2.4.1 基于Kubernetes原生服务发现
    • 2.4.2 基于内置的Eureka服务发现
• 三、Portal 实现用户登录功能

一、准备工作

1.1 运行时环境

1.1.1 os

服务端基于Spring Boot，启动脚本理论上支持所有Linux发行版，建议CentOS 7。

1.1.2 java

• Apollo服务端：1.8+
• Apollo客户端：1.7+

由于需要同时运行服务端和客户端，所以建议安装Java 1.8+。

对于Apollo客户端，运行时环境只需要1.7+即可。

注：对于Apollo客户端，如果有需要的话，可以做少量代码修改来降级到Java 1.6，详细信息可以参考Issue 483

在配置好后，可以通过如下命令检查：

java -version

样例输出

java version "1.8.0_221"
Java(TM) SE Runtime Environment (build 1.8.0_221-b11)
Java HotSpot(TM) 64-Bit Server VM (build 25.221-b11, mixed mode)

1.2 mysql

• 版本要求：5.6.5+

Apollo的表结构对timestamp使用了多个default声明，所以需要5.6.5以上版本。

连接上MySQL后，可以通过如下命令检查：

show VARIABLES where Variable_name = 'version';

±--------------±-------+
| Variable_name | Value |
±--------------±-------+
| version | 5.7.32 |
±--------------±-------+

1.3 环境

分布式部署需要事先确定部署的环境以及部署方式。

Apollo目前支持以下环境：

• DEV
  • 开发环境
• FAT
  • 测试环境，相当于alpha环境(功能测试)
• UAT
  • 集成环境，相当于beta环境（回归测试）
• PRO
  • 生产环境

如果希望添加自定义的环境名称，具体步骤可以参考部署&开发遇到的常见问题#42-添加自定义的环境

以ctrip为例，我们的部署策略如下：

• Portal部署在生产环境的机房，通过它来直接管理FAT、UAT、PRO等环境的配置
• Meta Server、Config Service和Admin Service在每个环境都单独部署，使用独立的数据库
• Meta Server、Config Service和Admin Service在生产环境部署在两个机房，实现双活
• Meta Server和Config Service部署在同一个JVM进程内，Admin Service部署在同一台服务器的另一个JVM进程内

二、部署过程

部署步骤总体还是比较简单的，Apollo的唯一依赖是数据库，所以需要首先把数据库准备好，然后根据实际情况，选择不同的部署方式：

• 2.1 创建数据库
  • 2.1.1 创建ApolloPortalDB
  • 2.1.2 创建ApolloConfigDB
  • 2.1.3 调整服务端配置
• 2.2 虚拟机/物理机部署
  • 2.2.1 获取安装包
  • 2.2.2 部署Apollo服务端
• 2.3 Docker部署
• 2.4 Kubernetes部署

2.1 创建数据库

Apollo服务端共需要两个数据库：ApolloPortalDB和ApolloConfigDB，我们把数据库、表的创建和样例数据都分别准备了sql文件，只需要导入数据库即可。

需要注意的是ApolloPortalDB只需要在生产环境部署一个即可，而ApolloConfigDB需要在每个环境部署一套，如fat、uat和pro分别部署3套ApolloConfigDB。

注意：如果你本地已经创建过Apollo数据库，请注意备份数据。我们准备的sql文件会清空Apollo相关的表。

2.1.1.1 创建ApolloPortalDB

可以根据实际情况选择通过手动导入SQL或是通过Flyway自动导入SQL创建。

2.1.1.1 手动导入SQL创建

通过各种MySQL客户端导入apolloportaldb.sql即可。

以MySQL原生客户端为例：

source /your_local_path/scripts/sql/apolloportaldb.sql

2.1.1.2 通过Flyway导入SQL创建

需要1.3.0及以上版本

1. 根据实际情况修改flyway-portaldb.properties中的flyway.user、flyway.password和flyway.url配置
2. 在apollo项目根目录下执行mvn -N -Pportaldb flyway:migrate

2.1.1.3 验证

导入成功后，可以通过执行以下sql语句来验证：

SELECT `Id`, `Key`, `Value`, `Comment` from `ApolloPortalDB`.`ServerConfig` limit 1;

Id	Key	Value	Comment
1	apollo.portal.envs	dev	可支持的环境列表

注：ApolloPortalDB只需要在生产环境部署一个即可

2.1.2 创建ApolloConfigDB

可以根据实际情况选择通过手动导入SQL或是通过Flyway自动导入SQL创建。

2.1.2.1 手动导入SQL

通过各种MySQL客户端导入apolloconfigdb.sql即可。

以MySQL原生客户端为例：

source /your_local_path/scripts/sql/apolloconfigdb.sql

2.1.2.2 通过Flyway导入SQL

需要1.3.0及以上版本

1. 根据实际情况修改flyway-configdb.properties中的flyway.user、flyway.password和flyway.url配置
2. 在apollo项目根目录下执行mvn -N -Pconfigdb flyway:migrate

2.1.2.3 验证

导入成功后，可以通过执行以下sql语句来验证：

select `Id`, `Key`, `Value`, `Comment` from `ApolloConfigDB`.`ServerConfig` limit 1;

Id	Key	Value	Comment
1	eureka.service.url	http://127.0.0.1:8080/eureka/	Eureka服务Url，多个service以英文逗号分隔

注：ApolloConfigDB需要在每个环境部署一套，如fat、uat和pro分别部署3套ApolloConfigDB

2.2 虚拟机/物理机部署

2.2.1 获取安装包

可以通过两种方式获取安装包：

1. 直接下载安装包
   • 从GitHub Release页面下载预先打好的安装包
   • 如果对Apollo的代码没有定制需求，建议使用这种方式，可以省去本地打包的过程
2. 通过源码构建
   • 从GitHub Release页面下载Source code包或直接clone源码后在本地构建
   • 如果需要对Apollo的做定制开发，需要使用这种方式

2.2.1.1 直接下载安装包

2.2.1.1.1 获取apollo-configservice、apollo-adminservice、apollo-portal安装包

从GitHub Release页面下载最新版本的apollo-configservice-x.x.x-github.zip、apollo-adminservice-x.x.x-github.zip和apollo-portal-x.x.x-github.zip即可。

2.2.1.1.2 配置数据库连接信息

Apollo服务端需要知道如何连接到你前面创建的数据库，数据库连接串信息位于上一步下载的压缩包中的config/application-github.properties中。

2.2.1.1.2.1 配置apollo-configservice的数据库连接信息

1. 解压apollo-configservice-x.x.x-github.zip
2. 用程序员专用编辑器（如vim，notepad++，sublime等）打开config目录下的application-github.properties文件
3. 填写正确的ApolloConfigDB数据库连接串信息，注意用户名和密码后面不要有空格!
4. 修改完的效果如下：

# DataSource
spring.datasource.url = jdbc:mysql://localhost:3306/ApolloConfigDB?useSSL=false&characterEncoding=utf8
spring.datasource.username = someuser
spring.datasource.password = somepwd

注：由于ApolloConfigDB在每个环境都有部署，所以对不同的环境config-service需要配置对应环境的数据库参数

2.2.1.1.2.2 配置apollo-adminservice的数据库连接信息

1. 解压apollo-adminservice-x.x.x-github.zip
2. 用程序员专用编辑器（如vim，notepad++，sublime等）打开config目录下的application-github.properties文件
3. 填写正确的ApolloConfigDB数据库连接串信息，注意用户名和密码后面不要有空格!
4. 修改完的效果如下：

# DataSource
spring.datasource.url = jdbc:mysql://localhost:3306/ApolloConfigDB?useSSL=false&characterEncoding=utf8
spring.datasource.username = someuser
spring.datasource.password = somepwd

注：由于ApolloConfigDB在每个环境都有部署，所以对不同的环境admin-service需要配置对应环境的数据库参数

2.2.1.1.2.3 配置apollo-portal的数据库连接信息

1. 解压apollo-portal-x.x.x-github.zip
2. 用程序员专用编辑器（如vim，notepad++，sublime等）打开config目录下的application-github.properties文件
3. 填写正确的ApolloPortalDB数据库连接串信息，注意用户名和密码后面不要有空格!
4. 修改完的效果如下：

# DataSource
spring.datasource.url = jdbc:mysql://localhost:3306/ApolloPortalDB?useSSL=false&characterEncoding=utf8
spring.datasource.username = someuser
spring.datasource.password = somepwd

2.2.1.1.2.4 配置apollo-portal的meta service信息

Apollo Portal需要在不同的环境访问不同的meta service(apollo-configservice)地址，所以我们需要在配置中提供这些信息。默认情况下，meta service和config service是部署在同一个JVM进程，所以meta service的地址就是config service的地址。

对于1.6.0及以上版本，可以通过ApolloPortalDB.ServerConfig中的配置项来配置Meta Service地址，详见apollo.portal.meta.servers - 各环境Meta Service列表

使用程序员专用编辑器（如vim，notepad++，sublime等）打开apollo-portal-x.x.x-github.zip中config目录下的apollo-env.properties文件。