属性配置文件在任何应用程序中都非常重要。它们不仅可以让应用程序具备灵活性,还能够根据文件中配置的值产生不同的功能。实际上,在staging、开发、测试、UAT或生产环境中,我们都使用属性配置文件来驱动不同的行为。
 
两种方法,轻松上手ConfigMap!
 
通常情况下,属性配置文件会与代码一起打包,并且整个程序包都部署在执行环境中。这一方法中,如果你想更改任何配置(即便配置文件中也发生了更改),你需要重新发布代码。尽管这种方法行之有效,但是对于现在而言,效率还是太低了。因此我们需要一种外部化的配置。
 

在本文中,我将阐述Kubernetes如何为容器提供外部化、灵活的配置以及可移植性。ConfigMap主要是为了让应用程序的配置和部署解耦,这一功能可以让容器化应用程序具备可移植性。
 
如果你对Spring Cloud的生态很熟悉,那么接下来你会发现ConfigMap与Spring Cloud server十分类似。这里有两种使用ConfigMap的方法:

 

  1. 将ConfigMap作为一种环境变量

  2. 将ConfigMap挂载为文件

 
让我们开始进行实践!我们将使用一个简单的应用程序,基于Spring Boot、Docker和Kubernetes进行演示。
 

将ConfigMap作为一种环境变量

 

在本例中,我们将在Kubernetes中创建一个新的环境变量,并将其用于代码中。在Java中,可以通过System.getenv(String) API在代码中使用环境变量。在常规Java应用程序中,可以在J2EE应用程序容器(如Oracle WLS或IBM WAS)中设置环境变量,也可以在OS中设置环境变量。然而,在Kubernetes中情况并不相同。要使用环境变量,我们必须根据literal创建配置映射。
 
两种方法,轻松上手ConfigMap!
 
通过kubectl create configmap命令,我们创建了两个环境变量:app.name 和 app.desc。

 

我们来了解一下这背后发生了什么。
 
两种方法,轻松上手ConfigMap!
 
现在注意数据部分,在数据部分下,你会找到键值对。从技术上来说,ConfigMap仅仅是键值存储。属性的名称是键,属性的值是值。应用程序的代码会要求你查找这些键值对。

 

为了在Java代码中使用此环境变量,我们需要编写以下代码:
 
两种方法,轻松上手ConfigMap!
 
下面的代码段定义了两个K8s环境变量,分别为“ SPRING_BOOT_HELLO_WORLD_APP_NAME”和“ SPRING_BOOT_HELLO_WORLD_DESC”。这些变量将从ConfigMap app-env-config获取值。需要重点关注的是键。
 
两种方法,轻松上手ConfigMap!
 
属性配置文件可以在单个文件中保存很多个属性,以在不同环境中运行应用程序。在Spring Boot应用程序中,属性保存在classpath下的application.properties文件中。我们来看一下打包在应用程序jar包中的application.properties文件。
 
两种方法,轻松上手ConfigMap!
 
我们正在使用命令kubectl create configmap从单个文件或从多个文件创建ConfigMap。

 

现在让我们查看完整的代码。
 
两种方法,轻松上手ConfigMap!

两种方法,轻松上手ConfigMap!
 

将ConfigMap挂载为文件

 

在本节中,我将说明如何使用ConfigMap挂载文件以外部化配置。在此示例中,我将使用ConfigMap来外部化application.properties文件。即使默认文件打包在jar中,也位于src / main / resources下。简单来说,我们将通过ConfigMap所提供的文件来覆盖默认文件。

 
第一步是从application.properties创建ConfigMap。让我们了解如何在K8s中存储此ConfigMap。
 
两种方法,轻松上手ConfigMap!
 
通过ConfigMap,我们将挂载application.properties文件到K8s集群中,并且可以在应用程序中使用它。请注意,数据部分包含了application.properties的内容,键是文件名。

  

现在,为了覆盖默认配置文件,我们需要(通过ConfigMap)将application.properties挂载到应用程序的classpath中。Spring Boot通过提供不同的选项来提供这一功能。SpringApplication在以下位置从application.properties文件加载属性,并将它们添加到Spring Environment:
 

  • 当前目录的/config 子目录

  • 当前目录

  • classpath / config包

  • The classpath root

 

如果你想了解更多信息,可以查阅官方文档:
 
https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config-application-property-files

 

最简单,最好的方法是将application.properties挂载在“ / config”目录中。
 
两种方法,轻松上手ConfigMap!
 
仔细检查挂载路径,请注意ConfigMap的名称应与我们在上面创建的app-file-configmap完全相同,键为文件名。另外,请确保将volume mount配置的名称更改为volume配置的名称。
 
两种方法,轻松上手ConfigMap!
 
这段代码说明了如何在application.properties文件中定义属性。如果使用Spring推荐的标准方法的话,这十分简单。具体而言,就是使用@Value 注释将属性值注入到变量中。

 

现在,我们可以继续进行ConfigMap示例应用程序了。我们来看一下完整的代码段。
 
两种方法,轻松上手ConfigMap!
 
让我们创建一个Docker镜像并将其上传到Dockerhub。在本例中,镜像名称是k8s-springboot-helloworld-configmap—app。

 

以下是K8S pod配置文件:
 
两种方法,轻松上手ConfigMap!
 
现在我们使用NodePort服务类型创建服务,以便可以从K8S集群外部使用Welcome服务。
 
两种方法,轻松上手ConfigMap!
 
现在,让我们把这些更改应用于K8S。
 

导航到浏览器并访问http://<minikube_ip>:<service_node_port>/welcome。在本例,应该是http:// 192.168.99.100:30880/welcome。
 

认真观察输出,返回的字符串是:
 
两种方法,轻松上手ConfigMap!
 
同时,检查代码中硬编码的环境变量的默认值,以及打包在jar中的application.properties的property默认值。你发现从ConfigMap中获取了环境变量和application.properties的值。

 

这个项目可以从我的Github中获取:
 
https://github.com/nikhilbhide/MicroServicesTutorial/tree/master/k8s_spring_boot_hello_world_config_map