注释

注释为镜像提供描述性元数据。使用注释来记录任意信息并将其附加到您的镜像，这有助于使用者和工具了解镜像的来源、内容以及如何使用镜像。

注释类似于（在某种程度上与）标签重叠。两者都服务于相同的目的：将元数据附加到资源。作为一般原则，您可以将注释和标签之间的区别理解如下：

注释描述 OCI 镜像组件，例如清单、索引和描述符。
标签描述 Docker 资源，例如镜像、容器、网络和卷。

OCI 镜像规范定义了注释的格式，以及一组预定义的注释键。遵守指定的标准可确保像 Docker Scout 这样的工具可以自动且一致地显示有关镜像的元数据。

注释不要与证明混淆。

证明包含有关镜像构建方式及其包含内容的信息。证明作为单独的清单附加到镜像索引上。证明未经开放容器倡议标准化。
注释包含关于图像的任意元数据。注释作为标签附加到图像配置，或者作为属性附加到图像索引或清单上。

添加注释

您可以在构建时或创建图像清单或索引时向图像添加注释。

注意
Docker Engine镜像存储库不支持加载带有注释的镜像。要使用注释构建，请确保使用--push CLI标志或注册表导出器直接将镜像推送到注册表。

要在命令行上指定注释，请对docker build命令使用--annotation标志。

$ docker build --push --annotation "foo=bar" .

如果您使用的是Bake，您可以使用annotations属性为给定的目标指定注释。

target "default" {
  output = ["type=registry"]
  annotations = ["foo=bar"]
}

有关如何向使用GitHub Actions构建的镜像添加注释的示例，请参阅使用GitHub Actions添加镜像注释

您还可以向使用docker buildx imagetools create创建的镜像添加注释。此命令仅支持向索引或清单描述符添加注释，请参阅CLI参考。

检查注释

要查看图像索引上的注释，请使用docker buildx imagetools inspect命令。这将向您显示索引包含的索引和描述符（对清单的引用）的任何注释。以下示例显示了描述符上的org.opencontainers.image.documentation注释和索引上的org.opencontainers.image.authors注释。

$ docker buildx imagetools inspect <IMAGE> --raw
{
  "schemaVersion": 2,
  "mediaType": "application/vnd.oci.image.index.v1+json",
  "manifests": [
    {
      "mediaType": "application/vnd.oci.image.manifest.v1+json",
      "digest": "sha256:d20246ef744b1d05a1dd69d0b3fa907db007c07f79fe3e68c17223439be9fefb",
      "size": 911,
      "annotations": {
        "org.opencontainers.image.documentation": "https://foo.example/docs",
      },
      "platform": {
        "architecture": "amd64",
        "os": "linux"
      }
    },
  ],
  "annotations": {
    "org.opencontainers.image.authors": "dvdksn"
  }
}

要检查清单上的注释，请使用docker buildx imagetools inspect命令并指定<IMAGE>@<DIGEST>，其中<DIGEST>是清单的摘要。

$ docker buildx imagetools inspect <IMAGE>@sha256:d20246ef744b1d05a1dd69d0b3fa907db007c07f79fe3e68c17223439be9fefb --raw
{
  "schemaVersion": 2,
  "mediaType": "application/vnd.oci.image.manifest.v1+json",
  "config": {
    "mediaType": "application/vnd.oci.image.config.v1+json",
    "digest": "sha256:4368b6959a78b412efa083c5506c4887e251f1484ccc9f0af5c406d8f76ece1d",
    "size": 850
  },
  "layers": [
    {
      "mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",
      "digest": "sha256:2c03dbb20264f09924f9eab176da44e5421e74a78b09531d3c63448a7baa7c59",
      "size": 3333033
    },
    {
      "mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",
      "digest": "sha256:4923ad480d60a548e9b334ca492fa547a3ce8879676685b6718b085de5aaf142",
      "size": 61887305
    }
  ],
  "annotations": {
    "index,manifest:org.opencontainers.image.vendor": "foocorp",
    "org.opencontainers.image.source": "https://git.example/foo.git",
  }
}

指定注释级别

默认情况下，注释会添加到镜像清单中。您可以通过在注释字符串前面添加特殊的类型声明来指定要附加注释的级别（OCI镜像组件）。

$ docker build --annotation "<TYPE>:<KEY>=<VALUE>" .

支持以下类型：

manifest：注释清单。
index：注释根索引。
manifest-descriptor：注释索引中的清单描述符。
index-descriptor：注释镜像布局中的索引描述符。

例如，要构建一个带有附加到图像索引的注释foo=bar的镜像：

$ docker build --tag <IMAGE> --push --annotation "index:foo=bar" .

请注意，构建必须生成您指定的组件，否则构建将失败。例如，以下方法无效，因为docker导出器不会生成索引。

$ docker build --output type=docker --annotation "index:foo=bar" .

同样，以下示例也无效，因为在某些情况下，例如显式禁用来源证明时，buildx 默认会创建 docker 输出。

$ docker build --provenance=false --annotation "index:foo=bar" .

可以指定用逗号分隔的类型，以便将注释添加到多个级别。以下示例创建一个在图像索引和图像清单上都带有注释foo=bar的镜像。

$ docker build --tag <IMAGE> --push --annotation "index,manifest:foo=bar" .

您还可以使用方括号在类型前缀中指定平台限定符，以便仅注释与特定操作系统和架构匹配的组件。以下示例仅将foo=bar注释添加到linux/amd64清单。

$ docker build --tag <IMAGE> --push --annotation "manifest[linux/amd64]:foo=bar" .

参考信息

注释

添加注释

检查注释

指定注释级别

相关信息