一、Cobra簡(jiǎn)介
- cobra：既是一個(gè)用來創(chuàng)建強(qiáng)大的現(xiàn)代CLI命令行的golang庫，也是一個(gè)生成程序應(yīng)用和命令行文件的程序.
官網(wǎng)地址： https://github.com/spf13/cobra
Cobra主要提供的功能
* 簡(jiǎn)易的子命令行模式，如 app server， app fetch等等
* 完全兼容posix命令行模式
* 嵌套子命令subcommand
* 支持全局，局部，串聯(lián)flags
* 使用Cobra很容易的生成應(yīng)用程序和命令，使用cobra create appname和cobra add cmdname
* 如果命令輸入錯(cuò)誤，將提供智能建議，如 app srver，將提示srver沒有，是否是app server
* 自動(dòng)生成commands和flags的幫助信息
* 自動(dòng)生成詳細(xì)的help信息，如app help
* 自動(dòng)識(shí)別-h，--help幫助flag
* 自動(dòng)生成應(yīng)用程序在bash下命令自動(dòng)完成功能
* 自動(dòng)生成應(yīng)用程序的man手冊(cè)
* 命令行別名
* 自定義help和usage信息
* 可選的緊密集成的[viper](http://github.com/spf13/viper) apps
獲取和使用
- 獲取和初始化
[tips] cobra init 是在gopath 目錄下進(jìn)行創(chuàng)建的
1. 使用cobra包
go get -u github.com/spf13/cobra/cobra
2. 使用cobra創(chuàng)建項(xiàng)目
cobra init demo
3. 最新創(chuàng)建項(xiàng)目語法：
cobra init --pkg-name demo demo
參數(shù)--pkg-name如下圖所示
-
大致目錄
image.png
Cobra中的重要三個(gè)概念
- commands 代表行為
- arguments 代表命令行參數(shù)
- flags 代表命令行的選項(xiàng)
一般執(zhí)行格式如下：appname command args --flag
二、k8s中源碼解析之cobra
1.1 下面以kubeadm為例進(jìn)行說明：
入口函數(shù)在： cmd/kubeadm/kubeadm.go
image.png
1.2 里面直接調(diào)用了Run方法，我們看看app.Run()
image.png
大致分析：
Run()方法在設(shè)置了一系列參數(shù)屬性后，直接創(chuàng)建了一個(gè)cmd對(duì)象，然后返回cmd.Execute()啟動(dòng)kubeadm模塊
這里使用 pflag設(shè)置相關(guān)參數(shù)屬性，調(diào)用AddGoGlagSet(flag.CommandLine)兼容golang 的flag包
cmd.NewKubeadmCommand(os.Stdin, os.Stdout, os.Stderr) 方法是cobra的命令行的根目錄
1.3 查看NewKubeadmCommand()實(shí)現(xiàn)方法
func NewKubeadmCommand(in io.Reader, out, err io.Writer) *cobra.Command {
var rootfsPath string
cmds := &cobra.Command{
Use: "kubeadm",
Short: "kubeadm: easily bootstrap a secure Kubernetes cluster",
Long: dedent.Dedent(`
┌──────────────────────────────────────────────────────────┐
│ KUBEADM │
│ Easily bootstrap a secure Kubernetes cluster │
│ │
│ Please give us feedback at: │
│ https://github.com/kubernetes/kubeadm/issues │
└──────────────────────────────────────────────────────────┘
Example usage:
Create a two-machine cluster with one control-plane node
(which controls the cluster), and one worker node
(where your workloads, like Pods and Deployments run).
┌──────────────────────────────────────────────────────────┐
│ On the first machine: │
├──────────────────────────────────────────────────────────┤
│ control-plane# kubeadm init │
└──────────────────────────────────────────────────────────┘
┌──────────────────────────────────────────────────────────┐
│ On the second machine: │
├──────────────────────────────────────────────────────────┤
│ worker# kubeadm join <arguments-returned-from-init> │
└──────────────────────────────────────────────────────────┘
You can then repeat the second step on as many other machines as you like.
`),
SilenceErrors: true,
SilenceUsage: true,
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
if rootfsPath != "" {
if err := kubeadmutil.Chroot(rootfsPath); err != nil {
return err
}
}
return nil
},
}
cmds.ResetFlags()
cmds.AddCommand(NewCmdCompletion(out, ""))
cmds.AddCommand(NewCmdConfig(out))
cmds.AddCommand(NewCmdInit(out, nil))
cmds.AddCommand(NewCmdJoin(out, nil))
cmds.AddCommand(NewCmdReset(in, out, nil))
cmds.AddCommand(NewCmdVersion(out))
cmds.AddCommand(NewCmdToken(out, err))
cmds.AddCommand(upgrade.NewCmdUpgrade(out))
cmds.AddCommand(alpha.NewCmdAlpha(in, out))
options.AddKubeadmOtherFlags(cmds.PersistentFlags(), &rootfsPath)
return cmds
}
- 首先構(gòu)建 kubeadm 根命令對(duì)象cmds(反應(yīng)到命令行也就是kubeadm)
-
然后添加子命令init,join 到cmds對(duì)象
我們通過NewCmdVersion根命令進(jìn)行分析：
NewCmdVersion()方法
image.png - 通過運(yùn)行RunVersion()獲取kubeadm的版本信息
- 通過cmd.Flags()綁定 kubeadm version 后面識(shí)別的相關(guān)參數(shù)
- 將參數(shù)綁定到output上面
獲取輸入?yún)?shù):
flag, err := cmd.Flags().GetString("output")
三、分析總結(jié)
- kubernetes 通過cobra的 command生成一個(gè)父子樹
- 執(zhí)行過程如下：
1.1 cmd.Excute()啟動(dòng)整個(gè)命令執(zhí)行過程，
1.2 cmd跟對(duì)象下通過add.Command添加相關(guān)子對(duì)象，
1.3 最終命令執(zhí)行落實(shí)到子命令對(duì)象中的RunE || Run: func(cmd *cobra.Command, args []string) error{}
1.4 cmd.Flags()設(shè)置命令參數(shù)
image.png
