Spring Cloud Kubernetes指南
1.概述
当我们构建微服务解决方案时,SpringCloud和Kubernetes都是最佳解决方案,因为它们为解决最常见的挑战提供组件。但是,如果我们决定选择Kubernetes作为我们的解决方案的主要容器管理器和部署平台,我们仍然可以主要通过SpringCloudKubernetes项目使用SpringCloud的有趣特性。这个相对较新的项目无疑可以与Kubernetes轻松集成Spring Boot应用程序。在开始之前,了解如何在Minikube(本地Kubernetes环境)上部署Spring Boot应用程序可能会有所帮助。
在本教程中,我们将:
-
在我们的本地计算机上安装Minikube。
-
开发一个微服务架构示例,其中两个独立的Spring Boot应用程序通过REST进行通信。
-
使用Minikube在单节点集群上设置应用程序。
-
使用YAML配置文件部署应用程序。
2.情景
在我们的示例中,我们使用的场景是旅行社向客户提供各种交易,客户将不时查询旅行社服务。我们将用它来演示:
-
通过Spring Cloud Kubernetes进行 服务发现。
-
配置管理和使用SpringCloudKubernetes配置向应用程序包注入Kubernetes配置和机密。
-
使用Spring Cloud Kubernetes功能区进行 负载均衡。
3.环境设置
首先,我们需要在本地机器上安装minikube,最好是虚拟机驱动程序,如virtualbox。在执行此环境设置之前,还建议先查看kubernetes及其主要功能。让我们启动本地单节点Kubernetes集群:
minikube start --vm-driver=virtualbox
此命令创建一个使用VirtualBox驱动程序运行Minikube集群的虚拟机。kubectl中的默认上下文现在将是minikube。但是,为了能够在上下文之间切换,我们使用:
kubectl config use-context minikube
启动Minikube后,我们可以 连接到Kubernetes仪表板以访问日志并轻松监控我们的服务,pods,ConfigMaps和Secrets:
minikube dashboard
3.1 部署
首先,让我们从GitHub获取示例。此时,我们可以从父文件夹运行“deployment-travel-client.sh”脚本,或者逐个执行每条指令以便更好地掌握该过程:
### build the repository
mvn clean install
### set docker env
eval $(minikube docker-env)
### build the docker images on minikube
cd travel-agency-service
docker build -t travel-agency-service .
cd ../client-service
docker build -t client-service .
cd ..
### secret and mongodb
kubectl delete -f travel-agency-service/secret.yaml
kubectl delete -f travel-agency-service/mongo-deployment.yaml
kubectl create -f travel-agency-service/secret.yaml
kubectl create -f travel-agency-service/mongo-deployment.yaml
### travel-agency-service
kubectl delete -f travel-agency-service/travel-agency-deployment.yaml
kubectl create -f travel-agency-service/travel-agency-deployment.yaml
### client-service
kubectl delete configmap client-service
kubectl delete -f client-service/client-service-deployment.yaml
kubectl create -f client-service/client-config.yaml
kubectl create -f client-service/client-service-deployment.yaml
# Check that the pods are running
kubectl get pods
4.服务发现
该项目为我们提供了Kubernetes中ServiceDiscovery接口的实现。在微服务环境中,通常有多个pod运行相同的服务。Kubernetes将服务公开为一组端点,可以从运行在同一Kubernetes集群中的pod中的Spring Boot应用程序中获取和访问这些端点。例如,在我们的示例中,我们有旅行社服务的多个副本,可以从我们的客户服务访问http:// travel-agency-service:8080。但是,这内部将转化为访问不同的pod,例如travel-agency-service-7c9cfff655-4hxnp。 Spring Cloud Kubernetes功能区使用此功能在服务的不同端点之间进行负载平衡。我们可以通过在客户端应用程序中添加spring-cloud-starter-kubernetes依赖项来轻松使用Service Discovery :
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-kubernetes</artifactId>
</dependency>
另外,我们应该在我们的类中使用@Autowired添加@EnableDiscoveryClient并将DiscoveryClient注入ClientController:
@SpringBootApplication
@EnableDiscoveryClient
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
@RestController
public class ClientController {
@Autowired
private DiscoveryClient discoveryClient;
}
5.ConfigMaps
通常,微服务需要某种配置管理。例如,在Spring Cloud应用程序中,我们将使用Spring Cloud Config Server。
但是,我们可以通过使用Kubernetes提供的ConfigMaps来实现这一点 - 只要我们打算将它用于非敏感的,未加密的信息。或者,如果我们要共享的信息是敏感的,那么我们应该选择使用Secrets。
在我们的示例中,我们在客户端服务 Spring Boot应用程序上使用ConfigMaps 。让我们创建一个client-config。yaml文件定义客户端服务的ConfigMap :
apiVersion: v1 by d
kind: ConfigMap
metadata:
name: client-service
data:
application.properties: |-
bean.message=Testing reload! Message from backend is: %s <br/> Services : %s
重要的是ConfigMap的名称与我们的“application.properties”文件中指定的应用程序名称相匹配。在这种情况下,它是客户端服务。接下来,我们应该在Kubernetes上为客户端服务创建ConfigMap :
kubectl create -f client-config.yaml
现在,让我们使用@Configuration和@ConfigurationProperties创建一个配置类ClientConfig并注入ClientController:
@Configuration
@ConfigurationProperties(prefix = "bean")
public class ClientConfig {
private String message = "Message from backend is: %s <br/> Services : %s";
// getters and setters
}
@RestController
public class ClientController {
@Autowired
private ClientConfig config;
@GetMapping
public String load() {
return String.format(config.getMessage(), "", "");
}
}
如果我们不指定ConfigMap,那么我们应该期望看到在类中设置的默认消息。但是,当我们创建ConfigMap时,该属性会覆盖此默认消息。
此外,每次我们决定更新ConfigMap时,页面上的消息都会相应更改:
kubectl edit configmap client-service
6.Secrets
让我们通过查看示例中MongoDB连接设置的规范来了解Secrets的工作原理。我们将在Kubernetes上创建环境变量,然后将其注入Spring Boot应用程序。
6.1 创造一个Secrets
第一步是创建一个secret.yaml文件,将用户名和密码编码为Base 64:
apiVersion: v1
kind: Secret
metadata:
name: db-secret
data:
username: dXNlcg==
password: cDQ1NXcwcmQ=
让我们在Kubernetes集群上应用Secret配置:
kubectl apply -f secret.yaml
6.2 创建一个MongoDB服务
我们现在应该创建MongoDB服务和部署travel-agency-deployment.yaml文件。特别是,在部署部分中,我们将使用之前定义的Secret 用户名和密码:
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: mongo
spec:
replicas: 1
template:
metadata:
labels:
service: mongo
name: mongodb-service
spec:
containers:
- args:
- mongod
- --smallfiles
image: mongo:latest
name: mongo
env:
- name: MONGO_INITDB_ROOT_USERNAME
valueFrom:
secretKeyRef:
name: db-secret
key: username
- name: MONGO_INITDB_ROOT_PASSWORD
valueFrom:
secretKeyRef:
name: db-secret
key: password
默认情况下,mongo:latest映像将在名为admin的数据库上创建具有用户名和密码的用户。
6.3 在旅行社服务上设置MongoDB
更新应用程序属性以添加数据库相关信息非常重要。虽然我们可以自由指定数据库名称admin,但这里我们隐藏了最敏感的信息,例如用户名和密码:
spring.cloud.kubernetes.reload.enabled=true
spring.cloud.kubernetes.secrets.name=db-secret
spring.data.mongodb.host=mongodb-service
spring.data.mongodb.port=27017
spring.data.mongodb.database=admin
spring.data.mongodb.username=${MONGO_USERNAME}
spring.data.mongodb.password=${MONGO_PASSWORD}
现在,让我们看看我们的travel-agency-deployment属性文件,使用连接到mongodb-service所需的用户名和密码信息来更新服务和部署。
这是文件的相关部分,其中部分与MongoDB连接相关:
env:
- name: MONGO_USERNAME
valueFrom:
secretKeyRef:
name: db-secret
key: username
- name: MONGO_PASSWORD
valueFrom:
secretKeyRef:
name: db-secret
key: password
7.与Ribbon通信
在微服务环境中,我们通常需要复制服务的pod列表,以便执行负载平衡。这是通过使用Spring Cloud Kubernetes Ribbon提供的机制实现的。此机制可以自动发现并到达特定服务的所有端点,然后,它使用有关端点的信息填充Ribbon ServerList。
让我们首先将spring-cloud-starter-kubernetes-ribbon依赖项添加到我们的客户端服务 pom.xml文件中:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-kubernetes-ribbon</artifactId>
</dependency>
下一步是将注释@RibbonClient添加到我们的客户端服务应用程序:
@RibbonClient(name = "travel-agency-service")
填充端点列表时,Kubernetes客户端将搜索生成在当前命名空间/项目中的已注册端点,这些端点与使用@RibbonClient注释定义的服务名称相匹配。
我们还需要在应用程序属性中启用功能区客户端:
ribbon.http.client.enabled=true
8.附加功能
8.1 Hystrix
Hystrix有助于构建容错和弹性应用程序。其主要目标是快速恢复和快速恢复。
特别是,在我们的示例中,我们使用Hystrix 通过使用@EnableCircuitBreaker注释Spring Boot应用程序类来在客户端 - 服务器上实现断路器模式。
此外,我们使用了回退功能通过注释方法TravelAgencyService.getDeals()与 @HystrixCommand() 。这意味着在回退的情况下,将调用getFallBackName()并返回“Fallback”消息:
@HystrixCommand(fallbackMethod = "getFallbackName", commandProperties = {
@HystrixProperty(name = "execution.isolation.thread.timeoutInMilliseconds", value = "1000") })
public String getDeals() {
return this.restTemplate.getForObject("http://travel-agency-service:8080/deals", String.class);
}
private String getFallbackName() {
return "Fallback";
}
8.2 健康检查
我们可以利用Spring Boot HealthIndicator和Spring Boot Actuator向用户公开与健康相关的信息。特别是,Kubernetes健康指标提供:
-
pod名称
-
IP地址
-
命名空间
-
服务帐户
-
节点名称
-
一个标志,指示Spring Boot应用程序是Kubernetes的内部还是外部
9.结论
在本文中,我们提供了Spring Cloud Kubernetes项目的全面概述。
那我们为什么要用呢?如果我们将Kubernetes作为微服务平台,但仍然欣赏Spring Cloud的功能,那么Spring Cloud Kubernetes为我们提供了两全其美的优势。GitHub上提供了该示例的完整源代码。
原文链接:https://www.baeldung.com/spring-cloud-kubernetes
作者:baeldung
译者:Yunooa