迁移Spring Cloud应用到OpenShift Service Mesh

小鱼儿 2022-12-28 14:22 162阅读 0赞

### 文章目录 ###

*  迁移Spring Cloud应用到OpenShift Service Mesh
 *   *  前言
     *  微服务实现方式对比
     *  应用配置
     *   *  应用改造
     *  OpenShift配置
     *   *  将项目纳入Istio管理
         *  配置Deployment
         *  配置Service
     *  Istio配置
     *  Spring Cloud Netflix与Istio比较
     *   *  Spring Cloud Netflix
         *  Istio
     *  Troubleshooting
     *   *  Istio配置问题
         *  bookinfo的Istio配置问题
         *  Kiali graph unkown
         *  Kiali graph passthroughcluster
     *  参考文档
     *   *  Istio文档
         *  OpenShift文档
         *  Kiali 文档
         *  微服务相关文档

# 迁移Spring Cloud应用到OpenShift Service Mesh #

## 前言 ##

本文描述了如何将Spring Boot / Spring Cloud 应用迁移到OpenShift Service Mesh (Istio) 上。

环境：

*  OpenShift 4.6
 *  Service Mesh 2.x (Istio 1.6.5）

## 微服务实现方式对比 ##

下表对比了典型的Spring Cloud应用迁移到OpenShift ServiceMesh后实现微服务方式的区别：

<table> 
 <thead> 
  <tr> 
   <th>分类</th> 
   <th>SpringCloud</th> 
   <th>OpenShift ServiceMesh</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>服务配置</td> 
   <td>Spring Cloud Config Server</td> 
   <td>ConfigMap, Secret</td> 
  </tr> 
  <tr> 
   <td>服务注册与发现</td> 
   <td>Eureka</td> 
   <td>Etcd + Service + 集群内DNS</td> 
  </tr> 
  <tr> 
   <td>负载均衡</td> 
   <td>Ribbon</td> 
   <td>Service, Istio的Envoy数据平面</td> 
  </tr> 
  <tr> 
   <td>服务间调用</td> 
   <td>OpenFeign 或 RestTemplate</td> 
   <td>任意HTTP client</td> 
  </tr> 
  <tr> 
   <td>路由管理</td> 
   <td>Zuul 或 Spring Cloud Gateway</td> 
   <td>Istio的VirtualService和DetinationRule</td> 
  </tr> 
  <tr> 
   <td>对外API网关</td> 
   <td>Zuul 或 Spring Cloud Gateway</td> 
   <td>Route，Istio的Ingress gateway和Egress gateway</td> 
  </tr> 
  <tr> 
   <td>限流和熔断</td> 
   <td>Hystrix</td> 
   <td>Istio的Envoy数据平面</td> 
  </tr> 
  <tr> 
   <td>服务跟踪和调用链</td> 
   <td>Zipkin 或 OpenTracing + Jaeger</td> 
   <td>OpenTracing + Jager</td> 
  </tr> 
  <tr> 
   <td>服务网络拓扑</td> 
   <td>无</td> 
   <td>Kiali</td> 
  </tr> 
  <tr> 
   <td>灰度发布和蓝绿部署</td> 
   <td>无</td> 
   <td>Istio的Envoy数据平面</td> 
  </tr> 
 </tbody> 
</table>

## 应用配置 ##

### 应用改造 ###

Spring Boot应用迁移到Istio，代码无需改动。

但是如果需要用OpenTracing Jaeger来做服务跟踪，则需要按照下面步骤配置。参见：

*  [在OpenShift使用Jaeger对Spring Boot / Spring Cloud应用作分布式服务跟踪][OpenShift_Jaeger_Spring Boot _ Spring Cloud]

Spring Cloud应用迁移到Istio，需要将基于Spring Cloud Eureka的服务注册发现，改为基于OpenShift Service的的服务注册发现，否则无法使用Istio的traffic management功能。

## OpenShift配置 ##

### 将项目纳入Istio管理 ###

以Cluster Admin登录，选择`istio-system`项目，打开Operators / Installed Operators，找到Red Hat OpenShift Service Mesh，点击打开Istio Service Member Roll。

打开`default`，在`spec.members`下添加要纳入Istio管理的项目名称。

注意，OpenShift不会自动将该项目下全部workload都纳入Istio管理，只有完成下面的OpenShift配置后，workload才会纳入Istio管理。

一般，只有业务服务需要纳入Istio管理，基础服务不需要纳入Istio管理。

### 配置Deployment ###

1.  如果原来使用OpenShift DeploymentConfig来部署，要改成用Deployment来部署。Istio只支持Deployment方式部署。
2.  需要在Deployment中增加注入Sidecar，在Deployment YAML加入annotation：
    
        spec:
          template:
            metadata:
              annotations:
                sidecar.istio.io/inject: "true"
3.  确保在Deployment中用`containerPort`列出每个端口，Istio sidecar proxy将会忽略不列出来的端口。
4.  确保在Deployment中使用了`app`和`version` 的label和selector label：
    
     *  `metadata.labels`
     *  `spec.selector.matchLabels`
     *  `spec.template.metadata.labels`
5.  建议以`<deployment-name>-<version>` 来区分不同版本的Deployment，比如`recommendation-v1`和`recommendation-v2`。

### 配置Service ###

1.  需要Istio sidecar proxy代理流量的Pod都必须归属到一个OpenShift Service。
2.  需要为Service的port命名，命名规则为`<protocol>-<suffix>`，其中`suffix`选填。port名称比如`http-8080`或`http`。如果没有在Service为port命名，或没有按规则来命名，Istio sidecar proxy将忽略这些端口。
3.  Service中的端口用到的协议要和Istio配置中用到的协议一致，比如都是HTTP协议。
4.  检查Service所关联的pod是否符合预期。

参见：

*  [https://kiali.io/documentation/v1.15/validations/\#\_kia0601\_port\_name\_must\_follow\_protocol\_suffix\_form][https_kiali.io_documentation_v1.15_validations_kia0601_port_name_must_follow_protocol_suffix_form]

## Istio配置 ##

为应用的流量入口配置Istio Ingress Gateway和VirtualService，Ingress Gateway和VirtualService的`host`为应用的域名，不要使用`*` 通配符，不然会有“More than one Gateway for the same hsot port combination"的错误。

在`istio-system`项目下，可查看OpenShift为Istio Ingress Gateway创建的路由。

为服务配置VirtualService和DestinationRule来实现路由管理，比如为不同版本分配不同的路由权重来实现灰度发布。

完成配置后，在Kiali上检查Istio Config、Deployment和Service是否报错。

参见：

*  [https://istio.io/latest/docs/reference/config/networking/][https_istio.io_latest_docs_reference_config_networking]
 *  [https://kiali.io/documentation/v1.15/validations/\#\_kia0301\_more\_than\_one\_gateway\_for\_the\_same\_host\_port\_combination][https_kiali.io_documentation_v1.15_validations_kia0301_more_than_one_gateway_for_the_same_host_port_combination]

## Spring Cloud Netflix与Istio比较 ##

### Spring Cloud Netflix ###

*  优点：
    
     *  成熟
 *  缺点：
    
     *  每个微服务都要集成一些微服务基础组件功能。
     *  每个系统都要部署一些微服务基础组件。
     *  只支持Java。
     *  代码侵入。

### Istio ###

*  优点：
    
     *  由PaaS平台和Istio提供微服务基础组件功能，微服务只需要关注业务本身。
     *  语言无关，支持多语言。
     *  简化系统架构。
     *  功能更丰富，更强大。
 *  缺点：
    
     *  Service Mesh 还在快速发展中
     *  额外的网络开销

## Troubleshooting ##

### Istio配置问题 ###

*  [https://kiali.io/documentation/v1.15/validations][https_kiali.io_documentation_v1.15_validations]

### bookinfo的Istio配置问题 ###

bookinfo的Istio Ingress Gateway 和 VirtualServcie的`host`使用了`*`通配符，会影响其他应用。

在测试完bookinfo后，应将其Istio config删除。

### Kiali graph unkown ###

Kiali graph上的unkown节点，表示流量经过的节点Kiali未能识别出service或workload名称。

可能的情况：

*  Health check
 *  Prometheus采集指标

参见：

*  [https://kiali.io/documentation/latest/faq/\#many-unknown][https_kiali.io_documentation_latest_faq_many-unknown]

### Kiali graph passthroughcluster ###

正常现象。

参见：

*  [https://stackoverflow.com/questions/61633167/why-is-my-inter-service-traffic-showing-in-the-passthrough-cluster-in-kiali][https_stackoverflow.com_questions_61633167_why-is-my-inter-service-traffic-showing-in-the-passthrough-cluster-in-kiali]
 *  [https://kiali.io/documentation/latest/faq/\#passthrough-traffic][https_kiali.io_documentation_latest_faq_passthrough-traffic]

## 参考文档 ##

### Istio文档 ###

*  [https://istio.io/][https_istio.io]

### OpenShift文档 ###

*  [Service Mesh 2 on OpenShift 4.6][]
 *  [istio-tutorial][]

### Kiali 文档 ###

*  [Kiali Valiation][https_kiali.io_documentation_v1.15_validations]
 *  [Kiali FAQ][]

### 微服务相关文档 ###

*  [Microservices Journey from Netflix OSS to Istio Service Mesh][]
 *  [Consul vs. Istio][]
 *  [Microservices.NOW: from Netflix OSS to Istio Service Mesh][Microservices.NOW_ from Netflix OSS to Istio Service Mesh]
 *  How to Get a Service Mesh Into Prod without Getting Fired - William Morgan, Buoyant, Inc
 *  [Microservices in the Cloud with Kubernetes and Istio (Google I/O '18)][Microservices in the Cloud with Kubernetes and Istio _Google I_O _18]

[OpenShift_Jaeger_Spring Boot _ Spring Cloud]: https://cookcode.blog.csdn.net/article/details/111226154
[https_kiali.io_documentation_v1.15_validations_kia0601_port_name_must_follow_protocol_suffix_form]: https://kiali.io/documentation/v1.15/validations/#_kia0601_port_name_must_follow_protocol_suffix_form
[https_istio.io_latest_docs_reference_config_networking]: https://istio.io/latest/docs/reference/config/networking/
[https_kiali.io_documentation_v1.15_validations_kia0301_more_than_one_gateway_for_the_same_host_port_combination]: https://kiali.io/documentation/v1.15/validations/#_kia0301_more_than_one_gateway_for_the_same_host_port_combination
[https_kiali.io_documentation_v1.15_validations]: https://kiali.io/documentation/v1.15/validations
[https_kiali.io_documentation_latest_faq_many-unknown]: https://kiali.io/documentation/latest/faq/#many-unknown
[https_stackoverflow.com_questions_61633167_why-is-my-inter-service-traffic-showing-in-the-passthrough-cluster-in-kiali]: https://stackoverflow.com/questions/61633167/why-is-my-inter-service-traffic-showing-in-the-passthrough-cluster-in-kiali
[https_kiali.io_documentation_latest_faq_passthrough-traffic]: https://kiali.io/documentation/latest/faq/#passthrough-traffic
[https_istio.io]: https://istio.io/
[Service Mesh 2 on OpenShift 4.6]: https://access.redhat.com/documentation/en-us/openshift_container_platform/4.6/html/service_mesh/service-mesh-2-x
[istio-tutorial]: https://github.com/redhat-scholars/istio-tutorial
[Kiali FAQ]: https://kiali.io/documentation/latest/faq/
[Microservices Journey from Netflix OSS to Istio Service Mesh]: https://dzone.com/articles/microservices-journey-from-netflix-oss-to-istio-se
[Consul vs. Istio]: https://www.consul.io/docs/intro/vs/istio
[Microservices.NOW_ from Netflix OSS to Istio Service Mesh]: https://www.youtube.com/watch?v=WaD0SBb13AU
[Microservices in the Cloud with Kubernetes and Istio _Google I_O _18]: https://www.youtube.com/watch?v=gauOI0O9fRM