屬性配置文件在任何應用程序中都非常重要。它們不僅可以讓應用程序具備靈活性,還能夠根據文件中配置的值產生不同的功能。實際上,在staging、開發、測試、UAT或生產環境中,我們都使用屬性配置文件來驅動不同的行為。
通常情況下,屬性配置文件會與代碼一起打包,並且整個程序包都部署在執行環境中。這一方法中,如果你想更改任何配置(即便配置文件中也發生了更改),你需要重新發布代碼。盡管這種方法行之有效,但是對於現在而言,效率還是太低了。因此我們需要一種外部化的配置。
在本文中,我將闡述Kubernetes如何為容器提供外部化、靈活的配置以及可移植性。ConfigMap主要是為了讓應用程序的配置和部署解耦,這一功能可以讓容器化應用程序具備可移植性。
如果你對Spring Cloud的生態很熟悉,那么接下來你會發現ConfigMap與Spring Cloud server十分類似。這里有兩種使用ConfigMap的方法:
-
將ConfigMap作為一種環境變量
-
將ConfigMap掛載為文件
讓我們開始進行實踐!我們將使用一個簡單的應用程序,基於Spring Boot、Docker和Kubernetes進行演示。
將ConfigMap作為一種環境變量
在本例中,我們將在Kubernetes中創建一個新的環境變量,並將其用於代碼中。在Java中,可以通過System.getenv(String) API在代碼中使用環境變量。在常規Java應用程序中,可以在J2EE應用程序容器(如Oracle WLS或IBM WAS)中設置環境變量,也可以在OS中設置環境變量。然而,在Kubernetes中情況並不相同。要使用環境變量,我們必須根據literal創建配置映射。
通過kubectl create configmap
命令,我們創建了兩個環境變量:app.name 和 app.desc。
我們來了解一下這背后發生了什么。
現在注意數據部分,在數據部分下,你會找到鍵值對。從技術上來說,ConfigMap僅僅是鍵值存儲。屬性的名稱是鍵,屬性的值是值。應用程序的代碼會要求你查找這些鍵值對。
為了在Java代碼中使用此環境變量,我們需要編寫以下代碼:
下面的代碼段定義了兩個K8s環境變量,分別為“ SPRING_BOOT_HELLO_WORLD_APP_NAME
”和“ SPRING_BOOT_HELLO_WORLD_DESC
”。這些變量將從ConfigMap app-env-config獲取值。需要重點關注的是鍵。
屬性配置文件可以在單個文件中保存很多個屬性,以在不同環境中運行應用程序。在Spring Boot應用程序中,屬性保存在classpath下的application.properties文件中。我們來看一下打包在應用程序jar包中的application.properties文件。
我們正在使用命令kubectl create configmap從單個文件或從多個文件創建ConfigMap。
現在讓我們查看完整的代碼。
將ConfigMap掛載為文件
在本節中,我將說明如何使用ConfigMap掛載文件以外部化配置。在此示例中,我將使用ConfigMap來外部化application.properties
文件。即使默認文件打包在jar中,也位於src / main / resources下。簡單來說,我們將通過ConfigMap所提供的文件來覆蓋默認文件。
第一步是從application.properties
創建ConfigMap。讓我們了解如何在K8s中存儲此ConfigMap。
通過ConfigMap,我們將掛載application.properties文件到K8s集群中,並且可以在應用程序中使用它。請注意,數據部分包含了application.properties的內容,鍵是文件名。
現在,為了覆蓋默認配置文件,我們需要(通過ConfigMap)將application.properties掛載到應用程序的classpath中。Spring Boot通過提供不同的選項來提供這一功能。SpringApplication在以下位置從application.properties文件加載屬性,並將它們添加到Spring Environment:
-
當前目錄的/config 子目錄
-
當前目錄
-
classpath / config包
-
The classpath root
如果你想了解更多信息,可以查閱官方文檔:
最簡單,最好的方法是將application.properties掛載在“ / config”目錄中。
仔細檢查掛載路徑,請注意ConfigMap的名稱應與我們在上面創建的app-file-configmap完全相同,鍵為文件名。另外,請確保將volume mount配置的名稱更改為volume配置的名稱。
這段代碼說明了如何在application.properties文件中定義屬性。如果使用Spring推薦的標准方法的話,這十分簡單。具體而言,就是使用@Value
注釋將屬性值注入到變量中。
現在,我們可以繼續進行ConfigMap示例應用程序了。我們來看一下完整的代碼段。
讓我們創建一個Docker鏡像並將其上傳到Dockerhub。在本例中,鏡像名稱是k8s-springboot-helloworld-configmap—app。
以下是K8S pod配置文件:
現在我們使用NodePort服務類型創建服務,以便可以從K8S集群外部使用Welcome服務。
現在,讓我們把這些更改應用於K8S。
導航到瀏覽器並訪問http://<minikube_ip>:<service_node_port>/welcome。在本例,應該是http:// 192.168.99.100:30880/welcome。
認真觀察輸出,返回的字符串是:
同時,檢查代碼中硬編碼的環境變量的默認值,以及打包在jar中的application.properties的property默認值。你發現從ConfigMap中獲取了環境變量和application.properties的值。
這個項目可以從我的Github中獲取: