5 步助你成为一名优秀的 Docker 代码贡献者

pigsmall

2015-06-24

【编者的话】开源渐成主流，越来越多的开发者想参与开源社区。而时下最火热的Docker也许就是开发者入手开源项目的最好选择，它不仅是目前最流行的开源项目之一，而且在提交Issue方面的文档和流程都是目前我见过的开源项目里最好的。本文主要介绍了如何入手开源项目，一些小经验和小工具，一起来学习。

成为一个流行开源项目（如Docker）的贡献者有如下好处：

你可以参与改进很多人都在使用的项目，以此来获得认同感；
你可以与开源社区中的那些聪明绝顶的人通力合作；
你可以通过参与理解和改进这个项目来使自己成为一名更加出色的程序员。

但是，从一个新的基准代码（codebase）入手绝对是一件恐怖的事情。目前，Docker已经有相当多的代码了，哪怕是修复一个小问题，都需要阅读大量的代码，并理解这些部分是如何组合在一起的。

不过，它们也并不如你想象的那么困难。你可以根据Docker的贡献者指南来完成环境的配置。然后按照如下5个简单的步骤，配合相关的代码片段来深入代码基。你所历练的这些技能，都将会在你的编程生涯的每个新项目中派上用场。那么还等什么，我们这就开始。

步骤1：从'func main()'开始

正如一句古话所述，从你知道的开始。如果你和大部分Docker用户一样，你可能主要使用Docker CLI。因此，让我们从程序的入口开始：‘main’函数。

此处为本文的提示，我们将会使用一个名为Sourcegraph的站点，Docker团队就使用它完成在线检索和代码浏览，和你使用智能IDE所做的差不多。建议在阅读本文时，打开Sourcegraph放在一边，以更好地跟上文章的进度。

在Sourcegraph站点，让我们搜索Docker仓库中的‘func main()’。

5 步助你成为一名优秀的 Docker 代码贡献者

我们正在寻找对应‘docker’命令的‘main’函数，它是‘docker/docker/docker.go’中的一个文件。点击搜索结果，我们会跳到其定义(如下所示)。花一点时间浏览一下这个函数：

func main(){
if reexec.Init(){
return
}
// Set terminal emulation based on platform as required.
stdin, stdout, stderr := term.StdStreams()
initLogging(stderr)
flag.Parse()
// FIXME: validate daemon flags here
if*flVersion {
showVersion()
return
}
if*flLogLevel !=""{
lvl, err := logrus.ParseLevel(*flLogLevel)
if err !=nil{
logrus.Fatalf("Unable to parse logging level: %s",*flLogLevel)
}
setLogLevel(lvl)
}else{
setLogLevel(logrus.InfoLevel)
}
// -D, --debug, -l/--log-level=debug processing
// When/if -D is removed this block can be deleted
if*flDebug {
os.Setenv("DEBUG","1")
setLogLevel(logrus.DebugLevel)
}
if len(flHosts)==0{
defaultHost := os.Getenv("DOCKER_HOST")
if defaultHost ==""||*flDaemon {
// If we do not have a host, default to unix socket
defaultHost = fmt.Sprintf("unix://%s", api.DEFAULTUNIXSOCKET)
}
defaultHost, err := api.ValidateHost(defaultHost)
if err !=nil{
logrus.Fatal(err)
}
flHosts = append(flHosts, defaultHost)
}
setDefaultConfFlag(flTrustKey, defaultTrustKeyFile)
if*flDaemon {
if*flHelp {
flag.Usage()
return
}
mainDaemon()
return
}
if len(flHosts)>1{
logrus.Fatal("Please specify only one -H")
}
protoAddrParts := strings.SplitN(flHosts[0],"://",2)
var(
cli *client.DockerCli
tlsConfig tls.Config
)
tlsConfig.InsecureSkipVerify=true
// Regardless of whether the user sets it to true or false, if they
// specify --tlsverify at all then we need to turn on tls
if flag.IsSet("-tlsverify"){
*flTls =true
}
// If we should verify the server, we need to load a trusted ca
if*flTlsVerify {
certPool := x509.NewCertPool()
file, err := ioutil.ReadFile(*flCa)
if err !=nil{
logrus.Fatalf("Couldn't read ca cert %s: %s",*flCa, err)
}
certPool.AppendCertsFromPEM(file)
tlsConfig.RootCAs= certPool
tlsConfig.InsecureSkipVerify=false
}
// If tls is enabled, try to load and send client certificates
if*flTls ||*flTlsVerify {
_, errCert := os.Stat(*flCert)
_, errKey := os.Stat(*flKey)
if errCert ==nil&& errKey ==nil{
*flTls =true
cert, err := tls.LoadX509KeyPair(*flCert,*flKey)
if err !=nil{
logrus.Fatalf("Couldn't load X509 key pair: %q. Make sure the key is encrypted", err)
}
tlsConfig.Certificates=[]tls.Certificate{cert}
}
// Avoid fallback to SSL protocols < TLS1.0
tlsConfig.MinVersion= tls.VersionTLS10
}
if*flTls ||*flTlsVerify {
cli = client.NewDockerCli(stdin, stdout, stderr,*flTrustKey, protoAddrParts[0], protoAddrParts[1],&tlsConfig)
}else{
cli = client.NewDockerCli(stdin, stdout, stderr,*flTrustKey, protoAddrParts[0], protoAddrParts[1],nil)
}
if err := cli.Cmd(flag.Args()...); err !=nil{
if sterr, ok := err.(*utils.StatusError); ok {
if sterr.Status!=""{
logrus.Println(sterr.Status)
}
os.Exit(sterr.StatusCode)
}
logrus.Fatal(err)
}
}

在‘main’函数的顶部，我们看了许多与日志配置，命令标志读取以及默认初始化相关的代码。在底部，我们发现了对『client.NewDockerCli』的调用，它似乎是用来负责创建结构体的，而这个结构体的函数则会完成所有的实际工作。让我们来搜索『NewDockerCli』。

步骤2：找到核心部分

在很多的应用和程序库中，都有1到2个关键接口，它表述了核心功能或者本质。让我们尝试到达这个关键部分。

点击‘NewDockerCli’的搜索结果，我们会到达函数的定义。由于我们感兴趣的只是这个函数所返回的结构体——「DockerCli」，因此让我们点击返回类型来跳转到其定义。

func NewDockerCli(in io.ReadCloser,out, err io.Writer, keyFile string, proto, addr string, tlsConfig *tls.Config)*DockerCli{
var(
inFd uintptr
outFd uintptr
isTerminalIn =false
isTerminalOut =false
scheme ="http"
)
if tlsConfig !=nil{
scheme ="https"
}
ifin!=nil{
inFd, isTerminalIn = term.GetFdInfo(in)
}
ifout!=nil{
outFd, isTerminalOut = term.GetFdInfo(out)
}
if err ==nil{
err =out
}
// The transport is created here for reuse during the client session
tr :=&http.Transport{
TLSClientConfig: tlsConfig,
}
// Why 32? See issue 8035
timeout :=32* time.Second
if proto =="unix"{
// no need in compressing for local communications
tr.DisableCompression=true
tr.Dial= func(_, _ string)(net.Conn, error){
return net.DialTimeout(proto, addr, timeout)
}
}else{
tr.Proxy= http.ProxyFromEnvironment
tr.Dial=(&net.Dialer{Timeout: timeout}).Dial
}
return&DockerCli{
proto: proto,
addr: addr,
in:in,
out:out,
err: err,
keyFile: keyFile,
inFd: inFd,
outFd: outFd,
isTerminalIn: isTerminalIn,
isTerminalOut: isTerminalOut,
tlsConfig: tlsConfig,
scheme: scheme,
transport: tr,
}
}

点击『DockerCli』将我们带到了它的定义。向下滚动这个文件，我们可以看到它的方法， ‘getMethod’，‘Cmd’，‘Subcmd’和‘LoadConfigFile’。其中，‘Cmd’值得留意。它是唯一一个包含docstring的方法，而docstring则表明它是执行每条Docker命令的核心方法。

步骤3：更进一步

既然我们已经找到了‘DockerCli’，这个Docker客户端的核心‘控制器’，接下来让我们继续深入，了解一条具体的Docker命令是如何工作的。让我们放大‘docker build’部分的代码。

type DockerClistruct{
proto string
addr string
configFile *registry.ConfigFile
in io.ReadCloser
out io.Writer
err io.Writer
keyFile string
tlsConfig *tls.Config
scheme string
// inFd holds file descriptor of the client's STDIN, if it's a valid file
inFd uintptr
// outFd holds file descriptor of the client's STDOUT, if it's a valid file
outFd uintptr
// isTerminalIn describes if client's STDIN is a TTY
isTerminalIn bool
// isTerminalOut describes if client's STDOUT is a TTY
isTerminalOut bool
transport *http.Transport
}

阅读‘DockerCli.Cmd’的实现可以发现，它调用了‘DockerCli.getMethod’方法来执行每条Docker命令所对应的函数。

func (cli *DockerCli)Cmd(args ...string) error {
if len(args)>1{
method, exists := cli.getMethod(args[:2]...)
if exists {
return method(args[2:]...)
}
}
if len(args)>0{
method, exists := cli.getMethod(args[0])
if!exists {
fmt.Fprintf(cli.err,"docker: '%s' is not a docker command. See 'docker --help'.\n", args[0])
os.Exit(1)
}
return method(args[1:]...)
}
return cli.CmdHelp()
}

在‘DockerCli.getMethod’中，我们可以看到它是通过对一个函数的动态调用实现的，其中这个函数名的形式为在Docker命令前预置“Cmd”字符串。那么在‘docker build’这个情况下，我们寻找的是‘DockerCli.CmdBuild’。但在这个文件中并没有对应的方法，因此让我们需要搜索‘CmdBuild’。

func (cli *DockerCli) getMethod(args ...string)(func(...string) error,bool){
camelArgs := make([]string, len(args))
for i, s := range args {
if len(s)==0{
returnnil,false
}
camelArgs[i]= strings.ToUpper(s[:1])+ strings.ToLower(s[1:])&

     docker  docker命令

       
    pigsmall  
   0 关注   0 粉丝   0 动态  
 
    关注    关注   
 
  
    相关推荐 
      Docker使用Portainer搭建可视化界面的方法  
 
     Portainer是Docker的图形化管理工具，提供状态显示面板、应用模板快速部署、容器镜像网络数据卷的基本操作、事件日志显示、容器控制台操作、Swarm集群和服务等集中管理和操作、登录用户管理和控制等功能。功能十分全面，基本能满足中小型单位对容器管理的     
 
   魅惑青花瓷    2020-11-11  
 
      docker容器与宿主机的数据交互方式总结  
 
     在生产环境中使用 Docker ，往往需要对数据进行持久化，或者需要在多个容器之间进行数据共享，这必然涉及容器的数据管理操作。docker cp :用于容器与主机之间的数据拷贝。当删除Docker容器，并通过该镜像重新启动时，之前的更改将会丢失。在Dock     
 
   yangkang    2020-11-09  
 
      如何进入、退出docker的container实现  
 
     Docker的镜像称为image，容器称为container。对于Docker来说，image是静态的，类似于操作系统快照，而container则是动态的，是image的运行实例。比如，有一个image名称为ubuntu，那么比如现在我们启动这个image     
 
   MichaelJScofield    2020-11-06  
 
      详解docker pull 下来的镜像都存到了哪里  
 
     docker pull 下来的命令都默认存在/var/lib/docker/文件夹下。正好和docker images的内容一致。可以看到上面 repositories.json 文件中记录的就是已拉取的镜像信息。     
 
   TaoTaoFu    2020-11-06  
 
      优化Docker镜像，加速应用部署，教你几个小窍门  
 
     Docker 包含三个基本概念，分别是镜像、容器和仓库。Docker 镜像可以看作是一个特殊的文件系统，除了提供容器运行时所需的程序、库、资源、配置等文件外，还包含了一些为运行时准备的一些配置参数。镜像是 Docker 运行容器的前提，是Docker的核心     
 
   liaochaowu    2020-11-16  
 
      Docker不再是唯一的选择  
 
     Docker并不是唯一的容器化工具，可能还有更好的选择……在容器的早期时代，Docker是容器游戏中唯一的玩家。但现在情况已经不一样了，Docker不再是唯一的一个，而只是其中一个容器引擎而已。Docker允许我们构建、运行、拉、推或检查容器镜像，然而对于     
 
   ChlatZed    2020-11-11  
 
      Docker 卷到底是个啥玩意？从使用到深入！  
 
     Docker 支持持久化和非持久化两种方式的存储。非持久化化存储自动创建，从属于容器，生命周期与容器相同，即删除容器也会删除全部非持久化数据。卷与容器是解耦的，从而可以独立地创建并管理卷，并且卷也不与任意容器声明周期绑定，即用户删除一个关联了卷的容器，但是     
 
   lnkToKing    2020-10-29  
 
      IT工程师都需要掌握的容器技术之Docker存储管理  
 
     小伙伴们我们容器技术文章又来啦，今天这边文章主要为大家讲解容器存储，通过本篇文章我们可以了解到容器镜像结构、将主机数据挂载到容器的方式、容器数据卷及数据卷的备份与恢复等技术，下面我们就一起来学习吧!针对上述问题，Docker 提供了四种不同的方式将数据从      
 
   ChlatZed    2020-10-27  
 
      推荐给IT新手的11个Docker免费上手项目  
 
     Docker 是一个开源的应用容器引擎，让开发者可以打包他们的应用以及依赖包到一个可移植的镜像中，然后发布到任何流行的 Linux或Windows  机器上，也可以实现虚拟化。容器是完全使用沙箱机制，相互之间不会有任何接口。使用该工具可以方便的通过界面管理     
 
   ChlatZed    2020-10-13  
 
      10个冷门但又非常实用的Docker使用技巧  
 
     在平时的工作中，docker 接触得很多，除了经常使用的 docker run ，docker stop等命令，docker  还有很多十分有用但是却不经常使用的命令，下面就来总结一下：。这个命令是用来查看一个容器里面的进程信息的，比如你想查看一个 ngi     
 
   时光流水    2020-09-23  
 
      谁说前端不用懂，手摸手 Docker 从入门到实践  
 
     本文转载自微信公众号「前端下午茶」，作者SHERlocked93。在下最近遇到要在服务器上安装 Mysql、Nginx、EasyMock 等工具的场景，这里记录一下我使用 Docker  安装的过程，希望也能在类似的场景中帮助到大家～。Docker  对这     
 
   yangkang    2020-09-23  
 
      docker镜像制作  
 
     和自动化发布平台集成的时候启动shell价值就出来了。另外此处自定了dockerfile的路径和名称，稍微。做了通用化的考虑。稍微需要注意的是 -f最好是全路径。     
 
   changecan    2020-09-22  
 
      Docker 容器监控方案怎么选？看看这套开源方案  
 
     随着线上服务的全面docker化，对docker容器的监控就很重要了。SA的监控系统是物理机的监控，在一个物理机跑多个容器的情况下，我们是没法从一个监控图表里面区分各个容器的资源占用情况的。为了更好的监控容器运行情况，更重要的是为了后续的容器动态调度算法需     
 
   dusuanyun    2020-09-21  
 
      Node.js web 应用如何封装到Docker容器中  
 
     小小又开始学习新的内容了。这次学习的是，把一个Node.js 应用封装到Docker容器，完成本教程的前提是拥有一个可以安装的，已经正常可以工作的Docker。本教程的第一部分，需要创建一个Web应用程序，然后为这个应用程序构建一个Docker镜像，最后把     
 
   newisI    2020-09-01  
 
      deepin apt命令安装最新版本的docker的方法  
 
     下载版本大于上面要求的rpm包，后面通过alien命令将rpm包转换成deb，再通过dpkg -i xxx.deb安装即可。然后在下载目录下打开终端执行 alien xxxx.rpm 即可在当前目录生成deb包，可以在图形界面化下双击安装     
 
   liaochaowu    2020-09-14  
 
      还不使用Docker管理数据，你是从1985年穿越来的吗？  
 
     本文转载自公众号“读芯术”。小白程序员面临的最大困难之一就是理解环境的概念。环境是指程序员进行编码的系统，这听起来貌似很容易，但随着程序员职业生涯的推荐，程序员会逐渐体会到维护“环境”是一件多么困难的事情。这主要是因为库、IDE，甚至Python代码都需要     
 
   ShangQuan0    2020-09-10  
 
      如何使用Docker容器化Node.js应用程序  
 
     容器化应用程序在当今世界越来越流行，因为它们能够解决几乎每个项目团队都面临的一些主要问题。在本文中，我将告诉你如何使用Docker容器化你的node.js应用程序。在继续之前，请确保你的计算机中已安装Docker。完成安装过程后，打开Docker Desk     
 
   fearlessxjdx    2020-09-04  
 
      Docker Swarm概念与基本用法  
 
     Docker Swarm是Docker公司开发的容器集群管理服务。从1.12.0版本开始，已经是Docker安装后自带的一部分了，又称为Swarm Mode，无需额外安装。与Kubernetes相比，Docker Swarm是一个简单的软件，似乎不堪大用。     
 
   libra0    2020-09-02  
 
      优化 Docker 镜像大小常见方法  
 
     平时我们构建的 Docker 镜像通常比较大，占用大量的磁盘空间，随着容器的大规模部署，同样也会浪费宝贵的带宽资源。本文将介绍几种常用的方法来优化  Docker 镜像大小，这里我们使用 Docker Hub 官方上的 Redis 镜像进行说明。我们能够直     
 
   ChlatZed    2020-08-23  
 
      快速制作Redis Docker镜像  
 
     现在容器化已经是趋势，制作镜像也是我们的基础工作。镜像越小，部署起来越方便。在这个方面，轻巧的Linux发行版本就是一个很好的选择，这里我们选择alpine linux 。目前最新版本是3.12.1。官方很友好的提供了minirootfs的包，这个包就是为     
 
   王道革    2020-11-25