为Go程序创建最小的Docker Image

本文将会介绍如何使用docker打包一个golang编写的应用程序，最终的产物就是一个Dockerfile文件，可别小瞧这短短几行代码，涉及的知识点可不少，接下来我们就仔细剖析一下吧。

FROM golang:alpine

ADD src /go/src
RUN go install -v test 

ENTRYPOINT ["/go/bin/test"]
CMD ["-logtostderr"]

1.基础镜像选择

第一行是指定一个基础镜像，在此基础上创建我们的镜像，此处使用的是golang:alpine版本，

这是一个相对较小的linux系统，砍掉了linux中的许多工具，预装了golang, 包管理工具使用的是apk，可以把这个镜像docker pull下来把玩一番，默认的shell是sh，执行命令docker run -t-i golang:alpine /bin/sh 进入命令行。进入后执行env查看环境变量，因为其GOPATH这个环境变量对后面的环境部署有用，可以看到环境变量GOPATH默认值为/go

2.映射代码文件并安装

使用 ADD src /go/src 将主机scr文件映射到/go/src目录下,为什么非得是这个/go/src这个目录呐？没错就是上面的GOPATH环境变量的路径，因为我们后面需要执行go install命令进行安装，否则的话就需要重新设置GOPATH才能编译代码。如下test是程序的主程序，glog是使用的开源日志库，整个文件结构如下：

.
├── Dockerfile
└── src
    ├── github.com
    │   └── golang
    │       └── glog
    │           ├── glog_file.go
    │           ├── glog.go
    │           ├── glog_test.go
    │           ├── LICENSE
    │           └── README
    └── test
        └── main.go

此处glog库没有使用glide等包管理工具，直接使用git submodule来管理， 优势是git push不会将glog代码Push到远程仓库，只是添加一个对glog的引用，并且当glog库中代码被修改后可以只需要在glog的子目录中git pull即可，也就是说在本地会拉取具体的代码进行编译等，但是在远程仓库只是保存引用。

可以通过命令生成glog这个子模块： git submodule add https://github.com/golang/glog.git src/github.com/golang/glog。注意git submoule命令中被引用到的位置为src/github.com/golang而不是直接的src/ 中，因为执行该命令后本地代码仓库会clone glog这个代码仓库，将它的代码拉下来，只是创建glog这个目录，所以前面的一些父目录需要自己创建。关于命令更多的介绍参见 Git。

组织好文件结构就可以进行go install了，生成的可执行在$GOPATH/bin中，后面就是基本的指定入口程序和参数。通过docker build -t="name" . 生成镜像

3.更进一步：提前编译

上面的方式是将代码拷贝进基础镜像并在其内部编译，毫无疑问的是golang:alpine中包含一系列程序运行的依赖，程序运行会动态加载这些库，我们可以用ldd命令查看所生成的二进制文件的依赖：

linux-vdso.so.1 =>  (0x00007ffc5b1e4000)
libpthread.so.0 => /lib/x86_64-linux-gnu/libpthread.so.0 (0x00007f50a1f13000)
libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007f50a1b4a000)
/lib64/ld-linux-x86-64.so.2 (0x00005611a4b0a000)

那么问题来了？ 如果将这些依赖静态编译至可执行文件中, 并且只将可执行文件添加到镜像中， 那就不需要在镜像中保存这些运行时依赖和源码了，就可以创建一个更小的镜像了。幸运的是无论是golang的编译机制还是docker的基础镜像都提供这样的实现：

使用命令生成静态编译的二进制文件：CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o main test

此时用ldd查看生成的可执行文件的依赖，可以看到显示not a dynamic executable，这里我们禁用CGO使其生成静态二进制文件，同时设置系统为linux。我们将基础镜像设置为 scratch，这是一个空的镜像，是用来构建其他基础镜像的， 无需下载即可使用。

重新编写的Dockerfile如下：

FROM scratch
ADD main /
ENTRYPOINT ["/main"]
CMD ["-logtostderr"]

执行docker build -t example-scratch .生成镜像，可以看到该镜像的大小只有几M，并且和二进制程序main的大小相同。

Dockerfile中FROM scratch并不会增加层数， 所以用此Dockerfile构建的镜像只是三层，并且镜像的大小和二进制文件的大小相同，可以通过docker image history查看这些信息

gaorong@gaorong-TM1604 % ls -lh main
-rwxrwxr-x 1 gaorong gaorong 2.4M 6月   9 11:59 main*

gaorong@gaorong-TM1604 % docker images example-scratch
REPOSITORY          TAG                 IMAGE ID            CREATED             SIZE
example-scratch     latest              817e7d91c8c0        About an hour ago   2.42MB

gaorong@gaorong-TM1604 % docker image history example-scratch
IMAGE               CREATED             CREATED BY                                      SIZE                COMMENT
817e7d91c8c0        About an hour ago   /bin/sh -c #(nop)  CMD ["-logtostderr"]         0B
323b904e4844        About an hour ago   /bin/sh -c #(nop)  ENTRYPOINT ["/main"]         0B
8216c95b5652        About an hour ago   /bin/sh -c #(nop) ADD file:6828257fa0b521333…   2.42MB

4.builder image

上述镜像构建是需要提前编译好二进制，然后才能拷贝到最终的镜像中，可否将编译的这一步骤也容器化了呢？ 当然可以，可以写一个Dockerfile.builder来进行build操作，

FROM golang:alpine
ENV CGO_ENABLED=0 GOOS=linux
CMD ["go", "build", "-a", "-installsuffix", "cgo", "-o", "main", "test" ]

在执行的时候需要将当前文件目录volume挂载进容器的/go目录下: docker run -v `pwd`:/go builder。

本文所使用的案例太过简单，builder image意义不大，假如你参与一个大型项目，项目中有一个Makefile，其中定义了好多操作，例如生成项目的rpm包，生成rpm这些操作需要调用额外的程序执行，如果参与项目的每个人都配置这样一个开发环境未免太麻烦，此时就可以利用builder image将所需要的环境全部打包进去，然后在builder image调用makefile即可。 著名的案例就是kubernetes，开发者在个人电脑上只需要安装了docker就可以编译生成kuberetes所有的binary，甚至golang也无需安装。

5.分阶段编译(multi-stage builds)

可以利用docker 的分阶段编译将上述两个操作合并起来，先在一个镜像中构建，在另一个镜像中执行。下面的Dockerfile摘自prometheus这个第三方监控的dmo中的Dockerfile,可以看到它是首先在builder镜像中下载对应的依赖并且编译程序，最后在scratch基础镜像中执行程序。

# This Dockerfile builds an image for a client_golang example.
#
# Use as (from the root for the client_golang repository):
#    docker build -f examples/$name/Dockerfile -t prometheus/golang-example-$name .

# Builder image, where we build the example.
FROM golang:1.9.0 AS builder
WORKDIR /go/src/github.com/prometheus/client_golang
COPY . .
WORKDIR /go/src/github.com/prometheus/client_golang/prometheus
RUN go get -d
WORKDIR /go/src/github.com/prometheus/client_golang/examples/simple
RUN CGO_ENABLED=0 GOOS=linux go build -a -tags netgo -ldflags '-w'

# Final image.
FROM scratch
LABEL maintainer "The Prometheus Authors <prometheus-developers@googlegroups.com>"
COPY --from=builder /go/src/github.com/prometheus/client_golang/examples/simple .
EXPOSE 8080
ENTRYPOINT ["/simple"]

其实就是将一个镜像作为builder镜像，然后将build产物在另外一个镜像中执行。

参考

Building Minimal Docker Containers for Go Applications