apollo搭建、自定义环境

在搭建使用过程中也是遇到各种问题，特写下此文章记录一下，也希望给予看到这篇文章的小伙伴一丝帮助。

1. 搭建

1.1 环境要求

mysql: 5.6.5+
java: 1.8+

1.2 两种搭建方式

1.2.1 Quick Start

apollo服务端共需两个数据库：ApolloPortalDB和ApolloConfigDB

  • 执行 .../代码目录/sql/两个sql文件 apolloportaldb.sql和apolloconfigdb.sql
  • 配置数据库连接信息
    编辑demo.sh文件
#!/bin/bash
# apollo config db info
apollo_config_db_url=jdbc:mysql://localhost:3307/ApolloConfigDB?characterEncoding=utf8
apollo_config_db_username=root
apollo_config_db_password=        //（如果没有密码，留空即可）

# apollo portal db info
apollo_portal_db_url=jdbc:mysql://localhost:3307/ApolloPortalDB?characterEncoding=utf8
apollo_portal_db_username=root
apollo_portal_db_password=
...
  • 执行启动脚本
    启动会占用8070, 8080, 8090端口，请确保这3个端口当前没有被使用。
    执行./demo.sh start 注：//windows用户可以右键空白处 git bash here 运行 sh ./demo.sh 命令运行
    当看到如下日志就说明成功了
==== starting service ====
Service logging file is ./service/apollo-service.log
Started [10768]
Waiting for config service startup.......
Config service started. You may visit http://localhost:8080 for service status now!
Waiting for admin service startup....
Admin service started
==== starting portal ====
Portal logging file is ./portal/apollo-portal.log
Started [10846]
Waiting for portal startup......
Portal started. You can visit http://localhost:8070 now!

如果启动遇到了异常，可以分别查看service和portal目录下的log文件排查问题。
（1.2.1 Quick Start 方式搭建好像是不能修改端口的，修改后不能正常启动 o(╥﹏╥)o ）

1.2.2 使用源码构建

  • GitHub下载： https://github.com/ctripcorp/apollo/releases

  • 创建数据库同上

  • 若apollo不满足你的需求，需修改apollo源码，请执行如下步骤
    a) GitHub下载： https://github.com/ctripcorp/apollo ；
    b) 根据你的需求修改源码；
    c) 运行 scripts/build.sh 文件，windows运行 build.bat 文件。运行完成之后每个模块下 target 目录会生成 xxx-版本号-github.zip 的文件；
    d) 取出 apollo-adminservice-xxx-github.zip、apollo-configservice-xxx-github.zip、apollo-portal-xxx-github.zip ，即上面下载的zip。

  • 修改配置
    解压下载的或者build的三个zip文件，得到adminservice、configservice、portal 文件夹
    a) adminservice
    i) 修改端口号：adminservice/scripts/startup.sh SERVER_PORT=7030

#!/bin/bash 
SERVICE_NAME=apollo-adminservice
## Adjust log dir if necessary
LOG_DIR=/opt/logs/100003172
## Adjust server port if necessary
SERVER_PORT=7030
## Create log directory if not existed because JDK 8+ won't do that

ii) 修改数据库连接： adminservice/config/application-github.properties

# DataSource
spring.datasource.url = jdbc:mysql://localhost:3307/ApolloConfigDB?characterEncoding=utf8
spring.datasource.username = root
spring.datasource.password =

b) configservice
i) 修改端口号：configservice/scripts/startup.sh SERVER_PORT=7020

#!/bin/bash 
SERVICE_NAME=apollo-configservice
## Adjust log dir if necessary
LOG_DIR=/opt/logs/100003172
## Adjust server port if necessary
SERVER_PORT=7020
## Create log directory if not existed because JDK 8+ won't do that

ii) 修改数据库连接： configservice/config/application-github.properties

# DataSource
spring.datasource.url = jdbc:mysql://localhost:3307/ApolloConfigDB?characterEncoding=utf8
spring.datasource.username = root
spring.datasource.password =

c) portal
i) 修改端口号： portal/scripts/startup.sh SERVER_PORT=7010

#!/bin/bash
SERVICE_NAME=apollo-portal
## Adjust log dir if necessary
LOG_DIR=/opt/logs/100003173
## Adjust server port if necessary
SERVER_PORT=7010
## Create log directory if not existed because JDK 8+ won't do that

ii) 修改数据库连接： portal/config/application-github.properties

# DataSource
spring.datasource.url = jdbc:mysql://localhost:3307/ApolloPortalDB?characterEncoding=utf8
spring.datasource.username = root
spring.datasource.password =

iii) 配置环境列表端口 portal/config/apollo-env.properties

local.meta=http://localhost:8080
dev.meta=http://localhost:7020
#fat.meta=http://localhost:7020
#uat.meta=http://localhost:7020
#lpt.meta=${lpt_meta}
#pro.meta=http://localhost:7020

2. 部署

  • 运行刚修改的三个 startup.sh 脚本，顺序无所谓；
  • 访问 http://localhost:7010 即可进入apollo portal登录页；
  • 每次启动停止都要运行三个脚本，着实麻烦，可以写个简单的脚本，一次性启动停止所有服务；
    启动
#!/bin/sh
echo "==== 启动开发环境apollo服务 ===="

/home/zhanhao/service/apollo1.4/dev/configservice/scripts/startup.sh
/home/zhanhao/service/apollo1.4/dev/adminservice/scripts/startup.sh

echo "==== 启动sit环境apollo服务 ===="
/home/zhanhao/service/apollo1.4/sit/configservice/scripts/startup.sh
/home/zhanhao/service/apollo1.4/sit/adminservice/scripts/startup.sh
echo "==== 启动uat环境apollo服务 ===="
/home/zhanhao/service/apollo1.4/uat/configservice/scripts/startup.sh
/home/zhanhao/service/apollo1.4/uat/adminservice/scripts/startup.sh

echo "==== 启动portal apollo服务 ===="
/home/zhanhao/service/apollo1.4/portal/scripts/startup.sh

停止

#!/bin/sh
  
echo "==== Stopping Apollo Service ===="
/home/zhanhao/service/apollo1.4/portal/scripts/shutdown.sh
/home/zhanhao/service/apollo1.4/dev/adminservice/scripts/shutdown.sh
/home/zhanhao/service/apollo1.4/dev/configservice/scripts/shutdown.sh
/home/zhanhao/service/apollo1.4/sit/adminservice/scripts/shutdown.sh
/home/zhanhao/service/apollo1.4/sit/configservice/scripts/shutdown.sh
/home/zhanhao/service/apollo1.4/uat/adminservice/scripts/shutdown.sh
/home/zhanhao/service/apollo1.4/uat/configservice/scripts/shutdown.sh
echo "==== All apollo Service Stoped ===="

3. 自定义添加环境

  • 效果如下：


    多个环境

3.1 创建数据库

  • 导入三份 apolloconfigdb.sql 并命名为 ApolloConfigDB，ApolloConfigDB_SIT， ApolloConfigDB_UAT
  • 修改ServiceConfig 表，eureka.service.url 指向自己的Eureka地址
dev
sit

uat
  • 修改ApolloPortalDB ServiceConfig apollo.portal.envs 配置 dev,uat,sit
    portal

3.2 修改每个环境端口号及数据库连接

3.2.1 DEV

a) adminservice
i) 修改端口号：adminservice/scripts/startup.sh SERVER_PORT=7030

#!/bin/bash 
SERVICE_NAME=apollo-adminservice
## Adjust log dir if necessary
LOG_DIR=/opt/logs/100003172
## Adjust server port if necessary
SERVER_PORT=7030
## Create log directory if not existed because JDK 8+ won't do that

ii) 修改数据库连接： adminservice/config/application-github.properties

# DataSource
spring.datasource.url = jdbc:mysql://localhost:3307/ApolloConfigDB?characterEncoding=utf8
spring.datasource.username = root
spring.datasource.password =

b) configservice
i) 修改端口号：configservice/scripts/startup.sh SERVER_PORT=7020

#!/bin/bash 
SERVICE_NAME=apollo-configservice
## Adjust log dir if necessary
LOG_DIR=/opt/logs/100003172
## Adjust server port if necessary
SERVER_PORT=7020
## Create log directory if not existed because JDK 8+ won't do that

ii) 修改数据库连接： configservice/config/application-github.properties

# DataSource
spring.datasource.url = jdbc:mysql://localhost:3307/ApolloConfigDB?characterEncoding=utf8
spring.datasource.username = root
spring.datasource.password =

adminservice SERVER_PORT=7030
adminservice spring.datasource.url = jdbc:mysql://localhost:3307/ApolloConfigDB? characterEncoding=utf8
configservice SERVER_PORT=7020
configservice spring.datasource.url = jdbc:mysql://localhost:3307/ApolloConfigDB? characterEncoding=utf8

3.2.2 SIT

adminservice SERVER_PORT=7031
adminservice spring.datasource.url = jdbc:mysql://localhost:3307/ApolloConfigDB_SIT? characterEncoding=utf8
configservice SERVER_PORT=7021
configservice spring.datasource.url = jdbc:mysql://localhost:3307/ApolloConfigDB_SIT? characterEncoding=utf8

3.2.3 UAT

adminservice SERVER_PORT=7032
adminservice spring.datasource.url = jdbc:mysql://localhost:3307/ApolloConfigDB_UAT? characterEncoding=utf8
configservice SERVER_PORT=7022
configservice spring.datasource.url = jdbc:mysql://localhost:3307/ApolloConfigDB_UAT? characterEncoding=utf8

3.3 修改配置文件及代码

无论多少个环境都只需要一个 portal 服务，每个环境都需要自己的adminservice、configservice和数据库
例如：SIT环境都要额外再部署adminservice、configservice服务，并设置自己端口号；还需自己的ApolloConfigDB_SIT数据库

3.3.2 修改配置文件

  • build.bat 修改连接数据库及各环境IP、端口号；

    build.bat

  • apollo-env.properties 添加 sit

local.meta=http://localhost:8080
dev.meta=${dev_meta}
fat.meta=${fat_meta}
uat.meta=${uat_meta}
lpt.meta=${lpt_meta}
pro.meta=${pro_meta}
sit.meta=${sit_meta}

3.3.2 修改代码

  • Env com.ctrip.framework.apollo.core.enums 添加 sit 
public enum Env{
  LOCAL, DEV, FWS, FAT, UAT, LPT, PRO, TOOLS, UNKNOWN, SIT;

  public static Env fromString(String env) {
    Env environment = EnvUtils.transformEnv(env);
    Preconditions.checkArgument(environment != UNKNOWN, String.format("Env %s is invalid", env));
    return environment;
  }
}
  • EnvUtils com.ctrip.framework.apollo.core.enums 添加 sit 
public final class EnvUtils {
  
  public static Env transformEnv(String envName) {
    if (StringUtils.isBlank(envName)) {
      return Env.UNKNOWN;
    }
    switch (envName.trim().toUpperCase()) {
      case "LPT":
        return Env.LPT;
      case "FAT":
      case "FWS":
        return Env.FAT;
      case "UAT":
        return Env.UAT;
      case "PRO":
      case "PROD": //just in case
        return Env.PRO;
      case "DEV":
        return Env.DEV;
      case "LOCAL":
        return Env.LOCAL;
      case "TOOLS":
        return Env.TOOLS;
      case "SIT":
        return Env.SIT;
      default:
        return Env.UNKNOWN;
    }
  }
}
  • LegacyMetaServerProvider com.ctrip.framework.apollo.core.internals 添加 sit 
private void initialize() {
    Properties prop = new Properties();
    prop = ResourceUtils.readConfigFile("apollo-env.properties", prop);

    domains.put(Env.LOCAL, getMetaServerAddress(prop, "local_meta", "local.meta"));
    domains.put(Env.DEV, getMetaServerAddress(prop, "dev_meta", "dev.meta"));
    domains.put(Env.FAT, getMetaServerAddress(prop, "fat_meta", "fat.meta"));
    domains.put(Env.UAT, getMetaServerAddress(prop, "uat_meta", "uat.meta"));
    domains.put(Env.LPT, getMetaServerAddress(prop, "lpt_meta", "lpt.meta"));
    domains.put(Env.PRO, getMetaServerAddress(prop, "pro_meta", "pro.meta"));
    domains.put(Env.SIT, getMetaServerAddress(prop, "sit_meta", "sit.meta"));
  }

3.4 执行脚本启动服务

#!/bin/sh
echo "==== 启动开发环境apollo服务 ===="

/home/zhanhao/service/apollo1.4/dev/configservice/scripts/startup.sh
/home/zhanhao/service/apollo1.4/dev/adminservice/scripts/startup.sh

echo "==== 启动sit环境apollo服务 ===="
/home/zhanhao/service/apollo1.4/sit/configservice/scripts/startup.sh
/home/zhanhao/service/apollo1.4/sit/adminservice/scripts/startup.sh
echo "==== 启动uat环境apollo服务 ===="
/home/zhanhao/service/apollo1.4/uat/configservice/scripts/startup.sh
/home/zhanhao/service/apollo1.4/uat/adminservice/scripts/startup.sh

echo "==== 启动portal apollo服务 ===="
/home/zhanhao/service/apollo1.4/portal/scripts/startup.sh
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 199,175评论 5赞 466
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 83,674评论 2赞 376
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 146,151评论 0赞 328
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 53,597评论 1赞 269
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 62,505评论 5赞 359
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 47,969评论 1赞 275
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,455评论 3赞 390
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,118评论 0赞 254
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,227评论 1赞 294
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,213评论 2赞 317
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,214评论 1赞 328
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 32,928评论 3赞 316
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,512评论 3赞 302
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,616评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,848评论 1赞 255
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,228评论 2赞 344
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 41,772评论 2赞 339