前言
docker是go语言编写的,要看docker源码,最起码要学会go的基础语法。
了解 docker 基础架构 以后。可以对源码总体结构有一个大体了解,然后就可以顺利的进行源码的入门解读了。
本文主要剖析 docker-ce 的源码。
docker-ce github:
https://github.com/docker/docker-ce
环境
操作系统:centos7
docker版本:docker-ce: 18.09
正文
docker 源码简介
https://github.com/docker,这里是docker源码的家目录。
可以看到这里有许多许多的项目,比如:docker-engine、docker-ce、cli等,这些项目和docker的架构都有关系,我安装时就只安装了一个,为啥这里这么多?到底如何查看?
首先要说一点,docker这个项目的源码挺杂。
docker 家目录下包含:docker-engine、docker-ce、cli等。
进入docker-ce可以发现 components下也有cli 和 engine。
通过简单得对比,发现docker-ce下得cli 和 engine与docker家目录下得docker-engine和cli是一样得。也就是docker-ce只是组合了docker-engine,cli等。
还有一个概念需要提,docker项目 fork 自 moby。
进入到 docker-ce 中,
可以在 components 中看到:
在我们安装完docker时,使用 docker version 命令可以看到一个docker client和一个docker server。docker client 对应这里的cli;docker server对应这里的engine。
至于那个package,可以暂时不用管它。
当我们使用 docker start
阅读源码前,可以先猜测一下主体流程:
- 如何生成命令行供我们使用?
- 在调用命令行后,如何访问到docker server 提供的 restful api?
- docker engine 一定在监听 restful api 对应的地址!
- docker engine 收到指令,接下来如何执行?
- docker engine 执行完,我们也可以收拾收拾进入下一阶段的学习了!
docker 源码解读
根据上文猜测的 启动容器 流程,进行源码解读。
两个部分:
- 命令行:https://github.com/docker/docker-ce/tree/18.09/components/cli
- server :https://github.com/docker/docker-ce/tree/18.09/components/engine
1. 如何生成命令行供我们使用?
很明显了,这是cli组件。那么直接进cli目录中进行翻看。(注:docker 使用 cobra 这个包去实现命令行功能。)
每一个功能模块或程序都会存在一个入口函数。
根据经验,docker.go是功能的入口,它在:https://github.com/docker/docker-ce/blob/18.09/components/cli/cmd/docker/docker.go
入口函数找到了,先放到一边。现在去找具体命令行实现的地方。
现在去到 https://github.com/docker/docker-ce/tree/18.09/components/cli/cli/command 这个目录下。这个目录下的子目录,看着是不是稍微有点眼熟?使用 docker --help 列出来的子命令,有一个算一个,分别对应这些子目录!
排查容器启动流程,当然去container目录下,进入container目录后,可以清晰的看到容器相关命令对应的文件!到这里,可以看出docker cli的目录结构和命令行的结构十分相似!
找到 start.go,主要代码如下:
稍微去了解了一下 cobra 。根据其使用方式,可以知道这里就是定义docker start 命令的地方了。上图标注处,是下面第2步骤需要分析的代码。
至此,命令定义的地方已经找到,接下来就是分析命令如何执行。
2. 在调用命令行后,如何访问到docker server 提供的 restful api?
在上面那张图里的 runSatrt 方法中可以发现 启动容器指向 dockerCli.Client().ContainerStart。如下:
https://github.com/docker/docker-ce/blob/18.09/components/cli/cli/command/container/start.go
结合导包,dockerCli 指向 command.Cli , 而 command.Cli 中的 Client 指向 docker/docker/client。如下:
https://github.com/docker/docker-ce/blob/18.09/components/engine/client/client.go
现在 client 已找到,接下来顺着 client 去找 ContainerStart 。
在当前client下并没有发现目标方法。这也是go的一个特点,其它的文件也可以声明成该client。
最后在 container_start.go 发现了目标方法,如下:
https://github.com/docker/docker-ce/blob/18.09/components/engine/client/container_start.go
如上图,这个 ContainerStart 方法调用的是 cli.post。很明显的,这是一个访问restful api的封装方法。
至此,客户端行为基本结束。向 "/containers/
接下来便是去服务端找到监听这个地址的方法。
3. docker engine 一定在监听 restful api 对应的地址!
对于一个web server。路由可以帮助我们快速找到地址对应的方法。
现在,进入到engine目录下,开始分析源码。
类似于 cli 组件,engine 组件也有入口函数。也叫 docker.go。这个文件了解就好,暂时不会用到。
路由的定义如下:
https://github.com/docker/docker-ce/blob/18.09/components/engine/api/server/router/container/container.go
至此,路由已然找到。接下来就是分析 postContainersStart 这个方法干了什么。
4. docker engine 收到指令,接下来如何执行?
postContainersStart 方法位于:
https://github.com/docker/docker-ce/blob/18.09/components/engine/api/server/router/container/container_routes.go
在当前方法中,可以看到引用了 backend.ContainerStart 。
在 https://github.com/docker/docker-ce/blob/18.09/components/engine/api/server/router/container/backend.go 中可以找到 ContainerStart 的定义。具体由daemon实现。
daemon位于:https://github.com/docker/docker-ce/blob/18.09/components/engine/daemon。
其中 start.go 就是我们需要找的目标文件,如下:
https://github.com/docker/docker-ce/blob/18.09/components/engine/daemon/start.go
当前方法指向:daemon.containerStart ,该方法就在当前文件中。
到这里应该已经差不多了,我们不是要从零开始写一个docker。
扩展
总结:
- 命令行或者sdk均是访问 docker server 的restful api。
- docker server 源码总体层次:【api】--【daemon】。api 定义路由,daemon实现路由中的具体方法。
- docker-ce 中的cli和engine略有交叉,对于常见 c/s 架构,这种代码交叉的情况比较少。一般 client 为单独部署的方式,而docker 并没有将cli独立出来,可能是由于设计初衷就不是集群模式。