K8s kustomize 使用指南: 標(biāo)注和注釋

kustomize 是 sig-cli 的一個子項(xiàng)目般渡,它的設(shè)計目的是給 kubernetes 的用戶提供一種可以重復(fù)使用配置的聲明式應(yīng)用管理况既,從而在配置工作中用戶只需要管理和維護(hù) kubernetes 的原>生 API 對象,而不需要使用復(fù)雜的模版。詳細(xì)介紹請見kustomize 初體驗(yàn).

在之前介紹中接奈,我們學(xué)習(xí)到了 kustomize 可以為一組 k8s API 對象添加共同的名稱前綴咐柜。 類似地兼蜈,在 k8s 應(yīng)用的管理和維護(hù)中,我們通常需要給一組互相關(guān)聯(lián)的 API 對象添加共同的標(biāo)注和注
釋拙友,以記錄它所處的環(huán)境或應(yīng)用为狸。比如在一個應(yīng)用中,包含兩個 MySQL 的數(shù)據(jù)庫遗契,其中一個為微服務(wù) foo 提供數(shù)據(jù)而另
一個為微服務(wù) bar 提供數(shù)據(jù)辐棒。我們可以為這兩組 MySQL 的 API 添加標(biāo)注或注釋,從而得到如下效果

foo所對應(yīng)的MySQL

labels:
    app: foo
annotation:
   application: foo

bar所對應(yīng)的MySQL

labels:
    app: bar
annotation:
   application: bar

當(dāng)應(yīng)用規(guī)模很小,僅有幾個微服務(wù)時漾根,我們可以手動給每一個API對象添加標(biāo)注和注釋泰涂。當(dāng)應(yīng)用規(guī)模擴(kuò)大到幾十甚至上百>個為服務(wù)時,依次為每一個 API 對象添加標(biāo)注和注釋就會變得繁雜和不易維護(hù)辐怕。我們需要一種能簡單易行的方法來添加>和更改標(biāo)注或注釋逼蒙。而 kustomize 恰恰提供了這種簡單方便的標(biāo)注使用。這篇文章將通過一個 MySQL 實(shí)例來詳細(xì)介紹和
展示 kustomize 在標(biāo)注和注釋方面的功能寄疏。

可以通過如下兩種不同方式來安裝 kustomize

下載壓縮包是牢,kustomize 提供Linux,Darwin陕截,和windows三個版本的壓縮包驳棱。

如果本地機(jī)器Go的版本在1.10.1以上,可以通過 go get 來直接安裝

  Go get github.com/kubernetes-sigs/kustomize

首先來創(chuàng)建一個 MySQL 的 base艘策。base 包含了若干 YAML 文件蹈胡,這些文件聲明了部署一個MySQL數(shù)據(jù)庫所需要的全部 API對象。

BASE=$(mktemp -d)

CONTENT="https://raw.githubusercontent.com\
/Liujingfang1/mysql\
/master"

curl -s -o "$BASE/#1.yaml" "$CONTENT/\
/{deployment,service,configmap,kustomization}.yaml"

將這些文件下載到本地之后朋蔫,我們可以看到 $BASE/kustomization.yaml 包含如下內(nèi)容

resources:
-deployment.yaml
-service.yaml
-configmap.yaml

運(yùn)行 kustomize build $BASE罚渐,將得到如下輸出。

apiVersion: v1
data:
  password: admin
kind: ConfigMap
metadata:
  name: mysql-pass
---
apiVersion: v1
kind: Service
metadata:
  labels:
    app: mysql
  name: mysql
spec:
  ports:
  - port: 3306
  selector:
    app: mysql
---
apiVersion: apps/v1beta2
kind: Deployment
metadata:
  labels:
    app: mysql
  name: mysql
spec:
  selector:
    matchLabels:
      app: mysql
  strategy:
    type: Recreate
  template:
    metadata:
      labels:
        app: mysql
    spec:
      containers:
      - env:
        - name: MYSQL_ROOT_PASSWORD
          valueFrom:
            configMapKeyRef:
              key: password
              name: mysql-pass
        image: mysql:5.6
        name: mysql
        ports:
        - containerPort: 3306
          name: mysql
        volumeMounts:
        - mountPath: /var/lib/mysql
          name: mysql-persistent-storage
      volumes:
      - emptyDir: {}
        name: mysql-persistent-storage

可以看出這個 MySQL 應(yīng)用由三個k8s API對象所組成:

  • ConfigMap
  • Deployment
  • Service

其中 Deployment 對象通過 configMapKeyRef 來讀取 ConfigMap 中的定義的 password驯妄,然后講環(huán)境變量 MYSQL_ROOT_PASSWORD 設(shè)為這個password荷并。

打開 $BASE/kustomization.yaml, 添加標(biāo)注和注釋

commonLabels:
  app: foo
  team: Beijing
commonAnnotations:
  application: foo
  owners: Xiaoming,Damao

運(yùn)行 kustomize build $BASE青扔, 將得到如下輸出

apiVersion: v1
data:
  password: admin
kind: ConfigMap
metadata:
  annotations:
    application: foo
    owners: Xiaoming,Damao
  labels:
    app: foo
    team: Beijing
  name: mysql-pass
---
apiVersion: v1
kind: Service
metadata:
  annotations:
    application: foo
    owners: Xiaoming,Damao
  labels:
    app: foo
    team: Beijing
  name: mysql
spec:
  ports:
  - port: 3306
  selector:
    app: foo
    team: Beijing
---
apiVersion: apps/v1beta2
kind: Deployment
metadata:
  annotations:
    application: foo
    owners: Xiaoming,Damao
  labels:
    app: foo
    team: Beijing
  name: mysql
spec:
  selector:
    matchLabels:
      app: foo
      team: Beijing
  strategy:
    type: Recreate
  template:
    metadata:
      annotations:
        application: foo
        owners: Xiaoming,Damao
      labels:
        app: foo
        team: Beijing
    spec:
      containers:
      - env:
        - name: MYSQL_ROOT_PASSWORD
          valueFrom:
            configMapKeyRef:
              key: password
              name: mysql-pass
        image: mysql:5.6
        name: mysql
        ports:
        - containerPort: 3306
          name: mysql
        volumeMounts:
        - mountPath: /var/lib/mysql
          name: mysql-persistent-storage
      volumes:
      - emptyDir: {}
        name: mysql-persistent-storage

通過在 kustomization.yaml 添加標(biāo)注和注釋源织,該 MySQL 應(yīng)用中的三個對象都添加了同樣的標(biāo)注和注釋。

【總結(jié)】kustomize支持添加標(biāo)注和注釋微猖,這些標(biāo)注和注釋會加在每一個它所管理的API對象上谈息。Kustomize還會相應(yīng)地更>新API對象的matchLabels。在實(shí)踐中凛剥,針對不同的環(huán)境或應(yīng)用場景侠仇,用戶可以設(shè)置不同的標(biāo)注和注釋。

參考資料

kubernetes-sigs/kustomize
Kustomize blogpost

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末犁珠,一起剝皮案震驚了整個濱河市逻炊,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌犁享,老刑警劉巖余素,帶你破解...
    沈念sama閱讀 217,734評論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異炊昆,居然都是意外死亡桨吊,警方通過查閱死者的電腦和手機(jī)威根,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,931評論 3 394
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來视乐,“玉大人医窿,你說我怎么就攤上這事〈读郑” “怎么了?”我有些...
    開封第一講書人閱讀 164,133評論 0 354
  • 文/不壞的土叔 我叫張陵卷要,是天一觀的道長渣聚。 經(jīng)常有香客問我,道長僧叉,這世上最難降的妖魔是什么奕枝? 我笑而不...
    開封第一講書人閱讀 58,532評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮瓶堕,結(jié)果婚禮上隘道,老公的妹妹穿的比我還像新娘。我一直安慰自己郎笆,他們只是感情好谭梗,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,585評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著宛蚓,像睡著了一般激捏。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上凄吏,一...
    開封第一講書人閱讀 51,462評論 1 302
  • 那天远舅,我揣著相機(jī)與錄音,去河邊找鬼痕钢。 笑死图柏,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的任连。 我是一名探鬼主播蚤吹,決...
    沈念sama閱讀 40,262評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼课梳!你這毒婦竟也來了距辆?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,153評論 0 276
  • 序言:老撾萬榮一對情侶失蹤暮刃,失蹤者是張志新(化名)和其女友劉穎跨算,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體椭懊,經(jīng)...
    沈念sama閱讀 45,587評論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡诸蚕,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,792評論 3 336
  • 正文 我和宋清朗相戀三年步势,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片背犯。...
    茶點(diǎn)故事閱讀 39,919評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡坏瘩,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出漠魏,到底是詐尸還是另有隱情倔矾,我是刑警寧澤,帶...
    沈念sama閱讀 35,635評論 5 345
  • 正文 年R本政府宣布柱锹,位于F島的核電站哪自,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏禁熏。R本人自食惡果不足惜壤巷,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,237評論 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望瞧毙。 院中可真熱鬧胧华,春花似錦、人聲如沸宙彪。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,855評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽释漆。三九已至铅忿,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間灵汪,已是汗流浹背檀训。 一陣腳步聲響...
    開封第一講書人閱讀 32,983評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留享言,地道東北人峻凫。 一個月前我還...
    沈念sama閱讀 48,048評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像览露,于是被迫代替她去往敵國和親荧琼。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,864評論 2 354

推薦閱讀更多精彩內(nèi)容