使用 Docker 的标准 Go 项目布局导致构建上下文问题

目前golang学习网上已经有很多关于Golang的文章了，自己在初次阅读这些文章中，也见识到了很多学习思路；那么本文《使用 Docker 的标准 Go 项目布局导致构建上下文问题》，也希望能帮助到大家，如果阅读完后真的对你学习Golang有帮助，欢迎动动手指，评论留言并分享~

我遵循的两个指南似乎存在冲突

1. 标准 go 项目布局
2. 使用 grpc 的 go 的 google cloud endpoints 示例

go的标准go项目布局推荐了/build目录，其使用描述为

打包和持续集成。 放置您的云（ami）、容器（docker）、操作系统（deb、rpm、pkg）包 /build/package 目录中的配置和脚本。

按照使用 grpc 的 go 的 google cloud endpoints 示例，我有一个 dockerfile，它复制应用程序源代码并使用 go get 安装任何依赖项。

# /build/dockerfile

from golang:alpine

# alpine linux package management
run apk update
run apk add git

copy ../ /go/src/github.com/username/repository

# downloads the packages named by the import paths, along with their
# dependencies. it then installs the named packages, like 'go install'.
# ****don't do this in production! use vendoring instead.****
run go get -v github.com/username/repository/foo-module

# compiles and installs the packages named by the import paths.
run go install github.com/username/repository/foo-module

entrypoint ["/go/bin/foo-module"]

按照标准 go 项目布局，我将上述 dockerfile 放置在 /build 中。

由于 dockerfile 现在位于 /build 目录中，因此我修改了 copy 命令来复制 parent 目录以查找应用程序源代码 (copy ../ /go/src/github.com)。 com/用户名/repository）。

docker build 命令不直接运行，而是使用 google cloud build 启动构建

cloud-build-local --config=build/cloudbuild.yaml .

cloudbuild.yaml 文件非常简单，只是启动 docker 构建。 --file 标志指向 build/dockerfile，因为 cloud build 命令是从项目根目录启动的，而不是从 /build 启动的）

# /build/cloudbuild.yaml

steps:
    - id: build
      name: "gcr.io/cloud-builders/docker"

      dir: ${_source}
      args:
        [
            "build",
            "--file build/dockerfile",
            ".",
        ]

正如预期的那样，失败了

COPY failed: Forbidden path outside the build context: ../ ()

如何包含 docker 构建上下文之外的文件？建议使用 --file 标志，但是，这假设构建是从根上下文启动的。使用 google 的 cloud build 时，构建从 cloudbuild.yaml 启动，该文件也位于 /build 中。

我可以将 docker 文件放在 go 模块的根目录中，但我希望尽可能遵循最佳实践，并将 cloudbuild.yaml 和 dockerfile 保留在 /build 中。

在遵循标准 go 项目布局的同时实现此目标的正确方法是什么？

解决方案

这是一个相当长的问题，所以让我们重点关注遇到的问题：

copy ../ /go/src/github.com/username/repository

这导致了

copy failed: forbidden path outside the build context: ../ ()

您不能包含上下文之外的文件，docker 不允许这样做。相反，您可以更改上下文以包含构建映像所需的文件，并使 copy/add 命令中的路径相对于该上下文。请务必重新阅读，这些路径与 dockerfile 位置无关。

因此，使用 docker build，如果您有 build/dockerfile，则可以使用以下命令从父目录构建：

docker build -f build/dockerfile .

该尾随点是构建上下文的路径，该上下文被发送到 docker 引擎以执行构建。它不会直接访问客户端上的文件，这就是为什么您不能包含来自上下文外部的文件（而且您不希望恶意 dockerfile 从构建服务器中提取数据）。

然后在 dockerfile 中定义相对于该上下文的路径：

copy . /go/src/github.com/username/repository

如果由于某种原因，由于工具的原因，您无法从该父目录构建，则将上下文设置为具有相对路径的父文件夹：

docker build -f Dockerfile ..

终于介绍完啦！小伙伴们，这篇关于《使用 Docker 的标准 Go 项目布局导致构建上下文问题》的介绍应该让你收获多多了吧！欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布Golang相关知识，快来关注吧！