docker-compose 部署 Apollo 自定義環境


Apollo 配置中心是什么:

​ Apollo是攜程框架部門研發的開源配置管理中心,能夠集中化管理應用不同環境、不同集群的配置,配置修改后能夠實時推送到應用端,並且具備規范的權限、流程治理等特性。

Apollo的特性

  • 統一管理不同環境、不同集群的配置
    • Apollo提供了一個統一界面集中式管理不同環境(environment)、不同集群(cluster)、不同命名空間(namespace)的配置。
    • 同一份代碼部署在不同的集群,可以有不同的配置,比如zookeeper的地址等
    • 通過命名空間(namespace)可以很方便地支持多個不同應用共享同一份配置,同時還允許應用對共享的配置進行覆蓋
  • 配置修改實時生效(熱發布)
    • 用戶在Apollo修改完配置並發布后,客戶端能實時(1秒)接收到最新的配置,並通知到應用程序
  • 版本發布管理
    • 所有的配置發布都有版本概念,從而可以方便地支持配置的回滾
  • 灰度發布
    • 支持配置的灰度發布,比如點了發布后,只對部分應用實例生效,等觀察一段時間沒問題后再推給所有應用實例
  • 權限管理、發布審核、操作審計
    • 應用和配置的管理都有完善的權限管理機制,對配置的管理還分為了編輯和發布兩個環節,從而減少人為的錯誤。
    • 所有的操作都有審計日志,可以方便地追蹤問題
  • 客戶端配置信息監控
    • 可以在界面上方便地看到配置在被哪些實例使用
  • 提供Java和.Net原生客戶端
    • .Net的原生客戶端,方便應用集成
    • 同時提供了Http接口,非Java和.Net應用也可以方便地使用
  • 提供開放平台API
    • Apollo自身提供了比較完善的統一配置管理界面,支持多環境、多數據中心配置管理、權限、流程治理等特性。不過Apollo出於通用性考慮,不會對配置的修改做過多限制,只要符合基本的格式就能保存,不會針對不同的配置值進行針對性的校驗,如數據庫用戶名、密碼,Redis服務地址等
    • 對於這類應用配置,Apollo支持應用方通過開放平台API在Apollo進行配置的修改和發布,並且具備完善的授權和權限控制
  • 部署簡單
    • 配置中心作為基礎服務,可用性要求非常高,這就要求Apollo對外部依賴盡可能地少
    • 目前唯一的外部依賴是MySQL,所以部署非常簡單,只要安裝好Java和MySQL就可以讓Apollo跑起來
    • Apollo還提供了打包腳本,一鍵就可以生成所有需要的安裝包,並且支持自定義運行時參數

客戶端架構

架構和模塊

一:Config Service提供配置的讀取、推送等功能,服務對象是Apollo客戶端

  • 提供配置獲取接口
  • 提供配置更新推送接口(基於Http long polling)
    • 服務端使用Spring DeferredResult實現異步化,從而大大增加長連接數量
    • 目前使用的tomcat embed默認配置是最多10000個連接(可以調整),使用了4C8G的虛擬機實測可以支撐10000個連接,所以滿足需求(一個應用實例只會發起一個長連接)。
  • 接口服務對象為Apollo客戶端

二:Admin Service提供配置的修改、發布等功能,服務對象是Apollo Portal(管理界面)

  • 提供配置管理接口
  • 提供配置修改、發布等接口
  • 接口服務對象為Portal

三: Meta Server 在Eureka之上我們架了一層Meta Server用於封裝Eureka的服務發現接口

  • Portal通過域名訪問Meta Server獲取Admin Service服務列表(IP+Port)
  • Client通過域名訪問Meta Server獲取Config Service服務列表(IP+Port)
  • Meta Server從Eureka獲取Config Service和Admin Service的服務信息,相當於是一個Eureka Client
  • 增設一個Meta Server的角色主要是為了封裝服務發現的細節,對Portal和Client而言,永遠通過一個Http接口獲取Admin Service和Config Service的服務信息,而不需要關心背后實際的服務注冊和發現組件
  • Meta Server只是一個邏輯角色,在部署時和Config Service是在一個JVM進程中的,所以IP、端口和Config Service一致

四:Eureka java的一個服務發現的組件

  • 基於EurekaSpring Cloud Netflix提供服務注冊和發現
  • Config Service和Admin Service會向Eureka注冊服務,並保持心跳
  • 為了簡單起見,目前Eureka在部署時和Config Service是在一個JVM進程中的(通過Spring Cloud Netflix)

五: Portal

  • 提供Web界面供用戶管理配置
  • 通過Meta Server獲取Admin Service服務列表(IP+Port),通過IP+Port訪問服務
  • 在Portal側做load balance、錯誤重試

六:Client 客戶端

  • Apollo提供的客戶端程序,為應用提供配置獲取、實時更新等功能
  • 通過Meta Server獲取Config Service服務列表(IP+Port),通過IP+Port訪問服務
  • 在Client側做load balance、錯誤重試

部署

  1. 目前我們開發有多個開發的環境:dev ,devmt,uat ,等環境,阿波羅可以多環境部署,需要明確環境來部署

  2. apollo 多環境部署,Config Service,Admin Service 需要根據環境各自部署一份,Portal 可以只部署一份,管理所有的環境

  3. GitHub下載: https://github.com/ctripcorp/apollo 源碼

  4. 自定義環境變量 源碼修改 ,建議查看源碼的 github 文檔 文件中有代碼的具體路徑

    • Env com.ctrip.framework.apollo.core.enums 添加 DEVMT

      public enum Env{
        LOCAL, DEV, FWS, FAT, UAT, LPT, PRO, TOOLS, UNKNOWN, DEVMT;
      
        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 添加 DEVMT

      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 "DEVMT":
              return Env.DEVMT;
            default:
              return Env.UNKNOWN;
          }
        }
      }
      
    • LegacyMetaServerProvider com.ctrip.framework.apollo.core.internals 添加 DEVMT

      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, "devmt_meta", "devmt.meta"));
        }
      
  5. 檢查 ,安裝 JAVA JDK 和 Maven ,進入源碼文件夾 Scripts 下 執行 Build 文件,編譯打包apollo

  6. 復制 apollo-configservice/target ,apollo-adminservice/target ,apollo-portal/target ,文件下面的zip 文件和Dockerfile 到指定的文件夾,如下圖

  7. 修改 configservice,adminservice,portal ,Dockerfile 文件中的版本號和zip文件的版本號一致

  8. 在源碼的Scripts 文件夾下面找到sql的部署腳本,在Mysql中執行,

    1. 修改 apolloconfigdb,eureka.service.url 的地址為,Configservice 部署的地址例如 ,http://192.168.xx.xxx:8081/eureka/,

    2. 修改portal 的 apollo.portal.envs 為:多環境部署的環境變量,例如 dev,devmt

    3. 修改portal 的apollo.portal.meta.servers 為 :部署的Configservice 部署的地址,例如

      {
          "DEV":"http://192.168.xx.xxx:8081",
          "DEVMT":"http://192.168.xx.xxx:8082"
      }
      
    4. 編寫docker-compose.yml

      version: "3"
      services:
        apollo-configservice:
          container_name: apollo-configservice
          build: apollo-configservice/ 
          image: apollo-configservice
          ports:
            - 8081:8080
          volumes:
            - /root/apollo/apollocompose/logs:/opt/logs
          environment:
            - SPRING_DATASOURCE_URL= jdbc:mysql://192.168.xx.xxx:3306/apolloconfigdbdev?characterEncoding=utf8&serverTimezone=Asia/Shanghai
            - SPRING_DATASOURCE_USERNAME= xxxxxx
            - SPRING_DATASOURCE_PASSWORD= xxxxxx
      
        apollo-adminservice:
          container_name: apollo-adminservice
          build: apollo-adminservice/ 
          image: apollo-adminservice
          ports:
            - 8091:8090
          volumes:
            - /root/apollo/apollocompose/logs:/opt/logs
          environment:
            - SPRING_DATASOURCE_URL= jdbc:mysql://192.168.xx.xxx:3306/apolloconfigdbdev?characterEncoding=utf8&serverTimezone=Asia/Shanghai
            - SPRING_DATASOURCE_USERNAME= xxxxxx
            - SPRING_DATASOURCE_PASSWORD= xxxxxx
        
        apollo-configservice-uat:
          container_name: apollo-configservice-uat
          build: apollo-configservice/ 
          image: apollo-configservice
          ports:
            - 8082:8080
          volumes:
            - /root/apollo/apollocompose/logs:/opt/logs
          environment:
            - SPRING_DATASOURCE_URL= jdbc:mysql://192.168.xx.xxx:3306/apolloconfigdbuat?characterEncoding=utf8&serverTimezone=Asia/Shanghai
            - SPRING_DATASOURCE_USERNAME= xxxxxx
            - SPRING_DATASOURCE_PASSWORD= xxxxxx
      
        apollo-adminservice-uat:
          container_name: apollo-adminservice-uat
          build: apollo-adminservice/ 
          image: apollo-adminservice
          ports:
            - 8092:8090
          volumes:
            - /root/apollo/apollocompose/logs:/opt/logs
          environment:
            - SPRING_DATASOURCE_URL= jdbc:mysql://192.168.xx.xxx:3306/apolloconfigdbuat?characterEncoding=utf8&serverTimezone=Asia/Shanghai
            - SPRING_DATASOURCE_USERNAME= xxxxxx
            - SPRING_DATASOURCE_PASSWORD= xxxxxx
        
        apollo-portal:
          container_name: apollo-portal
          build: apollo-portal/
          image: apollo-portal
          restart: always
          depends_on:
            - apollo-adminservice
          environment:
            - SPRING_DATASOURCE_URL= jdbc:mysql://192.168.xx.xxx:3306/apolloportaldb?characterEncoding=utf8&serverTimezone=Asia/Shanghai
            - SPRING_DATASOURCE_USERNAME= xxxxxx
            - SPRING_DATASOURCE_PASSWORD= xxxxxx
          volumes:
            - /root/apollo/apollocompose/logs:/opt/logs
            - /root/apollo/apollocompose/apollo-env.properties:/apollo-portal/config/apollo-env.properties
          ports:
            - 8071:8070
          
      
    5. 修改 本地 apollo-env.properties 環境變量配置為:與 自定義配置或攜程定義的環境變量一致

      dev.meta=http://localhost:8081
      devmt.meta=http://localhost:8082
      
    6. 執行 docker-compose ,啟動有延遲,多等待一會兒

    踩坑

    1. 自定義環境變量需要下載源碼,編譯,sql腳本和數據庫連接配置,一定要用官網最新的連接配置,不同版本,sql腳本可能不一致
    2. 部署機器的運行內存要充足
    3. 部署啟動后,configservice,adminservice,portal ,Mata service ,Eureka 需要通訊,所以啟動后,有延遲,等一段時間在看是否部署成功
    4. 服務器端口,防火牆需要開啟對應的端口,8080,8090,8071 和 自己指定的端口

    學習鏈接

    1. 楊波老師架構解析文章:https://blog.csdn.net/yang75108/article/details/86989524?spm=1001.2014.3001.5501

    2. Apollo 設計文檔:https://www.apolloconfig.com/#/zh/design/apollo-design?id=_135-portal

    3. Apollo 搭建自定義環境:https://www.jianshu.com/p/f84da093944f


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM