spring-cloud-kubernetes 与 SpringCloud Gateway
本篇概览
-
本文是《spring-cloud-kubernetes 实战系列》的第五篇，主要内容是在 kubernetes 上部署一个 SpringCloud Gateway 应用，该应用使用了 spring-cloud-kubernetes 框架，可以将请求转发到 kubernetes 环境中的其他服务上；
本文大纲
-
接下来的内容由以下几部分组成：
-
什么是 SpringCloud Gateway
-
SpringCloud Gateway 实战参考
-
kubernetes 上的 SpringCloud Gateway
-
实战环境信息
-
实战源码下载
-
开发 webdemo
-
开发 k8sgatewaydemo
-
解决权限问题
-
最后一个疑问
什么是 SpringCloud Gateway
-
SpringCloud Gateway 是 SpringCloud 技术栈下的网关服务框架，在基于 SpringCloud 的微服务环境中，外部请求会到达 SpringCloud Gateway 应用，该应用对请求做转发、过滤、鉴权、熔断等前置操作，一个典型的请求响应流程如下所示：
-
SpringCloud Gateway 实战参考
-
如果您之前没有使用过 SpringCloud Gateway，推荐您阅读《速体验 SpringCloud Gateway》，有时间的话动手实战效果更佳，只需编写少量代码就能快速熟悉这个 SpringCloud 技术栈中非常重要的功能；
kubernetes 上的 SpringCloud Gateway
-
注意以下两个知识点：
-
SpringCloud Gateway 之所以能将外部请求路由到正确的后台服务上，是因为注册中心的存在，SpringCloud Gateway 可以在注册中心取得所有服务的信息，因此它可以根据路径和服务的对应关系，将请求转发到对应的服务上；
-
如果您看过本系列的上一篇 《spring-cloud-kubernetes的服务发现和轮询实战(含熔断)》 ，您就知道 spring-cloud-kubernetes 框架可以获取 kubernetes 环境内的所有服务（这里说的服务就是 kubernetes 的 service）；
-
将以上两个知识点结合起来，于是可以推测： 运行在 kubernetes 环境的 SpringCloud Gateway 应用，如果使用了 spring-cloud-kubernetes 框架就能得到 kubernetes 的 service 列表，因此可以承担网关的角色，将外部请求转发至 kubernetes 内的 service 上，最终到达对应的 Pod；
-
架构如下图所示，请注意黄色背景的对话框，里面标识了关键操作：
-
-
至此，理论分析已经完成，我们来实战验证这个理论，接下来我们开发两个 java 应用：
-
先开发一个普通的 web 服务，名为 webdemo，提供一个 http 接口；
-
再开发一个 SpringCloud Gateway 应用，名为 k8sgatewaydemo；
环境信息
-
本次实战的环境和版本信息如下：
-
操作系统：CentOS Linux release 7.6.1810
-
minikube：1.1.1
-
Java：1.8.0_191
-
Maven：3.6.0
-
fabric8-maven-plugin 插件：3.5.37
-
spring-cloud-kubernetes：1.0.1.RELEASE
-
spring cloud：Greenwich.SR2
-
springboot：2.1.6.RELEASE
源码下载
-
如果您不打算写代码，也可以从 GitHub 上下载本次实战的源码，地址和链接信息如下表所示：
-
这个 git 项目中有多个文件夹，本章的两个应用分别在 webdemo 和 k8sgatewaydemo 文件夹下；
-
下图红框中是 webdemo 应用的源码：
-
-
下图红框中是 k8sgatewaydemo 应用的源码：
-
-
下面是详细的编码过程；
开发 webdemo
-
webdemo 是个极其普通的 spring boot 应用， 和 SpringCloud 没有任何关系 ；
-
webdemo 提供一个 http 接口，将请求 header 中名为 extendtag 的参数返回给请求方，controller 类如下：
@RestController@RequestMapping("/hello")public class HelloController {@RequestMapping(value = "time", method = RequestMethod.GET)public String hello(HttpServletRequest request){return "hello, "+ new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date())+ ", extendtag ["+ request.getHeader("extendtag")+ "]";}}
复制代码
-
启动类 WebdemoApplication.java：
@SpringBootApplicationpublic class WebdemoApplication {public static void main(String[] args) {SpringApplication.run(WebdemoApplication.class, args);}}
复制代码
-
要注意的是 pom.xml，里面通过名为 fabric8-maven-plugin 的 maven 插件，将 webdemo 快速部署到 minikube 环境：
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">4.0.0 org.springframework.boot spring-boot-starter-parent 2.1.6.RELEASE com.bolingcavalry webdemo 0.0.1-SNAPSHOT webdemo Demo project for Spring Boot 1.8 2.1.6.RELEASE 3.5.37 org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-test test org.springframework.boot spring-boot-maven-plugin ${spring-boot.version} repackage org.apache.maven.plugins maven-deploy-plugin ${maven-deploy-plugin.version} true org.apache.maven.plugins maven-surefire-plugin ${maven-surefire-plugin.version} true false io.fabric8 fabric8-maven-plugin ${fabric8.maven.plugin.version} fmp resource kubernetes io.fabric8 fabric8-maven-plugin ${fabric8.maven.plugin.version} fmp resource build NodePort
复制代码
-
以上就是 webdemo 应用的内容了，接下来要编译、构建、部署到 minikube 环境，在 pom.xml 执行以下命令即可：
mvn clean install fabric8:deploy -Dfabric8.generator.from=fabric8/java-jboss-openjdk8-jdk -Pkubernetes
复制代码
-
部署完成后终端输出类似如下成功信息：
[INFO] [INFO] <<< fabric8-maven-plugin:3.5.37:deploy (default-cli) < install @ webdemo <<<[INFO] [INFO] [INFO] --- fabric8-maven-plugin:3.5.37:deploy (default-cli) @ webdemo ---[INFO] F8: Using Kubernetes at https://192.168.121.133:8443/ in namespace default with manifest /usr/local/work/k8s/webdemo/target/classes/META-INF/fabric8/kubernetes.yml [INFO] Using namespace: default[INFO] Updating a Service from kubernetes.yml[INFO] Updated Service: target/fabric8/applyJson/default/service-webdemo.json[INFO] Using namespace: default[INFO] Updating Deployment from kubernetes.yml[INFO] Updated Deployment: target/fabric8/applyJson/default/deployment-webdemo.json[INFO] F8: HINT: Use the command `kubectl get pods -w` to watch your pods start up[INFO] ------------------------------------------------------------------------[INFO] BUILD SUCCESS[INFO] ------------------------------------------------------------------------[INFO] Total time: 11.804 s[INFO] Finished at: 2019-07-07T21:32:26+08:00[INFO] ------------------------------------------------------------------------
复制代码
-
查看 service 和 pod，确认一切正常：
[root@minikube webdemo]# kubectl get serviceNAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGEkubernetes ClusterIP 10.96.0.1 443/TCP 29d webdemo NodePort 10.106.98.137 8080:30160/TCP 115m [root@minikube webdemo]# kubectl get podNAME READY STATUS RESTARTS AGEwebdemo-c9f774b9-gsbgx 1/1 Running 0 3m13s
复制代码
-
使用 minikube 命令取得 webdemo 服务对外暴露的地址：
[root@minikube webdemo]# minikube service webdemo --urlhttp://192.168.121.133:30160
复制代码
-
可见外部通过地址：http://192.168.121.133:30160 即可访问到 webdemo 应用；
-
在浏览器输入地址：http://192.168.121.133:30160/hello/time ，即可验证 webdemo 的 http 接口是否正常，如下图，由于 header 中没有 extendtag 属性，因此返回的 extendtag 为 null：
-
-
至此，webdemo 在 minikue 上已经正常运行，该开发 gateway 应用了；
开发 k8sgatewaydemo
-
基于 maven 创建一个名为 k8sgatewaydemo 的 springboot 应用，pom.xml 内容如下：
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 4.0.0 org.springframework.boot spring-boot-starter-parent 2.1.6.RELEASE com.bolingcavalry k8sgatewaydemo 0.0.1-SNAPSHOT k8sgatewaydemo Demo project for Spring Boot
1.8 2.1.6.RELEASE false false false 3.5 2.8.2 2.18.1 2.21.0 3.5.37 1.0.1.RELEASE Greenwich.SR2
org.springframework.cloud spring-cloud-starter-gateway
org.springframework.boot spring-boot-starter-test test
org.springframework.cloud spring-cloud-kubernetes-core ${springcloud.kubernetes.version}
org.springframework.cloud spring-cloud-kubernetes-discovery ${springcloud.kubernetes.version}
org.springframework.cloud spring-cloud-starter-kubernetes-ribbon ${springcloud.kubernetes.version}
org.springframework.cloud spring-cloud-commons
org.springframework.boot spring-boot-starter
org.springframework.cloud spring-cloud-starter-netflix-ribbon
org.springframework.cloud spring-cloud-starter-netflix-hystrix
org.springframework.cloud spring-cloud-dependencies ${spring-cloud.version} pom import
org.springframework.boot spring-boot-maven-plugin ${spring-boot.version} repackage
org.apache.maven.plugins maven-deploy-plugin ${maven-deploy-plugin.version} true org.apache.maven.plugins maven-surefire-plugin ${maven-surefire-plugin.version} true false io.fabric8 fabric8-maven-plugin ${fabric8.maven.plugin.version} fmp resource
kubernetes io.fabric8 fabric8-maven-plugin ${fabric8.maven.plugin.version} fmp resource build NodePort
复制代码
-
上述 pom 文件中有以下几点需要注意：
-
第一、 依赖 spring-cloud-kubernetes-core 和 spring-cloud-kubernetes-discovery，这样能用到 spring-cloud-kubernetes 提供的服务发现能力；
-
第二、依赖 spring-cloud-starter-gateway，这样能用上 SpringCloud 的 gateway 能力；
-
第三、不要依赖 spring-boot-starter-web，会和 spring-cloud-starter-gateway 冲突，启动时抛出以下异常：
2019-07-06 08:12:09.188 WARN 1 --- [ main] ConfigServletWebServerApplicationContext : Exception encountered during context initialization - cancelling refresh attempt: org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'routeDefinitionRouteLocator' defined in class path resource [org/springframework/cloud/gateway/config/GatewayAutoConfiguration.class]: Unsatisfied dependency expressed through method 'routeDefinitionRouteLocator' parameter 1; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'modifyRequestBodyGatewayFilterFactory' defined in class path resource [org/springframework/cloud/gateway/config/GatewayAutoConfiguration.class]: Unsatisfied dependency expressed through method 'modifyRequestBodyGatewayFilterFactory' parameter 0; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'org.springframework.http.codec.ServerCodecConfigurer' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {}
复制代码
-
开发 SpringCloud Gateway 的启动类 K8sgatewaydemoApplication.java，里面也包含了网关路由配置的实例化，除了配置路径和转发服务的关系，还在请求的 header 中添加了 extendtag 属性，请注意注释的内容：
@SpringBootApplication@EnableDiscoveryClientpublic class K8sgatewaydemoApplication {
public static void main(String[] args) { SpringApplication.run(K8sgatewaydemoApplication.class, args); }
@Bean public RouteLocator customRouteLocator(RouteLocatorBuilder builder) { return builder.routes() //增加一个path匹配，以"/customize/hello/"开头的请求都在此路由 .route(r -> r.path("/customize/hello/**") //表示将路径中的第一级参数删除，用剩下的路径与webdemo的路径做拼接， //这里就是"lb://webdemo/hello/"，能匹配到webdemo的HelloController的路径 .filters(f -> f.stripPrefix(1) //在请求的header中添加一个key&value .addRequestHeader("extendtag", "geteway-" + System.currentTimeMillis())) //指定匹配服务webdemo，lb是load balance的意思 .uri("lb://webdemo") ).build(); }}
复制代码
-
从上述代码可见，K8sgatewaydemoApplication 与普通环境下的 SpringCloud Gateway 并无差别，都是通过 EnableDiscoveryClient 注解获取服务列表，配置 RouteLocator 实现路由逻辑；
-
配置文件 application.yml 的内容：
spring: application: name: gateway cloud: gateway: discovery: locator: enabled: true lowerCaseServiceId: true
复制代码
-
以上就是 k8sgatewaydemo 应用的内容了，接下来要编译、构建、部署到 minikube 环境，在 pom.xml 执行以下命令即可：
mvn clean install fabric8:deploy -Dfabric8.generator.from=fabric8/java-jboss-openjdk8-jdk -Pkubernetes
复制代码
-
部署完成后终端输出类似如下成功信息：
[INFO] [INFO] <<< fabric8-maven-plugin:3.5.37:deploy (default-cli) < install @ k8sgatewaydemo <<<[INFO] [INFO] [INFO] --- fabric8-maven-plugin:3.5.37:deploy (default-cli) @ k8sgatewaydemo ---[INFO] F8: Using Kubernetes at https://192.168.121.133:8443/ in namespace default with manifest /usr/local/work/k8s/k8sgatewaydemo/target/classes/META-INF/fabric8/kubernetes.yml [INFO] Using namespace: default[INFO] Updating a Service from kubernetes.yml[INFO] Updated Service: target/fabric8/applyJson/default/service-k8sgatewaydemo.json[INFO] Using namespace: default[INFO] Updating Deployment from kubernetes.yml[INFO] Updated Deployment: target/fabric8/applyJson/default/deployment-k8sgatewaydemo.json[INFO] F8: HINT: Use the command `kubectl get pods -w` to watch your pods start up[INFO] ------------------------------------------------------------------------[INFO] BUILD SUCCESS[INFO] ------------------------------------------------------------------------[INFO] Total time: 16.538 s[INFO] Finished at: 2019-07-07T22:04:48+08:00[INFO] ------------------------------------------------------------------------
复制代码
-
查看 service 和 pod，确认一切正常：
[root@minikube k8sgatewaydemo]# clear[root@minikube k8sgatewaydemo]# kubectl get serviceNAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGEk8sgatewaydemo NodePort 10.97.94.238 8080:31352/TCP 129m kubernetes ClusterIP 10.96.0.1 443/TCP 29d webdemo NodePort 10.106.98.137 8080:30160/TCP 145m [root@minikube k8sgatewaydemo]# kubectl get podNAME READY STATUS RESTARTS AGEk8sgatewaydemo-6fbb79885c-r2jfn 1/1 Running 0 33swebdemo-c9f774b9-gsbgx 1/1 Running 0 32m
复制代码
-
使用 minikube 命令取得 webdemo 服务对外暴露的地址：
[root@minikube k8sgatewaydemo]# minikube service k8sgatewaydemo --urlhttp://192.168.121.133:31352
复制代码
-
可见外部通过地址：http://192.168.121.133:31352 即可访问到 k8sgatewaydemo 应用；
-
在浏览器输入地址：http://192.168.121.133:31352/customize/hello/time ，即可验证 k8sgatewaydemo 作为网关应用，能否将路径中带有 customize 的请求转发到 webdemo 应用，并且在请求 header 中添加名为 entendtag 的属性，如下图，浏览器展示的内容是 webdemo 的 http 接口返回的，并且 extendtag 的内容也不为空了，而是 k8sgatewaydemo 在转发前写入的：
-
-
上述结果表明已可以证明我们之前的推测是正确的：SpringCloud Gateway 应用在使用了 spring-cloud-kubernetes 提供的注册发现能力后，可以将请求转发到 kubernetes 环境中的服务上；
-
也就是说，借助 spring-cloud-kubernetes 框架，你在 SpringCloud 环境开发的 SpringCloud Gateway 应用，可以以很小的代价迁移到 kubernetes 环境，与 kubernetes 环境中的 service 可以很好的交互，而原有的 eureka 注册中心也可以不用了；
解决权限问题
-
如果您的 spring-cloud-kubernetes 在向 webdemo 转发请求时抛出以下错误，那是因为遇到了 kubernetes 的权限问题：
2019-07-06 04:46:40.042 WARN 1 --- [erListUpdater-1] c.n.l.PollingServerListUpdater : Failed one update cycleio.fabric8.kubernetes.client.KubernetesClientException: Failure executing: GET at: https://10.96.0.1/api/v1/namespaces/default/endpoints/account-service. Message: Forbidden!Configured service account doesn't have access. Service account may have been revoked. endpoints "account-service" is forbidden: User "system:serviceaccount:default:default" cannot get resource "endpoints" in API group "" in the namespace "default". at io.fabric8.kubernetes.client.dsl.base.OperationSupport.requestFailure(OperationSupport.java:476) ~[kubernetes-client-4.1.0.jar!/:na] at io.fabric8.kubernetes.client.dsl.base.OperationSupport.assertResponseCode(OperationSupport.java:413) ~[kubernetes-client-4.1.0.jar!/:na] at io.fabric8.kubernetes.client.dsl.base.OperationSupport.handleResponse(OperationSupport.java:381) ~[kubernetes-client-4.1.0.jar!/:na] at io.fabric8.kubernetes.client.dsl.base.OperationSupport.handleResponse(OperationSupport.java:344) ~[kubernetes-client-4.1.0.jar!/:na] at io.fabric8.kubernetes.client.dsl.base.OperationSupport.handleGet(OperationSupport.java:313) ~[kubernetes-client-4.1.0.jar!/:na] at io.fabric8.kubernetes.client.dsl.base.OperationSupport.handleGet(OperationSupport.java:296) ~[kubernetes-client-4.1.0.jar!/:na] at io.fabric8.kubernetes.client.dsl.base.BaseOperation.handleGet(BaseOperation.java:794) ~[kubernetes-client-4.1.0.jar!/:na] at io.fabric8.kubernetes.client.dsl.base.BaseOperation.getMandatory(BaseOperation.java:210) ~[kubernetes-client-4.1.0.jar!/:na]
at io.fabric8.kubernetes.client.dsl.base.BaseOperation.get(BaseOperation.java:177) ~[kubernetes-client-4.1.0.jar!/:na] at org.springframework.cloud.kubernetes.ribbon.KubernetesServerList
.getUpdatedListOfServers(KubernetesServerList.java:75) ~[spring-cloud-kubernetes-ribbon-1.0.1.RELEASE.jar!/:1.0.1.RELEASE] at com.netflix.loadbalancer.DynamicServerListLoadBalancer.updateListOfServers(DynamicServerListLoadBalancer.java:240) ~[ribbon-loadbalancer-2.3.0.jar!/:2.3.0] at com.netflix.loadbalancer.DynamicServerListLoadBalancer$1.doUpdate(DynamicServerListLoadBalancer.java:62) ~[ribbon-loadbalancer-2.3.0.jar!/:2.3.0] at com.netflix.loadbalancer.PollingServerListUpdater$1.run(PollingServerListUpdater.java:116) ~[ribbon-loadbalancer-2.3.0.jar!/:2.3.0] at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511) [na:1.8.0_191] at java.util.concurrent.FutureTask.runAndReset(FutureTask.java:308) [na:1.8.0_191] at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.access$301(ScheduledThreadPoolExecutor.java:180) [na:1.8.0_191] at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:294) [na:1.8.0_191] at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149) [na:1.8.0_191] at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624) [na:1.8.0_191] at java.lang.Thread.run(Thread.java:748) [na:1.8.0_191]
复制代码
-
处理方法是创建 ServiceAccount 对象，步骤如下：
-
创建名为 fabric8-rbac.yaml 的文件，内容如下：
# NOTE: The service account `default:default` already exists in k8s cluster.# You can create a new account following like this:#---#apiVersion: v1#kind: ServiceAccount#metadata:# name: # namespace:
---apiVersion: rbac.authorization.k8s.io/v1beta1kind: ClusterRoleBindingmetadata: name: fabric8-rbacsubjects: - kind: ServiceAccount # Reference to upper's `metadata.name` name: default # Reference to upper's `metadata.namespace` namespace: defaultroleRef: kind: ClusterRole name: cluster-admin apiGroup: rbac.authorization.k8s.io
复制代码
-
执行以下命令即可创建 ServiceAccount 对象：
kubectl apply -f fabric8-rbac.yaml
复制代码
-
再在浏览器上继续刚才的验证，可以操作成功；
最后一个疑问
-
再回顾一下 k8sgatewaydemo 的开发过程，您会发现除了依赖 spring-cloud-kubernetes 对应的 maven 库，我们并没有显式调用 spring-cloud-kubernetes 相关的 API 或者做相关配置，就获取了所在 kubernetes 环境的原生服务，这是怎么回事呢？为何成本如此的低？