兩種方法,輕鬆上手ConfigMap!
屬性配置檔案在任何應用程式中都非常重要。它們不僅可以讓應用程式具備靈活性,還能夠根據檔案中配置的值產生不同的功能。實際上,在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
如果你想了解更多資訊,可以查閱官方文件:
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的名稱應與我們在上面建立的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://
認真觀察輸出,返回的字串是:
同時,檢查程式碼中硬編碼的環境變數的預設值,以及打包在jar中的application.properties的property預設值。你發現從ConfigMap中獲取了環境變數和application.properties的值。
這個專案可以從我的Github中獲取:
https://github.com/nikhilbhide/MicroServicesTutorial/tree/master/k8s_spring_boot_hello_world_config_