本节书摘来华章计算机《容器技术系列》一书中的第2章 ,第2.3节,孙宏亮 著, 更多章节内容可以访问云栖社区“华章计算机”公众号查看。
2.3 Docker命令执行
main函数执行到这个阶段,有以下内容需要为Docker命令的执行服务:创建完毕的Docker Client,docker命令中的请求参数(经flag解析后存放于flag.Arg())。也就是说,程序需要使用Docker Client来分析Docker命令中的请求参数,得出请求的类型,转义为Docker Server可以识别的请求之后,最终发送给Docker Server。
Docker Client主要完成两方面的工作:解析请求命令,得出请求类型;执行具体类型的请求。本节将从这两个方面深入分析Docker Client。
2.3.1 Docker Client解析请求命令
Docker Client解析请求命令的工作,在Docker命令执行部分第一个完成。创建Docker Client之后,回到main函数中,继续执行的源码如下(位于./do`
javascript
cker/docker/docker.go#L102-L110):
if err := cli.Cmd(flag.Args()...); err != nil {
if sterr, ok := err.(*utils.StatusError); ok {
if sterr.Status != "" {
log.Println(sterr.Status)
}
os.Exit(sterr.StatusCode)
}
log.Fatal(err)
}
学习以上源码可以发现,正如之前所说,Docker Client首先解析存放于flag.Args()中的具体请求参数,执行的函数为cli对象的Cmd函数。Cmd函数的定义如下(位于./docker/api/client/cli.go#L51-L61):
// Cmd executes the specified command
func (cli *DockerCli) Cmd(args ...string) error {
if len(args) > 0 {
method, exists := cli.getMethod(args[0])
if !exists {
fmt.Println("Error: Command not found:", args[0])
return cli.CmdHelp(args[1:]...)
}
return method(args[1:]...)
}
return cli.CmdHelp(args...)
}
由代码注释可知,Cmd函数执行具体的指令。在源码实现中,首先判断请求参数列表的长度是否大于0。若长度不大于0,则说明没有请求信息,返回docker命令的Help信息;若长度大于1,则说明有请求信息,那么Docker Client首先通过请求参数列表中的第一个元素args[0]来获取具体的请求方法method。若上述method方法不存在,则返回docker命令的Help信息,若存在,调用具体的method方法,参数为args[1]及其之后所有的请求参数。
还是以一个具体的docker命令为例,docker --daemon=false --version=false pull Image_Name。通过以上Docker Client的分析,可以总结出以下执行流程。
1)解析flag参数之后,Docker将docker请求参数"pull"和"Image_Name"存放于flag.Args()。
2)创建好的Docker Client为cli,cli执行cli.Cmd(flag.Args()…)。
3)Cmd函数中,通过args[0]也就是"pull",执行cli.getMethod(args[0]),获取method的名称。
4)在getMothod方法中,Docker通过处理最终返回method值为"CmdPull"。
5)最终执行method(args[1:]…)也就是CmdPull(args[1:]…)。
###2.3.2 Docker Client执行请求命令
上一小节通过一系列的命令解析,最终找到了具体的命令执行方法,本小节主要介绍Docker Client如何通过具体的执行方法,处理并发送请求。
不同的Docker尽管请求内容不同,但是请求执行流程大致相同,故本节依旧以一个例子来阐述其中的流程,例子为:docker pull Image_Name。该命令的作用为:DockerClient发起下载镜像的请求,最终由Docker Server接收请求,由Docker Daemon完成镜像的下载与存储。
Docker Client在执行docker pull Image_Name请求命令时,执行CmdPull函数,传入参数为args[1:]...,即Image_Name。源码实现位于./docker/api/client/command.go#L1183-L1224。
下面逐一分析CmdPull的源码实现。
cmd := cli.Subcmd("pull", "NAME[:TAG]", "Pull an image or a repository from the registry")
通过cli包中的Subcmd方法定义一个类型为Flagset的对象cmd。
tag := cmd.String([]string{"#t", "#-tag"}, "", "Download tagged image in a repository")
为cmd对象定义一个类型为String的flag,名为"#t"或"#-tag",初始值为空,目前这个flag参数基本已经被弃用。
if err := cmd.Parse(args); err != nil {
return nil
}
将args参数进行第二次flag参数解析,解析过程中,先提取出是否有符合tag这个flag的参数。若有,将其赋值给tag参数,其余的参数存入cmd.NArg();若没有,则将所有的参数存入cmd.NArg()中。
if cmd.NArg() != 1 {
cmd.Usage()
return nil
}
判断经过flag解析后的参数列表,若参数列表中参数的个数不为1,则说明需要下拉多个镜像或者没有指定下拉镜像名称,pull命令均不支持,则调用错误处理方法cmd.Usage(),并返回nil。
var (
v = url.Values{}
remote = cmd.Arg(0)
)
v.Set("fromImage", remote)
if *tag == "" {
v.Set("tag", *tag)
}
创建一个map类型的变量v,该变量用于存放下拉镜像时所需的URL参数;随后将参数列表的第一个值cmd.Arg(0)赋给remote变量,并将remote作为键将fromImage的值添加至v。
remote, _ = parsers.ParseRepositoryTag(remote)
// Resolve the Repository name from fqn to hostname + name
hostname, _, err := registry.ResolveRepositoryName(remote)
if err != nil {
return err
}
通过remote变量首先得到镜像的repository名称,并赋给remote自身,随后通过解析改变后的remote,得出镜像所在的host地址,即Docker Registry的地址。若用户没有制定Docker Registry的地址,则Docker默认地址为Doc```javascript
ker Hub地址https://index.docker.io/v1/。
cli.LoadConfigFile()
// Resolve the Auth config relevant for this server
authConfig := cli.configFile.ResolveAuthConfig(hostname)
通过cli对象获取与Docker Server通信所需要的认证配置信息。
pull := func(authConfig registry.AuthConfig) error {
buf, err := json.Marshal(authConfig)
if err != nil {
return err
}
registryAuthHeader := []string{
base64.URLEncoding.EncodeToString(buf),
}
return cli.stream("POST", "/images/create?"+v.Encode(), nil, cli.out, map[string][]string{
"X-Registry-Auth": registryAuthHeader,
})
}
定义一个名为pull的函数,传入的参数类型为registry.AuthConfig,返回类型为error。函数执行块中最主要的内容为:cli.stream(……)部分。该部分具体向Docker Server发送POST请求,请求的url为"/images/create?"+v.Encode(),请求的认证信息为:
map[string][]string{"X-Registry-Auth": registryAuthHeader,}。
if err := pull(authConfig); err != nil {
if strings.Contains(err.Error(), "Status 401") {
fmt.Fprintln(cli.out, "\nPlease login prior to pull:")
if err := cli.CmdLogin(hostname); err != nil {
return err
}
authConfig := cli.configFile.ResolveAuthConfig(hostname)
return pull(authConfig)
}
return err
}
由于上一个步骤只是定义pull函数,这一步骤具体调用执行pull函数,实现实际意义上的下载请求发送。若返回成功则表明请求完成,程序直接退出,若返回错误,则做相应的错误处理。若返回错误为401,则表示用户下载的镜像必须用户先登录,随即Docker Client转至登录环节,完成之后,继续执行pull函数,若完成则最终返回。
以上便是pull请求的全部执行过程,其他请求的执行在流程上也是大同小异。总之,请求执行过程中,大多都是将命令行中关于请求的参数进行初步处理,并添加相应的辅助信息,最终通过指定的协议向Docker Server发送Docker Client和Docker Server约定好的API请求。