一、Cobra简介
- cobra：既是一个用来创建强大的现代CLI命令行的golang库，也是一个生成程序应用和命令行文件的程序.
官网地址： https://github.com/spf13/cobra
Cobra主要提供的功能
* 简易的子命令行模式，如 app server， app fetch等等
* 完全兼容posix命令行模式
* 嵌套子命令subcommand
* 支持全局，局部，串联flags
* 使用Cobra很容易的生成应用程序和命令，使用cobra create appname和cobra add cmdname
* 如果命令输入错误，将提供智能建议，如 app srver，将提示srver没有，是否是app server
* 自动生成commands和flags的帮助信息
* 自动生成详细的help信息，如app help
* 自动识别-h，--help帮助flag
* 自动生成应用程序在bash下命令自动完成功能
* 自动生成应用程序的man手册
* 命令行别名
* 自定义help和usage信息
* 可选的紧密集成的[viper](http://github.com/spf13/viper) apps
获取和使用
- 获取和初始化
[tips] cobra init 是在gopath 目录下进行创建的
1. 使用cobra包
go get -u github.com/spf13/cobra/cobra
2. 使用cobra创建项目
cobra init demo
3. 最新创建项目语法：
cobra init --pkg-name demo demo
参数--pkg-name如下图所示
-
大致目录
image.png
Cobra中的重要三个概念
- commands 代表行为
- arguments 代表命令行参数
- flags 代表命令行的选项
一般执行格式如下：appname command args --flag
二、k8s中源码解析之cobra
1.1 下面以kubeadm为例进行说明：
入口函数在： cmd/kubeadm/kubeadm.go
image.png
1.2 里面直接调用了Run方法，我们看看app.Run()
image.png
大致分析：
Run()方法在设置了一系列参数属性后，直接创建了一个cmd对象，然后返回cmd.Execute()启动kubeadm模块
这里使用 pflag设置相关参数属性，调用AddGoGlagSet(flag.CommandLine)兼容golang 的flag包
cmd.NewKubeadmCommand(os.Stdin, os.Stdout, os.Stderr) 方法是cobra的命令行的根目录
1.3 查看NewKubeadmCommand()实现方法
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
}
- 首先构建 kubeadm 根命令对象cmds(反应到命令行也就是kubeadm)
-
然后添加子命令init,join 到cmds对象
我们通过NewCmdVersion根命令进行分析：
NewCmdVersion()方法
image.png - 通过运行RunVersion()获取kubeadm的版本信息
- 通过cmd.Flags()绑定 kubeadm version 后面识别的相关参数
- 将参数绑定到output上面
获取输入参数:
flag, err := cmd.Flags().GetString("output")
三、分析总结
- kubernetes 通过cobra的 command生成一个父子树
- 执行过程如下：
1.1 cmd.Excute()启动整个命令执行过程，
1.2 cmd跟对象下通过add.Command添加相关子对象，
1.3 最终命令执行落实到子命令对象中的RunE || Run: func(cmd *cobra.Command, args []string) error{}
1.4 cmd.Flags()设置命令参数
image.png
