Merge pull request moby#3582 from crazy-max/deprecate-buildinfo

remove buildinfo

Author: crazy-max

README.md

@@ -259,8 +259,6 @@ Keys supported by image output:
 * `compression=<uncompressed|gzip|estargz|zstd>`: choose compression type for layers newly created and cached, gzip is default value. estargz should be used with `oci-mediatypes=true`.
 * `compression-level=<value>`: compression level for gzip, estargz (0-9) and zstd (0-22)
 * `force-compression=true`: forcefully apply `compression` option to all layers (including already existing layers)
-* `buildinfo=true`: attach inline build info in [image config](docs/build-repro.md#image-config) (default `true`)
-* `buildinfo-attrs=true`: attach inline build info attributes in [image config](docs/build-repro.md#image-config) (default `false`)
 * `store=true`: store the result images to the worker's (e.g. containerd) image store as well as ensures that the image has all blobs in the content store (default `true`). Ignored if the worker doesn't have image store (e.g. OCI worker).
 * `annotation.<key>=<value>`: attach an annotation with the respective `key` and `value` to the built image
   * Using the extended syntaxes, `annotation-<type>.<key>=<value>`, `annotation[<platform>].<key>=<value>` and both combined with `annotation-<type>[<platform>].<key>=<value>`, allows configuring exactly where to attach the annotation.
@@ -582,26 +580,6 @@ jq '.' metadata.json
 ```
 ```json
 {
-  "containerimage.buildinfo": {
-    "frontend": "dockerfile.v0",
-    "attrs": {
-      "context": "https://github.com/crazy-max/buildkit-buildsources-test.git#master",
-      "filename": "Dockerfile",
-      "source": "docker/dockerfile:master"
-    },
-    "sources": [
-      {
-        "type": "docker-image",
-        "ref": "docker.io/docker/buildx-bin:0.6.1@sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0",
-        "pin": "sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0"
-      },
-      {
-        "type": "docker-image",
-        "ref": "docker.io/library/alpine:3.13",
-        "pin": "sha256:026f721af4cf2843e07bba648e158fb35ecc876d822130633cc49f707f0fc88c"
-      }
-    ]
-  },
   "containerimage.config.digest": "sha256:2937f66a9722f7f4a2df583de2f8cb97fc9196059a410e7f00072fc918930e66",
   "containerimage.descriptor": {
     "annotations": {

client/client_test.go

@@ -51,7 +51,6 @@ import (
 	sourcepolicypb "github.com/moby/buildkit/sourcepolicy/pb"
 	spb "github.com/moby/buildkit/sourcepolicy/pb"
 	"github.com/moby/buildkit/util/attestation"
-	binfotypes "github.com/moby/buildkit/util/buildinfo/types"
 	"github.com/moby/buildkit/util/contentutil"
 	"github.com/moby/buildkit/util/entitlements"
 	"github.com/moby/buildkit/util/purl"
@@ -168,9 +167,6 @@ func TestIntegration(t *testing.T) {
 		testRmSymlink,
 		testMoveParentDir,
 		testBuildExportWithForeignLayer,
-		testBuildInfoExporter,
-		testBuildInfoInline,
-		testBuildInfoNoExport,
 		testZstdLocalCacheExport,
 		testCacheExportIgnoreError,
 		testZstdRegistryCacheImportExport,
@@ -6672,164 +6668,6 @@ func testRelativeMountpoint(t *testing.T, sb integration.Sandbox) {
 	require.Equal(t, dt, []byte(id))
 }
 
-// moby/buildkit#2476
-func testBuildInfoExporter(t *testing.T, sb integration.Sandbox) {
-	requiresLinux(t)
-	c, err := New(sb.Context(), sb.Address())
-	require.NoError(t, err)
-	defer c.Close()
-
-	frontend := func(ctx context.Context, c gateway.Client) (*gateway.Result, error) {
-		st := llb.Image("busybox:latest").Run(
-			llb.Args([]string{"/bin/sh", "-c", `echo hello`}),
-		)
-		def, err := st.Marshal(sb.Context())
-		if err != nil {
-			return nil, err
-		}
-		return c.Solve(ctx, gateway.SolveRequest{
-			Definition: def.ToPB(),
-		})
-	}
-
-	var exports []ExportEntry
-	if integration.IsTestDockerdMoby(sb) {
-		exports = []ExportEntry{{
-			Type: "moby",
-			Attrs: map[string]string{
-				"name": "reg.dummy:5000/buildkit/test:latest",
-			},
-		}}
-	} else {
-		exports = []ExportEntry{{
-			Type:   ExporterOCI,
-			Attrs:  map[string]string{},
-			Output: fixedWriteCloser(nopWriteCloser{io.Discard}),
-		}}
-	}
-
-	res, err := c.Build(sb.Context(), SolveOpt{
-		Exports: exports,
-	}, "", frontend, nil)
-	require.NoError(t, err)
-
-	require.Contains(t, res.ExporterResponse, exptypes.ExporterBuildInfo)
-	decbi, err := base64.StdEncoding.DecodeString(res.ExporterResponse[exptypes.ExporterBuildInfo])
-	require.NoError(t, err)
-
-	var exbi binfotypes.BuildInfo
-	err = json.Unmarshal(decbi, &exbi)
-	require.NoError(t, err)
-
-	require.Equal(t, len(exbi.Sources), 1)
-	require.Equal(t, exbi.Sources[0].Type, binfotypes.SourceTypeDockerImage)
-	require.Equal(t, exbi.Sources[0].Ref, "docker.io/library/busybox:latest")
-}
-
-// moby/buildkit#2476
-func testBuildInfoInline(t *testing.T, sb integration.Sandbox) {
-	integration.CheckFeatureCompat(t, sb, integration.FeatureDirectPush)
-	requiresLinux(t)
-	c, err := New(sb.Context(), sb.Address())
-	require.NoError(t, err)
-	defer c.Close()
-
-	st := llb.Image("busybox:latest").Run(
-		llb.Args([]string{"/bin/sh", "-c", `echo hello`}),
-	)
-	def, err := st.Marshal(sb.Context())
-	require.NoError(t, err)
-
-	registry, err := sb.NewRegistry()
-	if errors.Is(err, integration.ErrRequirements) {
-		t.Skip(err.Error())
-	}
-	require.NoError(t, err)
-
-	cdAddress := sb.ContainerdAddress()
-	if cdAddress == "" {
-		t.Skip("rest of test requires containerd worker")
-	}
-
-	client, err := newContainerd(cdAddress)
-	require.NoError(t, err)
-	defer client.Close()
-
-	ctx := namespaces.WithNamespace(sb.Context(), "buildkit")
-
-	target := registry + "/buildkit/test-buildinfo:latest"
-
-	_, err = c.Solve(sb.Context(), def, SolveOpt{
-		Exports: []ExportEntry{
-			{
-				Type: ExporterImage,
-				Attrs: map[string]string{
-					"name": target,
-					"push": "true",
-				},
-			},
-		},
-	}, nil)
-	require.NoError(t, err)
-
-	img, err := client.GetImage(ctx, target)
-	require.NoError(t, err)
-
-	desc, err := img.Config(ctx)
-	require.NoError(t, err)
-
-	dt, err := content.ReadBlob(ctx, img.ContentStore(), desc)
-	require.NoError(t, err)
-
-	var config binfotypes.ImageConfig
-	require.NoError(t, json.Unmarshal(dt, &config))
-
-	dec, err := base64.StdEncoding.DecodeString(config.BuildInfo)
-	require.NoError(t, err)
-
-	var bi binfotypes.BuildInfo
-	require.NoError(t, json.Unmarshal(dec, &bi))
-
-	require.Equal(t, len(bi.Sources), 1)
-	require.Equal(t, bi.Sources[0].Type, binfotypes.SourceTypeDockerImage)
-	require.Equal(t, bi.Sources[0].Ref, "docker.io/library/busybox:latest")
-}
-
-func testBuildInfoNoExport(t *testing.T, sb integration.Sandbox) {
-	requiresLinux(t)
-	c, err := New(sb.Context(), sb.Address())
-	require.NoError(t, err)
-	defer c.Close()
-
-	frontend := func(ctx context.Context, c gateway.Client) (*gateway.Result, error) {
-		st := llb.Image("busybox:latest").Run(
-			llb.Args([]string{"/bin/sh", "-c", `echo hello`}),
-		)
-		def, err := st.Marshal(sb.Context())
-		if err != nil {
-			return nil, err
-		}
-		return c.Solve(ctx, gateway.SolveRequest{
-			Definition: def.ToPB(),
-		})
-	}
-
-	res, err := c.Build(sb.Context(), SolveOpt{}, "", frontend, nil)
-	require.NoError(t, err)
-
-	require.Contains(t, res.ExporterResponse, exptypes.ExporterBuildInfo)
-	decbi, err := base64.StdEncoding.DecodeString(res.ExporterResponse[exptypes.ExporterBuildInfo])
-	require.NoError(t, err)
-
-	var exbi binfotypes.BuildInfo
-	err = json.Unmarshal(decbi, &exbi)
-	require.NoError(t, err)
-
-	require.Equal(t, len(exbi.Sources), 1)
-	require.Equal(t, exbi.Sources[0].Type, binfotypes.SourceTypeDockerImage)
-	require.Equal(t, exbi.Sources[0].Ref, "docker.io/library/busybox:latest")
-}
-
 func testPullWithLayerLimit(t *testing.T, sb integration.Sandbox) {
 	integration.CheckFeatureCompat(t, sb, integration.FeatureDirectPush)
 	requiresLinux(t)

docs/build-repro.md

@@ -1,134 +1,6 @@
 # Build reproducibility
 
-## Build dependencies
-
-Build dependencies are generated when your image has been built. These
-dependencies include versions of used images, git repositories and HTTP URLs
-used by LLB `Source` operation as well as build request attributes.
-
-The structure is base64 encoded and has the following format when decoded:
-
-```json
-{
-  "frontend": "dockerfile.v0",
-  "attrs": {
-    "build-arg:foo": "bar",
-    "context": "https://github.com/crazy-max/buildkit-buildsources-test.git#master",
-    "filename": "Dockerfile",
-    "platform": "linux/amd64,linux/arm64",
-    "source": "crazymax/dockerfile:master"
-  },
-  "sources": [
-    {
-      "type": "docker-image",
-      "ref": "docker.io/docker/buildx-bin:0.6.1@sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0",
-      "pin": "sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0"
-    },
-    {
-      "type": "docker-image",
-      "ref": "docker.io/library/alpine:3.13",
-      "pin": "sha256:1d30d1ba3cb90962067e9b29491fbd56997979d54376f23f01448b5c5cd8b462"
-    },
-    {
-      "type": "git",
-      "ref": "https://github.com/crazy-max/buildkit-buildsources-test.git#master",
-      "pin": "259a5aa5aa5bb3562d12cc631fe399f4788642c1"
-    },
-    {
-      "type": "http",
-      "ref": "https://raw.githubusercontent.com/moby/moby/v20.10.21/README.md",
-      "pin": "sha256:419455202b0ef97e480d7f8199b26a721a417818bc0e2d106975f74323f25e6c"
-    }
-  ]
-}
-```
-
-* `frontend` defines the frontend used to build.
-* `attrs` defines build request attributes.
-* `sources` defines build sources.
-  * `type` defines the source type (`docker-image`, `git` or `http`).
-  * `ref` is the reference of the source.
-  * `pin` is the source digest.
-* `deps` defines build dependencies of input contexts.
-
-### Image config
-
-A new field similar to the one for inline cache has been added to the image
-configuration to embed build dependencies:
-
-```json
-{
-  "moby.buildkit.buildinfo.v0": "<base64>"
-}
-```
-
-By default, the build dependencies are inlined in the image configuration. You
-can disable this behavior with the [`buildinfo` attribute](../README.md#imageregistry).
-
-### Exporter response (metadata)
-
-The solver response (`ExporterResponse`) also contains a new key
-`containerimage.buildinfo` with the same structure as image config encoded in
-base64:
-
-```json
-{
-  "ExporterResponse": {
-    "containerimage.buildinfo": "<base64>",
-    "containerimage.digest": "sha256:..."
-  }
-}
-```
-
-If multi-platforms are specified, they will be suffixed with the corresponding
-platform:
-
-```json
-{
-  "ExporterResponse": {
-    "containerimage.buildinfo/linux/amd64": "<base64>",
-    "containerimage.buildinfo/linux/arm64": "<base64>",
-    "containerimage.digest": "sha256:..."
-  }
-}
-```
-
-### Metadata JSON output
-
-If you're using the `--metadata-file` flag with [`buildctl`](../README.md#metadata),
-[`buildx build`](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md)
-or [`buildx bake`](https://github.com/docker/buildx/blob/master/docs/reference/buildx_bake.md):
-
-```shell
-jq '.' metadata.json
-```
-```json
-{
-  "containerimage.buildinfo": {
-    "frontend": "dockerfile.v0",
-    "attrs": {
-      "context": "https://github.com/crazy-max/buildkit-buildsources-test.git#master",
-      "filename": "Dockerfile",
-      "source": "docker/dockerfile:master"
-    },
-    "sources": [
-      {
-        "type": "docker-image",
-        "ref": "docker.io/docker/buildx-bin:0.6.1@sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0",
-        "pin": "sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0"
-      },
-      {
-        "type": "docker-image",
-        "ref": "docker.io/library/alpine:3.13",
-        "pin": "sha256:026f721af4cf2843e07bba648e158fb35ecc876d822130633cc49f707f0fc88c"
-      }
-    ]
-  },
-  "containerimage.digest": "sha256:..."
-}
-```
-
-### Reproducing the pinned dependencies
+## Reproducing the pinned dependencies
 
 Reproducing the pinned dependencies is supported since BuildKit v0.11.
 

docs/buildinfo.md

@@ -0,0 +1,4 @@
+# Build information
+
+Build information has been removed since BuildKit v0.12.0. See the [Deprecated features page](https://github.com/moby/buildkit/blob/master/docs/deprecated.md)
+for status and alternative recommendation about this feature.