ServiceComb应用接入CSE
CSE Java SDK 100% 兼容 ServiceComb Java Chassis,并对其进行更加友好的封装,更加专注于业务逻辑,以简化用户业务开发。将ServiceComb Java Chassis部署到CSE,并使用CSE提供的能力,只需要对microservice.yaml进行适当的配置,以及在pom中添加额外的依赖,不涉及任何代码修改。
- microservice.yaml
{project}/src/main/resources/microservice.yaml
说明:microservice.yaml中默认配置服务中心、配置中心、仪表盘地址为公有云地址,其他合营云请根据实际情况配置。
- pom.xml
{project}/pom.xml
一键式配置
公有云版本提供了一键式简化配置的方式,让基于开源版本开发的应用快速切换为云上应用,直接使用公有云提供的灰度发布、服务治理等功能。
增加和管理依赖关系(pom.xml) 增加依赖管理
<dependencyManagement> <dependencies> <dependency> <groupId>com.huawei.paas.cse</groupId> <artifactId>cse-dependency</artifactId> <version>2.3.20</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement>
<dependency> <groupId>com.huawei.paas.cse</groupId> <artifactId>cse-solution-service-engine</artifactId> </dependency>
开发者只需要配置对cse-solution-service-engine依赖,就完成了公有云的所有配置。这个依赖关系主要给开发者做了如下事情:
- 引入相关依赖的组件。
- 增加默认配置项。默认配置包含了处理链、负载均衡策略等。
可以通过查看pom内容,以及这个jar包里面的microservice.yaml文件查看引入的组件和增加的配置项。在下面的章节中,详细解释上云增加的组件以及他们的作用,使开发者更加深入的了解各种技术细节。
配置应用AK/SK密钥
微服务连接公有云上的CSE服务中心、配置中心、仪表盘时,需要提供AK/SK秘钥信息,否则无法通过认证。
- 若应用通过在已有集群内创建应用(创建应用、云上工程)的方式,CSE将自动从应用所在集群获取认证信息,无需配置AKSK密钥信息,请跳过步骤2-3。
- 获取AK/SK方式
- 注册并登录管理控制台。
- 单击右上角用户名,进入“基本信息”页面。
- 单击“管理我的凭证”。
- 进入“管理访问密钥”页签,单击“新增访问密钥”,进入“新增访问密钥”页面。
- 输入登录密码、短信或者邮箱验证码,单击“确定”,下载密钥,请妥善保管。
- 配置项。
cse: credentials: accessKey: ak #结合用户实际值ak和加解密扩展进行配置 secretKey: sk #结合用户实际值sk和加解密扩展进行配置 akskCustomCipher: default #用户扩展解密com.huawei.paas.foundation.auth.credentials.AKSKCipher的实现类的name值, 默认default表示明文,无须加解密
该配置项配置了应用的AK/SK密钥信息,为了信息的安全,请用户对AK/SK密钥加密后进行配置。扩展AK/SK解密方式请参考如何扩展AK/SK解密方式。
连接服务中心
- 功能描述
服务中心实现注册和发现,在公有云查看微服务目录,都需要微服务连接上服务中心。
- 配置参考
- 增加依赖关系(pom.xml)
如果连接服务中心使用https协议或AK/SK认证,该jar依赖必选。如果是http协议,并不包含token验证,则无需引入。
<dependency> <groupId>com.huawei.paas.cse</groupId> <artifactId>foundation-auth</artifactId> </dependency>
- 启用配置(microservice.yaml)
cse: service: registry: address: https://cse.cn-north-1.myhwclouds.com:443 #根据实际地址配置服务中心地址
该配置项配置了服务中心的地址。其中,address可以在公有云“应用开发 > 微服务开发 > 工具下载”页面查到对应的服务中心地址,修改协议(http/https)、主机名(可能使用域名)和端口号。
- 增加依赖关系(pom.xml)
连接配置中心
- 功能描述
配置中心实现配置下发,连接配置中心是使用治理、灰度发布等功能的前提。
- 配置参考
- 增加依赖关系(pom.xml)
如果连接配置中心使用https协议或AK/SK认证,该jar依赖必选。如果是http协议,并不包含token验证,则无需引入。
<dependency> <groupId>com.huawei.paas.cse</groupId> <artifactId>foundation-auth</artifactId> </dependency>
连接配置中心该jar必选
<dependency> <groupId>org.apache.servicecomb</groupId> <artifactId>config-cc</artifactId> </dependency>
- 启用配置(microservice.yaml)
cse: config: client: serverUri: https://cse.cn-north-1.myhwclouds.com:443
该配置项配置了配置中心的地址。其中,serverUri可以在公有云“应用开发 > 微服务开发 > 工具下载”页面查到对应配置中心地址,修改协议(http/https)、主机名(可能使用域名)和端口号。
- 增加依赖关系(pom.xml)
使用服务治理
- 功能描述
服务治理主要涉及熔断、容错、限流、负载均衡等。
- 配置参考
配置项(microservice.yaml)
需要增加下面治理相关的handler。
cse: handler: chain: Provider: default: bizkeeper-provider,qps-flowcontrol-provider Consumer: default: bizkeeper-consumer,loadbalance,qps-flowcontrol-consumer
使用故障注入
- 功能描述
故障注入主要提供了延时、错误两种类型故障。
- 配置参考
配置项(microservice.yaml)
需要增加下面治理相关的handler。
cse: handler: chain: Consumer: default: loadbalance,fault-injection-consumer
使用灰度发布
- 功能描述
该功能对应于微服务目录灰度发布功能。管理员可以通过下发规则,对服务进行灰度发布管理。
- 配置参考
- 增加依赖关系(pom.xml)
引入jar包。
<dependency> <groupId>com.huawei.paas.cse</groupId> <artifactId>cse-handler-cloud-extension</artifactId> </dependency>
- 在Consumer端配置负载均衡(microservice.yaml)
在负载均衡模块启用灰度发布的filter。
cse: loadbalance: serverListFilters: darklaunch serverListFilter: darklaunch: className: com.huawei.paas.darklaunch.DarklaunchServerListFilter
- 增加依赖关系(pom.xml)
使用调用链
- 功能描述
公有云提供了业务无侵入的埋点功能APM。只需要通过公有云部署容器应用,并选择启用调用链监控功能,即可使用调用链服务。
使用仪表盘
- 功能描述
微服务可以将自己的运行数据上报给Dashboard服务,在公有云上查看仪表盘数据、分布式事务数据等。该章节是描述如何启用微服务数据上报功能。
- 配置参考
- 增加依赖关系(pom.xml)
引入jar包。
<dependency> <groupId>com.huawei.paas.cse</groupId> <artifactId>cse-handler-cloud-extension</artifactId> </dependency>
- 配置handler
仪表盘数据依赖于两个handler,一个bizkeeper-provider(客户端为bizkeeper-consumer),一个perf-stats,所以对应的pom依赖需要先引入。
cse: handler: chain: Provider: default: bizkeeper-provider,perf-stats,tracing-provider,sla-provider Consumer: default: bizkeeper-consumer,loadbalance,perf-stats,tracing-consumer,sla-consumer
- 配置上报monitor地址
TenantLB_ADDRESS为公有云接入地址,默认是100.125.1.34。
cse: monitor: client: serverUri: https://cse.cn-north-1.myhwclouds.com:443
该配置项配置了仪表盘上报地址。其中,serverUri可以在公有云“应用开发 > 微服务开发 > 工具下载”页面查到对应的仪表盘上报地址,修改协议(http/https)、主机名(可能使用域名)和端口号。
- 增加依赖关系(pom.xml)
使用分布式事务TCC
- 功能描述
主要实现基于TCC协议的分布式服务间的最终一致性方案,保障一般场景下的应用一致性需求,并可以在CSE分布式事务界面查看事务详细信息。
- 配置参考
增加依赖关系(pom.xml)
引入jar包。
<dependency> <groupId>com.huawei.paas.cse</groupId> <artifactId>cse-handler-tcc</artifactId> </dependency>
需要增加下面事务相关的handler,才能实时上报分布式事务数据。
cse: handler: chain: Provider: default: tcc-server,bizkeeper-provider Consumer: default: tcc-client,bizkeeper-consumer,loadbalance