全部产品
云市场

连接 SOFA 服务注册中心

更新时间:2020-05-09 18:45:24

要使用服务网格,您需要将您的本地工程接入 SOFA 服务注册中心,即 SOFARegistry,完成服务注册。

SOFABoot 服务

  1. 升级 SOFABoot 依赖版本至最新版本。版本信息,详见 SOFABoot 版本说明
    1. <parent>
    2. <groupId>com.alipay.sofa</groupId>
    3. <artifactId>sofaboot-enterprise-dependencies</artifactId>
    4. <version>3.x.x</version>
    5. </parent>
  2. 通过以下任一方式,添加应用启动参数:
    • application.properties 中配置如下:
      1. com.alipay.env=shared
      2. com.alipay.instanceid= // 需要填写
      3. com.antcloud.antvip.endpoint= // 需要填写
      4. com.antcloud.mw.access= // 需要填写
      5. com.antcloud.mw.secret= // 需要填写
    • 指定 JVM 启动参数值:
      1. -Dcom.alipay.env=shared
      2. -Dcom.alipay.instanceid= // 需要填写
      3. -Dcom.antcloud.antvip.endpoint= // 需要填写
      4. -Dcom.antcloud.mw.access= // 需要填写
      5. -Dcom.antcloud.mw.secret= // 需要填写
    • 指定系统环境变量:
      1. COM_ALIPAY_ENV=shared
      2. SOFA_INSTANCE_ID= // 需要填写
      3. SOFA_ANTVIP_ENDPOINT= // 需要填写
      4. SOFA_ACCESS_KEY= // 需要填写
      5. SOFA_SECRET_KEY= // 需要填写
      参数说明:以上参数值是中间件的全局配置项,可在 脚手架控制台 获取,详见 引入 SOFA 中间件 > 中间件全局配置脚手架

Dubbo 服务

  1. 引入 sofa-registry-cloud-all SDK 依赖。版本信息,参见 SDK 版本说明
    1. <dependency>
    2. <groupId>com.alipay.sofa</groupId>
    3. <artifactId>sofa-registry-cloud-all</artifactId>
    4. <!-- 替换 x.x.x 为该 SDK 最新版本号 -->
    5. <version>x.x.x</version>
    6. </dependency>
  2. 引入 Tracer 依赖。Tracer 针对 Dubbo 框架提供 3 种方式接入,分别针对 Spring Boot 1.x、Spring Boot 2.x 和 非 Spring Boot 类型的 Dubbo 应用。根据您的实际业务需求,选择相应的 Tracer 依赖接入。
    • Spring Boot 1.x
      1. <!-- for Spring Boot 1.X -->
      2. <dependency>
      3. <groupId>com.alipay.sofa</groupId>
      4. <artifactId>tracer-enterprise-sofa-boot-starter</artifactId>
      5. <version>2.3.7.JST.1</version>
      6. <exclusions>
      7. <exclusion>
      8. <groupId>com.alipay.sofa.common</groupId>
      9. <artifactId>sofa-common-tools</artifactId>
      10. </exclusion>
      11. <exclusion>
      12. <groupId>com.alipay.sofa</groupId>
      13. <artifactId>tracer-enterprise-dst-plugin</artifactId>
      14. </exclusion>
      15. </exclusions>
      16. </dependency>
      17. <dependency>
      18. <groupId>com.alipay.sofa.common</groupId>
      19. <artifactId>sofa-common-tools</artifactId>
      20. <version>1.0.17</version>
      21. </dependency>
    • Spring Boot 2.x
      1. <!-- for Spring Boot 2.X -->
      2. <dependency>
      3. <groupId>com.alipay.sofa</groupId>
      4. <artifactId>tracer-enterprise-sofa-boot-starter</artifactId>
      5. <version>3.2.3.JST.1</version>
      6. <exclusions>
      7. <exclusion>
      8. <groupId>com.alipay.sofa.common</groupId>
      9. <artifactId>sofa-common-tools</artifactId>
      10. </exclusion>
      11. <exclusion>
      12. <groupId>com.alipay.sofa</groupId>
      13. <artifactId>tracer-enterprise-dst-plugin</artifactId>
      14. </exclusion>
      15. </exclusions>
      16. </dependency>
      17. <dependency>
      18. <groupId>com.alipay.sofa.common</groupId>
      19. <artifactId>sofa-common-tools</artifactId>
      20. <version>1.0.17</version>
      21. </dependency>
    • 非 Spring Boot
      Tracer 依赖信息和与上文 Spring boot 2.x 相同。引入后,还需要在代码 Main 启动入口第一行加入以下开关:
      1. SofaTracerConfiguration.setProperty(SofaTracerConfiguration.JSON_FORMAT_OUTPUT, "false");
  3. 配置 Dubbo 的注册中心,使用 dsr:<dubbo:registry address="dsr://dsr"/>
  4. 通过以下任一方式,添加应用启动参数:
    • dubbo.properties 中配置如下:
      1. com.alipay.instanceid= // 需要填写
      2. com.antcloud.antvip.endpoint= // 需要填写
      3. com.antcloud.mw.access= // 需要填写
      4. com.antcloud.mw.secret= // 需要填写
    • 指定 JVM 启动参数值:
      1. -Dcom.alipay.instanceid= // 需要填写
      2. -Dcom.antcloud.antvip.endpoint= // 需要填写
      3. -Dcom.antcloud.mw.access= // 需要填写
      4. -Dcom.antcloud.mw.secret= // 需要填写
    • 指定系统环境变量:
      1. SOFA_INSTANCE_ID= // 需要填写
      2. SOFA_ANTVIP_ENDPOINT= // 需要填写
      3. SOFA_ACCESS_KEY= // 需要填写
      4. SOFA_SECRET_KEY= // 需要填写
      参数说明:以上参数值是中间件的全局配置项,可在 脚手架控制台 获取,详见 引入 SOFA 中间件 > 中间件全局配置

Spring Cloud 服务

  1. 引入以下 sofa-registry-cloud-all SDK 依赖。版本信息,参见 SDK 版本说明
    1. <dependency>
    2. <groupId>com.alipay.sofa</groupId>
    3. <artifactId>sofa-registry-cloud-all</artifactId>
    4. <!-- 替换 x.x.x 为该 SDK 最新版本号 -->
    5. <version>x.x.x</version>
    6. </dependency>
  2. 根据您的 Spring Cloud 版本信息,引入对应的 Tracer 依赖。
    • Spring Cloud:Camden、Dalston 和 Edgware 版本(对应 Spring Boot 1.x 版本)
      1. <!-- 支持服务调用tracer日志记录能力 -->
      2. <!-- for Spring Boot 1.X -->
      3. <dependency>
      4. <groupId>com.alipay.sofa</groupId>
      5. <artifactId>tracer-enterprise-sofa-boot-starter</artifactId>
      6. <version>2.3.7.JST.1</version>
      7. <exclusions>
      8. <exclusion>
      9. <groupId>com.alipay.sofa.common</groupId>
      10. <artifactId>sofa-common-tools</artifactId>
      11. </exclusion>
      12. <exclusion>
      13. <groupId>com.alipay.sofa</groupId>
      14. <artifactId>tracer-enterprise-dst-plugin</artifactId>
      15. </exclusion>
      16. </exclusions>
      17. </dependency>
      18. <dependency>
      19. <groupId>com.alipay.sofa.common</groupId>
      20. <artifactId>sofa-common-tools</artifactId>
      21. <version>1.0.17</version>
      22. </dependency>
    • Spring Cloud:Finchley、Greenwich 版本(对应 Spring Boot 2.x 版本)
      1. <!-- 接入tracer -->
      2. <!-- for Spring Boot 2.X -->
      3. <dependency>
      4. <groupId>com.alipay.sofa</groupId>
      5. <artifactId>tracer-enterprise-sofa-boot-starter</artifactId>
      6. <version>3.2.3.JST.1</version>
      7. <exclusions>
      8. <exclusion>
      9. <groupId>com.alipay.sofa.common</groupId>
      10. <artifactId>sofa-common-tools</artifactId>
      11. </exclusion>
      12. <exclusion>
      13. <groupId>com.alipay.sofa</groupId>
      14. <artifactId>tracer-enterprise-dst-plugin</artifactId>
      15. </exclusion>
      16. </exclusions>
      17. </dependency>
      18. <dependency>
      19. <groupId>com.alipay.sofa.common</groupId>
      20. <artifactId>sofa-common-tools</artifactId>
      21. <version>1.0.17</version>
      22. </dependency>
  3. 通过以下任一方式,添加应用启动参数。
    注意:如您即将使用的应用服务发布平台不是 SOFAStack 自提供的容器应用服务或经典应用服务,则无需添加以下参数配置。
    • 在应用 yml 文件指定参数:
      1. sofa:
      2. registry:
      3. discovery:
      4. instanceId: // 需要填写
      5. antcloudVip: // 需要填写
      6. accessKey: // 需要填写
      7. secretKey: // 需要填写
    • 指定 JVM 启动参数值:
      1. -Dcom.alipay.instanceid= // 需要填写
      2. -Dcom.antcloud.antvip.endpoint= // 需要填写
      3. -Dcom.antcloud.mw.access= // 需要填写
      4. -Dcom.antcloud.mw.secret= // 需要填写
    • 指定系统环境变量:
      1. SOFA_INSTANCE_ID=
      2. SOFA_ANTVIP_ENDPOINT=
      3. SOFA_SECRET_KEY=
      4. SOFA_ACCESS_KEY=
      参数说明:以上参数值是中间件的全局配置项,均可在 脚手架控制台 获取。详见 引入 SOFA 中间件 > 中间件全局配置

本地应用改造完成后,您即可将该应用发布部署至 容器应用服务经典应用服务(仅专有云)。详情的部署步骤,可参见 服务网格快速入门

应用服务发布完成后,您可以前往 微服务平台 > 服务网格 进行服务管控及治理。