如何在 docker-compose 中使用多个图像标签

Question

根据this 和this GitHub 问题，目前在使用docker-compose 构建一个或多个图像时，没有原生方法如何为服务的图像提供多个标签。

我的用例是构建在 docker-compose.yml 文件中定义的图像，并使用一些自定义标签（例如，一些构建编号或日期或类似标签）标记它们一次，然后将它们标记为 latest。

虽然这可以通过使用docker tag 的普通docker 轻松实现，但docker-compose 只允许在image key 中设置一个标签。将docker tag 与docker-compose 一起使用对我来说不是一个选项，因为我想将所有与docker 相关的定义保留在docker-compose.yml 文件中，而不是将它们复制到我的构建脚本中。

用docker-compose 设置多个标签而不需要先硬编码/复制图像名称是一种体面的解决方法？

Answer 1

我有一些使用环境变量的漂亮而干净的解决方案（默认变量值的 bash 语法，在我的例子中是 latest 但你可以使用任何东西），这是我的作文：

version: '3'
services:
  app:
    build: .
    image: myapp-name:${version:-latest}

使用默认标签构建和推送（如果需要推送到注册表），使用环境变量更改版本并再次构建和推送：

docker-compose build
docker-compose push
export version=0.0.1
docker-compose build
docker-compose push

Answer 2

您还可以采取以下方法：

# build is your actual build spec
build:
  image: myrepo/myimage
  build:
  ...
  ...
# these extend from build and just add new tags statically or from environment variables or 
version_tag:
  extends: build
  image: myrepo/myimage:v1.0
some_other_tag:
  extends: build
  image: myrepo/myimage:${SOME_OTHER_TAG}

然后您可以运行 docker-compose build 和 docker-compose push，您将构建并推送正确的标记图像集

Answer 3

我想出了几个不同复杂度的变通办法。它们都依赖于${IMAGE_TAG} 存储代表例如的自定义标签的假设。一个版本号。我们想用这个标签以及latest来标记所有服务的图像。

grep docker-compose.yml 文件中的图像名称

images=$(cat docker-compose.yml | grep 'image: ' | cut -d':' -f 2 | tr -d '"')
for image in $images
do
  docker tag "${image}":"${IMAGE_TAG}" "${image}":latest
done

但是，如果有人在 docker-compose.yml 中添加评论，这很容易出错，例如看起来像# Purpose of this image: do something useful...。

构建两次

使用${IMAGE_TAG} 作为docker-compose.yml 文件中的环境变量，如here in the first example 所述。

然后，只需运行构建过程两次，每次将 ${IMAGE_TAG} 替换为不同的值：

IMAGE_TAG="${IMAGE_TAG}" docker-compose build
IMAGE_TAG=latest docker-compose build

第二个构建过程应该比第一个快得多，因为所有图像层仍然应该从第一次运行开始缓存。

这种方法的缺点是它会为每个单独的服务使用两个后续构建过程来淹没您的日志输出，这可能会使通过它搜索有用的东西变得更加困难。

此外，如果您的 Dockerfile 中有任何命令总是刷新构建缓存（例如，ADD 命令从远程位置获取并自动更新 last-modified 标头，添加由外部进程等），那么额外的构建可能会显着减慢速度。

使用一些内联 Python 代码从 docker-compose.yml 文件中解析图像名称

在 Python 中使用真正的 yaml 解析器（或任何其他语言，例如 Ruby 或 perl 或您系统上安装的任何其他语言）比第一次提到的 grep 方法更强大，因为它不会得到被 cmets 或编写 yml 文件的奇怪但有效的方式弄糊涂了。

在 Python 中，这可能如下所示：

images=$(python3 <<-EOF # make sure below to indent with tabs, not spaces; or omit the "-" before "EOF" and use no indention at all
    import yaml
    content = yaml.load(open("docker-compose.build.yml"))
    services = content["services"].values()
    image_names = (service["image"].split(":")[0] for service in services)
    print("\n".join(image_names))
EOF
)

for image in ${images}
do
docker tag ${image}:${IMAGE_TAG} ${image}:latest
done

这种方法的缺点是执行构建的机器必须安装 Python3 以及 PyYAML 库。如前所述，此模式同样可以与 Python2 或任何其他已安装的编程语言一起使用。

结合一些docker命令获取图片名称

以下使用一些本机 docker 和 docker-compose 命令（使用 go-templates）的方法编写起来有点复杂，但效果也很好。

# this should be set to something unique in order to avoid conflicts with other running docker-compose projects
compose_project_name=myproject.tagging

# create containers for all services without starting them
docker-compose --project-name "${compose_project_name}" up --no-start

# get image names without tags for all started containers
images=$(docker-compose --project-name "${compose_project_name}" images -q | xargs docker inspect --format='{{ index .RepoTags 0}}' | cut -d':' -f1)

# iterate over images and re-tag
for image in ${images}
do
    docker tag "${image}":"${IMAGE_TAG}" "${image}":latest
done

# clean-up created containers again
docker-compose --project-name "${compose_project_name}" down

虽然此方法没有任何外部依赖项并且比 grep 方法更安全，但在创建和删除容器的大型设置上执行可能需要几秒钟的时间（但通常不是问题）。

Answer 4

正如@JordanDeyton 所建议的，extends 不能再在 Compose 文件格式中使用 > 3 并且在版本 3.4 中添加的 Extension fields 功能可以替换它以实现相同的目标。这是一个例子。

version: "3.4"
# Define common behavior
x-ubi-httpd:
  &default-ubi-httpd
  build: ubi-httpd
  # Other settings can also be shared
  image: ubi-httpd:latest

# Define one service by wanted tag
services:
  # Use the extension as is
  ubi-httpd_latest:
    *default-ubi-httpd
  # Override the image tag
  ubi-httpd_major:
    << : *default-ubi-httpd
    image: ubi-httpd:1
  ubi-httpd_minor:
    << : *default-ubi-httpd
    image: ubi-httpd:1.0
  # Using an environment variable defined in a .env file for e.g.
  ubi-httpd_patch:
    << : *default-ubi-httpd
    image: "ubi-httpd:${UBI_HTTPD_PATCH}"

现在可以使用所有定义的标签构建图像

$ docker-compose build
# ...

$ docker images | grep ubi-httpd
# ubi-httpd  1       8cc412411805  3 minutes ago  268MB
# ubi-httpd  1.0     8cc412411805  3 minutes ago  268MB
# ubi-httpd  1.0.1   8cc412411805  3 minutes ago  268MB
# ubi-httpd  latest  8cc412411805  3 minutes ago  268MB