說明

使用helmfile時，我們首先得了解helm的使用，以及如何開發一個helm chart。

helm是kubernetes的包管理工具。在實際的使用場景中我們涉及同時部署多個chart、區分不同的部署環境、版本控制等需求。基于此需求，可以使用helmfile工具。

helmfile通過helmfile文件幫助用戶管理和維護多個helm chart，可以來區分環境、實現版本控制。

github鏈接：https://github.com/roboll/helmfile

場景說明

我們在公有云場景或者私有化場景中，同一個產品可能涉及多套環境的配置，例如：每套環境部署依賴的環境差異、使用的數據庫、消息隊列中間件等實例的地址、賬號密碼等都不同。因此針對不同環境我們需要維護開發環境、測試環境、預生產環境、生產環境甚至多套環境的部署文件以及秘鑰文件，每個小小的改動將涉及多套環境配置的修改，這給運維人員增加了極大的負擔，以及多套環境的配置如何保持統一，也極大的考驗運維人員的細致程度，極大的增加了運維的復雜度。同時涉及的數據庫中間件實例的賬戶密碼的存放，也給運維流程增加了巨大的安全隱患。

基于上面的述求，這里可以將業務部署的各服務文件改造成helm chart,同時區分多套環境以及版本控制，我們使用helmfile來統一部署管理。涉及實例涉及的賬戶密碼，我們可以使用helm secrets來實現加密解密，以及來保證運維的安全性，從而極大的減少運維的復雜度。關于helm secrets的使用，我們在其他文章進行的詳細的介紹。

安裝

helmfile提供了多種安裝方式，具體可以參考：https://github.com/roboll/helmfile/releases

helmfile還支持運行在容器中，可以很方便的集成到CICD的流程中：

#helm2
$dockerrun--rm--net=host-v"${HOME}/.kube:/root/.kube"-v"${HOME}/.helm:/root/.helm"-v"${PWD}:/wd"--workdir/wdquay.io/roboll/helmfile:v0.135.0helmfilesync

#helm3
$dockerrun--rm--net=host-v"${HOME}/.kube:/root/.kube"-v"${HOME}/.config/helm:/root/.config/helm"-v"${PWD}:/wd"--workdir/wdquay.io/roboll/helmfile:helm3-v0.135.0helmfilesync

helmfile.yaml介紹

helmfile.yaml 是 helmfile 的核心文件，其用來聲明所有的配置。下面會簡要介紹一下，具體說明可以參考官方文檔：https://github.com/roboll/helmfile#configuration

#聲明repo配置
repositories:
-name:
#url:repourl
#可以設置基礎配置或tls認證
#certFile:certificate文件
#keyFile:key文件
#username:用戶名
#password:密碼

#helm二進制文件的路徑
helmBinary:path/to/helm3

#helm的一些默認設置，這些配置與`helmSUBCOMMAND`相同，可以通過這個配置聲明一些，默認的配置
helmDefaults:
tillerNamespace:tiller-namespace#dedicateddefaultkeyfortiller-namespace
tillerless:false#dedicateddefaultkeyfortillerless
kubeContext:kube-context#dedicateddefaultkeyforkube-context(--kube-context)
cleanupOnFail:false#dedicateddefaultkeyforhelmflag--cleanup-on-fail
#additionalandglobalargspassedtohelm(default"")
args:
-"--setk=v"
#verifythechartbeforeupgrading(onlyworkswithpackagedchartsnotdirectories)(defaultfalse)
verify:true
#waitfork8sresourcesvia--wait.(defaultfalse)
wait:true
#timeinsecondstowaitforanyindividualKubernetesoperation(likeJobsforhooks,andwaitsonpod/pvc/svc/deploymentreadiness)(default300)
timeout:600
#performspodsrestartfortheresourceifapplicable(defaultfalse)
recreatePods:true
#forcesresourceupdatethroughdelete/recreateifneeded(defaultfalse)
force:false
#whenusinghelm3.2+,automaticallycreatereleasenamespacesiftheydonotexist(defaulttrue)
createNamespace:true
...

#為helmfile中所有的release設置相同的label，可用于為所有release標記相同的版本
commonLabels:
hello:world

#設置release配置（支持多release）
releases:
#遠程chart示例（chart已經上傳到remote倉庫）
-name:vault#nameofthisrelease
namespace:vault#targetnamespace
createNamespace:true#helm3.2+automaticallycreatereleasenamespace(defaulttrue)
labels:#Arbitrarykeyvaluepairsforfilteringreleases
foo:bar
chart:roboll/vault-secret-manager#thechartbeinginstalledtocreatethisrelease,referencedby`repository/chart`syntax
version:~1.24.1#thesemverofthechart.rangeconstraintissupported
condition:vault.enabled#Thevalueslookupkeyforfilteringreleases.Correspondstothebooleanvalueof`vault.enabled`,where`vault`isanarbitraryvalue
missingFileHandler:Warn#settoeither"Error"or"Warn"."Error"instructshelmfiletofailwhenunabletofindavaluesorsecretsfile.When"Warn",itprintsthefileandcontinues.
#Valuesfilesusedforrenderingthechart
values:
#Valuefilespassedvia--values
-vault.yaml
#Inlinevalues,passedviaatemporaryvaluesfileand--values,sothatitdoesn'tsufferfromtypeissueslike--set
-address:https://vault.example.com
#Gotemplateavailableininlinevaluesandvaluesfiles.
-image:
#TheendresultismoreorlessYAML.Sodo`quote`topreventnumber-likestringsfromaccidentallyparsedintonumbers!
#Seehttps://github.com/roboll/helmfile/issues/608
tag:{{requiredEnv"IMAGE_TAG"|quote}}
#Otherwise:
#tag:"{{requiredEnv"IMAGE_TAG"}}"
#tag:!!string{{requiredEnv"IMAGE_TAG"}}
db:
username:{{requiredEnv"DB_USERNAME"}}
#valuetakenfromenvironmentvariable.Quotesarenecessary.Willthrowanerroriftheenvironmentvariableisnotset.$DB_PASSWORDneedstobesetinthecallingenvironmentex:exportDB_PASSWORD='password1'
password:{{requiredEnv"DB_PASSWORD"}}
proxy:
#Interpolateenvironmentvariablewithafixedstring
domain:{{requiredEnv"PLATFORM_ID"}}.my-domain.com
scheme:{{env"SCHEME"|default"https"}}
#Use`values`wheneverpossible!
#`set`translatestohelm's`--setkey=val`,thatisknowntosufferfromtypeissueslikehttps://github.com/roboll/helmfile/issues/608
set:
#singlevalueloadedfromalocalfile,translatesto--set-filefoo.config=path/to/file
-name:foo.config
file:path/to/file
#setasinglearrayvalueinanarray,translatesto--setbar[0]={1,2}
-name:bar[0]
values:
-1
-2
#setatemplatedvalue
-name:namespace
value:{{.Namespace}}
#willattempttodecryptitusinghelm-secretsplugin

#本地chart示例（chart保存在本地）
-name:grafana#nameofthisrelease
namespace:another#targetnamespace
chart:../my-charts/grafana#thechartbeinginstalledtocreatethisrelease,referencedbyrelativepathtolocalhelmfile
values:
-"../../my-values/grafana/values.yaml"#Valuesfile(relativepathtomanifest)
-./values/{{requiredEnv"PLATFORM_ENV"}}/config.yaml#Valuesfiletakenfrompathwithenvironmentvariable.$PLATFORM_ENVmustbesetinthecallingenvironment.
wait:true

#可以嵌套其他的helmfiles，支持從本地和遠程拉取helmfile
helmfiles:
-path:path/to/subhelmfile.yaml
#label選擇器可以過濾需要覆蓋的release
selectors:
-name=prometheus
#覆蓋value
values:
#使用文件覆蓋
-additional.values.yaml
#覆蓋單獨的key
-key1:val1
-#遠程拉取配置
path:git://github.com/cloudposse/helmfiles.git@releases/kiam.yaml?ref=0.40.0
#如果指向不存在路徑，則打印告警錯誤
missingFileHandler:Error

#多環境管理
environments:
#當沒有設置`--environmentNAME`時，使用default
default:
values:
#內容可以是文件路徑或者key:value
-environments/default/values.yaml
-myChartVer:1.0.0-dev
#"production"環境，當設置了`helmfile--environmentproductionsync`時
production:
values:
-environment/production/values.yaml
-myChartVer:1.0.0
#disablevaultreleaseprocessing
-vault:
enabled:false
##`secrets.yaml`isdecryptedby`helm-secrets`andavailablevia`{{.Environment.Values.KEY}}`
secrets:
-environment/production/secrets.yaml
#當占不到`environments.NAME.values`時，可以設置為"Error","Warn","Info","Debug"，默認是"Error"
missingFileHandler:Error

#分層管理，可以將所有文件合并，順序為：environments.yaml 

	

	helmfile調試

	這里，編排好相關的helmfile后，我們可以使用下面的命令進行調試

	
#查看目錄結構
$ls
README.orgenvironmentshelmhelmfilehelmfile.yamlreleases
#查看helmfile.yaml
$cathelmfile.yaml
environments:
#不指定環境時，默認使用默認測試環境
default:
values:
-environments/test/config.yaml
-environments/test/versions.yaml
-environments/test//namespaces.yaml
secrets:
-environments/test/secrets.yaml
test:
values:
-environments/test/config.yaml
-environments/test/versions.yaml
-environments/test/namespaces.yaml
secrets:
-environments/test/secrets.yaml
helmDefaults:
createNamespace:true
releases:
-name:password-secrets
kubeContext:{{.Values.kubeContext.service}}
namespace:{{.Values.namespaces.service}}
chart:helm/charts/secrets
values:
-releases/secrets.yaml.gotmpl
labels:
app:secrets

-name:web
kubeContext:{{.Values.kubeContext.business}}
namespace:{{.Values.namespaces.business}}
chart:helm/charts/web
values:
-releases/web.yaml.gotmpl
labels:
app:web
#helmfile調試
$helmfile-etesttemplate


	

	安裝chart

	
helmfile-etestsync


	

	helmfile更新或者刪除某個chart

	這里可以通過--selector指定label來進行更新或者刪除：

	
#更新web服務
helmfile-etest--selectorapp=websync
#刪除web服務
helmfile-etest--selectorapp=webdelete


	

	查看變更

	
#查看文件的變更信息
helmfile-etest--selectorapp=webdiff
#只查看文件的變更部分信息
helmfile-etest--selectorapp=webdiff--context4

	

	   審核編輯：彭靜