1、Docker Client 的创建
Docker Client 的创建,实质上是 Docker 用户通过可执行文件 docker,与 Docker Server 建立联系的客户端。
docker 源代码运行的流程图如下:
1.1 Docker 命令的 flag 参数解析
例1:
Docker Server 的启动命令为:docker -d 或 docker --daemon=true
Docker Client 的启动命令为:docker --daemon=false ps 、docker pull NAME等
从上述例子中可以把请求中的参数分为两类
1)命令行参数:docker 程序运行时所需要提供的参数,如:-d、--daemon=true、--daemon=false等,我们通常可以称之为 flag 参数
2)请求参数:docker 发送给Docker Server 的实际请求参数,如:ps 、pull NAME等
例2:
docker 命令为例,docker –daemon=false –version=false pull Name
根据流程图可以分析流程为:
1)解析 flag 参数之后,将 docker 请求参数”pull”和“Name”存放于 flag.Args();
2)创建好的 Docker Client 为 cli,cli 执行 cli.Cmd(flag.Args()…);
3)在 Cmd 函数中,通过 args[0] 也就是”pull”, 执行 cli.getMethod(args[0]),获取 method 的名称;
4)在 getMothod 方法中,通过处理最终返回 method 的值为”CmdPull”;
5)最终执行 method(args[1:]…) 也就是 CmdPull(args[1:]…)。
2、Docker 命令执行
main 函数执行到目前为止,有以下内容需要为 Docker 命令的执行服务:创建完毕的 Docker Client,docker 命令中的请求参数(经 flag 解析后存放于 flag.Arg())。也就是说,需要使用 Docker Client 来分析 docker 命令中的请求参数,并最终发送相应请求给 Docker Server。
4.1 Docker Client 解析请求命令
Docker Client 解析请求命令的工作,在 Docker 命令执行部分第一个完成,直接进入 main 函数之后的源码部分
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)
}
查阅以上源码,可以发现,正如之前所说,首先解析存放于 flag.Args() 中的具体请求参数,执行的函数为 cli 对象的 Cmd 函数。进入[./docker/api/client/cli.go 的 Cmd 函数]
// 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,若不是的话,说明没有请求信息,返回 docker 命令的 Help 信息;若长度大于 0 的话,说明有请求信息,则首先通过请求参数列表中的第一个元素 args[0] 来获取具体的 method 的方法。如果上述 method 方法不存在,则返回 docker 命令的 Help 信息,若存在的话,调用具体的 method 方法,参数为 args[1] 及其之后所有的请求参数。
还是以一个具体的 docker 命令为例,docker –daemon=false –version=false pull Name。通过以上的分析,可以总结出以下操作流程:
(1) 解析 flag 参数之后,将 docker 请求参数”pull”和“Name”存放于 flag.Args();
(2) 创建好的 Docker Client 为 cli,cli 执行 cli.Cmd(flag.Args()…);
在 Cmd 函数中,通过 args[0] 也就是”pull”, 执行 cli.getMethod(args[0]),获取 method 的名称;
(3) 在 getMothod 方法中,通过处理最终返回 method 的值为”CmdPull”;
(4) 最终执行 method(args[1:]…) 也就是 CmdPull(args[1:]…)。
4.2 Docker Client 执行请求命令
上一节通过一系列的命令解析,最终找到了具体的命令的执行方法,本节内容主要介绍 Docker Client 如何通过该执行方法处理并发送请求。
由于不同的请求内容不同,执行流程大致相同,本节依旧以一个例子来阐述其中的流程,例子为:docker pull NAME。
Docker Client 在执行以上请求命令的时候,会执行 CmdPull 函数,传入参数为 args[1:]…。源码具体为./docker/api/client/command.go 中的CmdPull 函数。
以下逐一分析CmdPull 的源码实现。
(1) 通过 cli 包中的 Subcmd 方法定义一个类型为 Flagset 的对象 cmd。
cmd := cli.Subcmd("pull", "NAME[:TAG]", "Pull an image or a repository from the registry")
(2) 给 cmd 对象定义一个类型为 String 的 flag,名为”#t”或”#-tag”,初始值为空。
tag := cmd.String([]string{"#t", "#-tag"}, "", "Download tagged image in a repository")
(3) 将 args 参数进行解析,解析过程中,先提取出是否有符合 tag 这个 flag 的参数,若有,将其给赋值给 tag 参数,其余的参数存入 cmd.NArg(); 若无的话,所有的参数存入 cmd.NArg() 中。
if err := cmd.Parse(args); err != nil {
return nil }
(4) 判断经过 flag 解析后的参数列表,若参数列表中参数的个数不为 1,则说明需要 pull 多个 image,pull 命令不支持,则调用错误处理方法 cmd.Usage(),并返回 nil。
if cmd.NArg() != 1 {
cmd.Usage()
return nil
}
(5) 创建一个 map 类型的变量 v,该变量用于存放 pull 镜像时所需的 url 参数;随后将参数列表的第一个值赋给 remote 变量,并将 remote 作为键为 fromImage 的值添加至 v;最后若有 tag 信息的话,将 tag 信息作为键为”tag”的值添加至 v。
var (
v = url.Values{}
remote = cmd.Arg(0)
)
v.Set("fromImage", remote)
if *tag == "" {
v.Set("tag", *tag)
}
(6) 通过 remote 变量解析出镜像所在的 host 地址,以及镜像的名称。
remote, _ = parsers.ParseRepositoryTag(remote)
// Resolve the Repository name from fqn to hostname + name
hostname, _, err := registry.ResolveRepositoryName(remote)
if err != nil {
return err
}
(7) 通过 cli 对象获取与 Docker Server 通信所需要的认证配置信息。
cli.LoadConfigFile()
// Resolve the Auth config relevant for this server
authConfig := cli.configFile.ResolveAuthConfig(hostname)
(8) 定义一个名为 pull 的函数,传入的参数类型为 registry.AuthConfig,返回类型为 error。函数执行块中最主要的内容为:cli.stream(……) 部分。该部分具体发起了一个给 Docker Server 的 POST 请求,请求的 url 为"/images/create?"+v.Encode(),请求的认证信息为:map[string][]string{“X-Registry-Auth”: registryAuthHeader,}。
pull := func(authConfig registry.AuthConfig) error {
buf, err := json.Marshal(authConfig)
if err != nil {
return err
}
registryAuthHeader := []string{
ase64.URLEncoding.EncodeToString(buf),
}
return cli.stream("POST", "/images/create?"+v.Encode(), nil, cli.out, map[string][]string{ " X-Registry-Auth": registryAuthHeader,
})
}
(9) 由于上一个步骤只是定义 pull 函数,这一步骤具体调用执行 pull 函数,若成功则最终返回,若返回错误,则做相应的错误处理。若返回错误为 401,则需要先登录,转至登录环节,完成之后,继续执行 pull 函数,若完成则最终返回。
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 请求的全部执行过程,其他请求的执行在流程上也是大同小异。总之,请求执行过程中,大多都是将命令行中关于请求的参数进行初步处理,并添加相应的辅助信息,最终通过指定的协议给 Docker Server 发送 Docker Client 和 Docker Server 约定好的 API 请求。