這次要介紹的是一個用於驗證 Kubernetes 對象文檔結構的小工具：kubeval。它能夠對一個或多個 Kubernetes 或 OpenShift 的對象文檔進行校驗。它所依賴的 Schema 數據來自於 Open API 所生成的內容，所以校驗過程中無需和 API Server 進行交互，也正因如此，對各種第三方 CRD 的支持也暫時無能為力，另外還需要有 Schema 庫的支持。
這個工具在直接和 Kubernetes 交互的環境中有點畫蛇添足，但是如果是在 CICD Pipeline 中，或者是沒有 Kubernetes 集群可用的情況下，就很趁手了。
安裝
Linux
直接下載安裝版即可。
wget https://github.com/instrumenta/kubeval/releases/download/0.9.2/kubeval-linux-amd64.tar.gz
tar xf kubeval-linux-amd64.tar.gzsudo cp kubeval /usr/local/bin
MacOS
可以下載安裝：
wget https://github.com/instrumenta/kubeval/releases/download/0.9.2/kubeval-darwin-amd64.tar.gz
tar xf kubeval-darwin-amd64.tar.gzsudo cp kubeval /usr/local/bin
也可以使用 Homebrew：
brew tap instrumenta/instrumenta
brew install kubeval
Windows
除了在 Release 頁面下載 zip 包之外，還可以用 scoop 進行安裝：
scoop bucket add instrumenta https://github.com/instrumenta/bucket-instrumenta
scoop install kubeval
Docker
還提供了 Docker 的運行方式，例如：
$ docker run -it -v `pwd`/fixtures:/fixtures garethr/kubeval fixtures/*
Missing a kind key in /fixtures/blank.yaml
The document fixtures/int_or_string.yaml contains a valid Service
The document fixtures/int_or_string_false.yaml contains an invalid Deployment
--> spec.template.spec.containers.0.env.0.value: Invalid type. Expected: string, given: integer
The document fixtures/invalid.yaml contains an invalid ReplicationController
--> spec.replicas: Invalid type. Expected: integer, given: string
Missing a kind key in /fixtures/missing-kind.yaml
The document fixtures/valid.json contains a valid Deployment
The document fixtures/valid.yaml contains a valid ReplicationController
使用
$ kubeval --help
Validate a Kubernetes YAML file against the relevant schema
Usage:
kubeval <file> [file...] [flags]
Flags:
-f, --filename string filename to be displayed when testing manifests read from stdin (default "stdin")
-h, --help help for kubeval
-v, --kubernetes-version string Version of Kubernetes to validate against (default "master")
--openshift Use OpenShift schemas instead of upstream Kubernetes
--schema-location string Base URL used to download schemas. Can also be specified with the environment variable KUBEVAL_SCHEMA_LOCATION (default "https://kubernetesjsonschema.dev")
--strict Disallow additional properties not in schema
--version version for kubeval
/<file>
參數很少，但是都比較有用：
- -v：指定 Kubernetes 版本，例如 1.14.2。
- --openshift：對 Openshift 對象進行校驗。
- --schema-location：指定 Schema 庫的位置，缺省為 https://kubernetesjsonschema.dev，可以使用環境變量 KUBEVAL_SCHEMA_LOCATION。
- --strict：禁止出現 Schema 中未規定的字段。
例如：
$ kubeval sleep.yaml
The document sleep.yaml contains a valid ServiceAccount
The document sleep.yaml contains a valid Service
The document sleep.yaml contains a valid Deployment
或者也可以使用管道：
$ cat sleep.yaml|kubeval
The document stdin contains a valid ServiceAccount
The document stdin contains a valid Service
The document stdin contains a valid Deployment
指定版本進行校驗：
$ kubeval -v 1.10.0 sleep.yaml
The document sleep.yaml contains a valid ServiceAccount
The document sleep.yaml contains a valid Service
The document sleep.yaml contains a valid Deployment
使用自己的 Schema 庫
前面提到過一個參數：--schema-location，推測應該是用於在無法訪問缺省模式庫的時候的替補方案，要建立自己的模式庫也很方便，只要使用 git 獲取在線內容，並使用 Web Server 或者本地文件系統提供服務就可以了：
$ cd /doc
$ git clone https://github.com/instrumenta/kubernetes-json-schema
正克隆到 'kubernetes-json-schema'...
...
$ kubeval --schema-location file:///doc/kubernetes-json-schema test.yaml
The document test.yaml contains a valid Service
問題
似乎目前對 1.8 之前的版本支持還不夠好，慎用。
參考
- 項目地址：https://github.com/instrumenta/kubeval
- 文檔結構庫：https://github.com/instrumenta/kubernetes-json-schema
- 使用說明：https://kubeval.instrumenta.dev/
分享到:
閱讀更多 偽架構師 的文章
