[image-builder] Export image config

[csweichel]

Description

This PR makes image-builder properly export the image config when building the workspace image. buildkit does not do this by default and the exporter needs to be told which image-config to export.

This PR also corrects a failure mode introduced by the instability of the failed condition of workspace status updates produced by ws-manager. Because of this instability, image-builder would falsely report an image-build as done when it really was not. We solve this by re-resolving the supposedly built image ref and returning a failure condition if it wasn't built. There's also a unit test for this.

Related Issue(s)

fixes #5597
fixes #5497

How to test

TODO: unit tests are upcoming (hence this being a draft)

Release Notes

[image-builder] Include environment variables in the built workspace image

[csweichel]

/assign @aledbf

[aledbf]

@csweichel I still see the same behavio?

Opening this PR in staging I get the same behavior (not inheriting PATH from dev-environment image)

oci-tool fetch image reg.csweichel-image-builder-mk-does-5597.staging.gitpod-dev.com:30099/remote/e0b0b0e4-7075-48b6-8934-53635ad28047:latest
{
  "architecture": "amd64",
  "config": {
    "Env": [
      "PATH=/ide/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
      "EDITOR=/ide/bin/code",
      "VISUAL=/ide/bin/code",
      "GP_OPEN_EDITOR=/ide/bin/code",
      "GIT_EDITOR=/ide/bin/code --wait",
      "GP_PREVIEW_BROWSER=/ide/bin/code --preview",
      "GP_EXTERNAL_BROWSER=/ide/bin/code --openExternal"
    ],
    "WorkingDir": "/"
  },

[codecov]

Codecov Report

Merging #5693 (48e5919) into main (60a93e7) will increase coverage by 18.83%.
The diff coverage is 50.00%.

@@             Coverage Diff             @@
##             main    #5693       +/-   ##
===========================================
+ Coverage   19.04%   37.88%   +18.83%     
===========================================
  Files           2       16       +14     
  Lines         168     4136     +3968     
===========================================
+ Hits           32     1567     +1535     
- Misses        134     2443     +2309     
- Partials        2      126      +124     

Flag	Coverage Δ
components-local-app-app-linux	?
components-local-app-app-windows	?
components-supervisor-app	37.88% <50.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
components/supervisor/pkg/supervisor/tasks.go	58.97% <50.00%> (ø)
components/local-app/pkg/auth/pkce.go
components/local-app/pkg/auth/auth.go
components/supervisor/pkg/ports/served-ports.go	77.02% <0.00%> (ø)
components/supervisor/pkg/ports/ports.go	60.21% <0.00%> (ø)
components/supervisor/pkg/terminal/ring-buffer.go	45.65% <0.00%> (ø)
components/supervisor/pkg/supervisor/supervisor.go	6.35% <0.00%> (ø)
components/supervisor/pkg/ports/ports-config.go	79.85% <0.00%> (ø)
components/supervisor/pkg/ports/exposed-ports.go	0.00% <0.00%> (ø)
... and 9 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 60a93e7...48e5919. Read the comment docs.

[csweichel]

Things fail oddly here:

failed to solve: failed commit on ref \\\"manifest-sha256:1498980c832450ae54c3a055b828eb9afd8417aa31be10597701dca5d35e6c6f\\\": cannot reuse body, request must be retried\"

[csweichel]

/werft run

👍 started the job as gitpod-build-csweichel-image-builder-mk-does-5597.11

[csweichel]

Issue we're facing is containerd/containerd#5978

[csweichel]

/werft run

👍 started the job as gitpod-build-csweichel-image-builder-mk-does-5597.17

[aledbf]

https://csweichel-image-builder-mk-does-5597.staging.gitpod-dev.com/#https://github.com/gitpod-io/gitpod/

{"host":"eu.gcr.io","level":"debug","message":"fetch response received","response.header.accept-ranges":"none","response.header.cache-control":"private","response.header.content-type":"application/json","response.header.date":"Fri, 24 Sep 2021 17:46:08 GMT","response.header.docker-distribution-api-version":"registry/2.0","response.header.server":"Docker Registry","response.header.vary":"Accept-Encoding","response.header.x-frame-options":"SAMEORIGIN","response.header.x-xss-protection":"0","response.status":"404 Not Found","severity":"DEBUG","time":"2021-09-24T17:46:08Z","url":"https://eu.gcr.io/v2/gitpod-core-dev/registry/workspace-images/manifests/5f4d43c7eed6f8277f2ae06148ff9b25b68a87989e6f503eb0ec2545ffc97dc0"}
{"host":"eu.gcr.io","level":"info","message":"trying next host - response was http.StatusNotFound","severity":"INFO","time":"2021-09-24T17:46:08Z"}

[csweichel]

Unfortunately we don't have an updated preview environment yet :(
The build doesn't work because of some networking issue in the build cluster

[csweichel]

After switching to crane the workspace image push finally works as expected.
Once containerd/containerd#5978 is fixed, we should switch back to buildkit.

[aledbf]

/werft run

👍 started the job as gitpod-build-csweichel-image-builder-mk-does-5597.24

[aledbf]

/approve
/lgtm

[roboquat]

LGTM label has been added.

Git tree hash: d860ebe7424793dd471a476320c056cf211d66ac

[aledbf]

/assign @corneliusludmann

[corneliusludmann]

/approve

[roboquat]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aledbf, corneliusludmann

Associated issue: #5597

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [aledbf,corneliusludmann]
• components/supervisor/OWNERS [corneliusludmann]
• components/ws-manager/OWNERS [aledbf]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment