注解（Annotations）

Table of contents

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

注解与 labels 类似，并且在某种意义上有所重叠。两者服务于相同的目的：将元数据附加到资源上。作为一个通用原则，你可以这样理解注解与标签之间的区别：

注解描述 OCI 镜像组件，例如 manifests、indexes 和 descriptors。
标签描述 Docker 资源，例如镜像、容器、网络和卷。

OCI 镜像 specification 定义了注解的格式，以及一组预定义的注解键。遵循指定的标准可确保有关镜像的元数据能够被 Docker Scout 等工具自动且一致地呈现。

注解不应与 attestations 混淆：

证明包含有关镜像如何构建以及包含什么的信息。证明作为镜像索引上的一个独立清单附加。证明并未由 Open Container Initiative 标准化。
注解包含关于镜像的任意元数据。注解作为标签附加到镜像的 config 上，或作为属性附加到镜像索引或清单上。

添加注解

你可以在构建时，或在创建镜像清单或索引时，向镜像添加注解。

Note

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

要在命令行上指定注解，对 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> 是清单的 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" .

What can I help you with?

注解（Annotations）

添加注解

检查注解

指定注解级别

相关信息