cache backend for github actions by tonistiigi · Pull Request #1974 · moby/buildkit

tonistiigi · 2021-02-06T08:17:21Z

closes #1947

WIP version for early testing. type=gha, optional scope can be specified to namespace the cache.

TODO:

only tested some basic cases.
exporting always overwrites cache for the current writable scope. The actual version should merge all caches together and periodically clean up the branches that point to layers that github has pruned.

cache/remotecache/v1/spec.go

cache/remotecache/gha/gha.go

crazy-max · 2021-02-06T08:49:31Z

Many thanks for this feature @tonistiigi

I don't see it but I assume cache exporter already prune/gc remote blobs?

tonistiigi · 2021-02-06T16:01:20Z

I don't see it but I assume cache exporter already prune/gc remote blobs?

There is no API to remove cache blobs in Github afaics. I think Github just deletes objects whenever usage goes over the cap. I'm not sure of the exact order of how blobs are deleted (see #1947 (comment)) . Exporting will push a new manifest and currently, if it doesn't refer to the old blob anymore it will remain dangling until github cleans it up. I hope to change that so that there are periodical checks to determine what objects still exists and the old cache that still points to existing objects is merged with the new one.

chrispat · 2021-06-10T18:08:39Z

@tonistiigi in regards to

I think Github just deletes objects whenever usage goes over the cap. I'm not sure of the exact order of how blobs are deleted (see #1947 (comment))

We delete the blobs in order of least recently accessed as they go over the cap and any blob that has not been access in 7 days will be deleted. We should have an API in the near future to delete cache blobs as well.

AkihiroSuda · 2021-06-15T04:40:47Z

cache/remotecache/gha/gha.go

+)
+
+func init() {
+	actionscache.Log = log.Printf


nit: why not logrus

AkihiroSuda · 2021-06-15T04:43:01Z

cache/remotecache/gha/gha.go

+	if ce == nil {
+		return nil, errors.Errorf("blob not found")
+	}
+	rac := ce.Download(context.TODO())


Can't we pass the ctx here?

This context is long-running. Canceling it (allowed after this function returns) would cancel the ReaderAt that it returns. It should use the tracing context though, or the library should take a HTTP client so that tracing transport can be used.

AkihiroSuda · 2021-07-02T05:30:24Z

needs rebase

cache/remotecache/gha/gha.go

crazy-max

Tested on my side and LGTM:

  time="2021-07-06T22:44:49Z" level=debug msg="load cache https://artifactcache.actions.githubusercontent.com/iC2459jfgdOW9d7EC3lNVmpsYRV1wmgoJboSD3iyUzxb76QZip/_apis/artifactcache/cache?keys=buildkit-blob-1-sha256%3A5843afab387455b37944e709ee8c78d7520df80f8d01cf7f861aae63beeddb6b&version=693bb7016429d80366022f036f84856888c9f13e00145f5f6f4dce303a38d6f2"
  time="2021-07-06T22:44:49Z" level=debug msg="load cache https://artifactcache.actions.githubusercontent.com/iC2459jfgdOW9d7EC3lNVmpsYRV1wmgoJboSD3iyUzxb76QZip/_apis/artifactcache/cache?keys=buildkit-blob-1-sha256%3Adc728e95acca44552fe2f7a2fba71b75c7b2a9a5572c42f2c6291edb4a11fb37&version=693bb7016429d80366022f036f84856888c9f13e00145f5f6f4dce303a38d6f2"
  time="2021-07-06T22:44:49Z" level=debug msg="load cache https://artifactcache.actions.githubusercontent.com/iC2459jfgdOW9d7EC3lNVmpsYRV1wmgoJboSD3iyUzxb76QZip/_apis/artifactcache/cache?keys=buildkit-blob-1-sha256%3Af03631b5b56f414fd215d7b32bd09d35631f9e851c5809f8cf07edfb8e3aae44&version=693bb7016429d80366022f036f84856888c9f13e00145f5f6f4dce303a38d6f2"
  time="2021-07-06T22:44:49Z" level=debug msg="load cache https://artifactcache.actions.githubusercontent.com/iC2459jfgdOW9d7EC3lNVmpsYRV1wmgoJboSD3iyUzxb76QZip/_apis/artifactcache/cache?keys=index-buildkit-1-49c8f7d5%23&version=693bb7016429d80366022f036f84856888c9f13e00145f5f6f4dce303a38d6f2"
  time="2021-07-06T22:44:49Z" level=debug msg="load cache https://artifactcache.actions.githubusercontent.com/iC2459jfgdOW9d7EC3lNVmpsYRV1wmgoJboSD3iyUzxb76QZip/_apis/artifactcache/cache?keys=index-buildkit-1-49c8f7d5%23&version=693bb7016429d80366022f036f84856888c9f13e00145f5f6f4dce303a38d6f2"
  time="2021-07-06T22:44:49Z" level=debug msg="save cache req https://artifactcache.actions.githubusercontent.com/iC2459jfgdOW9d7EC3lNVmpsYRV1wmgoJboSD3iyUzxb76QZip/_apis/artifactcache/caches body={\"key\":\"index-buildkit-1-49c8f7d5#6\",\"version\":\"693bb7016429d80366022f036f84856888c9f13e00145f5f6f4dce303a38d6f2\"}"
  time="2021-07-06T22:44:49Z" level=debug msg="save cache resp: {\"cacheId\":65}"
  time="2021-07-06T22:44:49Z" level=debug msg="upload cache chunk https://artifactcache.actions.githubusercontent.com/iC2459jfgdOW9d7EC3lNVmpsYRV1wmgoJboSD3iyUzxb76QZip/_apis/artifactcache/caches/65, range 0-3049"
  time="2021-07-06T22:44:49Z" level=debug msg="commit cache https://artifactcache.actions.githubusercontent.com/iC2459jfgdOW9d7EC3lNVmpsYRV1wmgoJboSD3iyUzxb76QZip/_apis/artifactcache/caches/65, size 3050"
  time="2021-07-06T22:44:49Z" level=debug msg="session finished: <nil>"

crazy-max · 2021-07-07T14:48:10Z

Would need to update the README with a new section about this cache exporter.

tonistiigi · 2021-07-07T23:23:44Z

🤦 I forgot to merge this for v0.9-rc1. Writing changelog and wondered why my tool didn't detect this.

The plan was to merge this even though it is not fully complete to ease testing and gathering feedback. I guess this means rc2.

crazy-max · 2021-07-08T12:08:25Z

@tonistiigi That's fine. It will be ok in rc2. In the meantime can you rebase and merge the PR to be able to test from public repos? I already have a workflow ready.

Signed-off-by: Tonis Tiigi <[email protected]>

mlissner · 2021-07-12T19:24:00Z

crazy-max merged commit 0304821 into moby:master yesterday

Woo hoo!

moby/buildkit#1974 is merged. We no longer need extra manoeuvre to cache builds. See also https://github.com/docker/build-push-action/blob/master/docs/advanced/cache.md#github-cache

tonistiigi mentioned this pull request Feb 6, 2021

allow exporting to github cache backend docker/buildx#535

Merged

tonistiigi force-pushed the github-actions-cache branch from 7d01995 to 11c977f Compare February 6, 2021 08:26

tonistiigi commented Feb 6, 2021

View reviewed changes

cache/remotecache/v1/spec.go Outdated Show resolved Hide resolved

crazy-max reviewed Feb 6, 2021

View reviewed changes

cache/remotecache/gha/gha.go Outdated Show resolved Hide resolved

crazy-max reviewed Feb 6, 2021

View reviewed changes

cache/remotecache/gha/gha.go Outdated Show resolved Hide resolved

tonistiigi force-pushed the github-actions-cache branch from 11c977f to 7e17c13 Compare February 6, 2021 17:10

tonistiigi mentioned this pull request Feb 8, 2021

vendor: update testify #1975

Merged

tonistiigi force-pushed the github-actions-cache branch from 7e17c13 to c87a0ae Compare February 23, 2021 06:06

tonistiigi force-pushed the github-actions-cache branch from c87a0ae to 322a69b Compare March 23, 2021 00:25

Niek mentioned this pull request Apr 12, 2021

Add cache cleanup option to local cache exporter #1896

Open

CodeMonkeyLeet mentioned this pull request Apr 23, 2021

change out .devcontainer content for Codespaces environments radius-project/radius#183

Merged

tonistiigi added this to the v0.9.0 milestone Jun 11, 2021

tonistiigi force-pushed the github-actions-cache branch from 322a69b to 2554266 Compare June 11, 2021 15:35

tonistiigi marked this pull request as ready for review June 11, 2021 15:35

malobre mentioned this pull request Jun 12, 2021

Pretty big cache docker/build-push-action#252

Open

AkihiroSuda reviewed Jun 15, 2021

View reviewed changes

cache/remotecache/gha/gha.go Outdated

)

func init() {

actionscache.Log = log.Printf

Copy link

Member

AkihiroSuda Jun 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: why not logrus

AkihiroSuda reviewed Jun 15, 2021

View reviewed changes

tonistiigi force-pushed the github-actions-cache branch from 2554266 to 2235ae6 Compare June 29, 2021 23:14

crazy-max reviewed Jul 6, 2021

View reviewed changes

cache/remotecache/gha/gha.go Outdated Show resolved Hide resolved

tonistiigi force-pushed the github-actions-cache branch from 2235ae6 to cb22431 Compare July 7, 2021 00:34

AkihiroSuda approved these changes Jul 7, 2021

View reviewed changes

crazy-max approved these changes Jul 7, 2021

View reviewed changes

crazy-max mentioned this pull request Jul 8, 2021

How to quickly build and run images -- seeking help docker/build-push-action#401

Closed

tonistiigi added 3 commits July 9, 2021 20:48

initial version of github cache

fb63228

Signed-off-by: Tonis Tiigi <[email protected]>

vendor: add goactionscache

be6de51

Signed-off-by: Tonis Tiigi <[email protected]>

caps: add cap for gha cache backend

b1c80cf

Signed-off-by: Tonis Tiigi <[email protected]>

tonistiigi force-pushed the github-actions-cache branch from cb22431 to b1c80cf Compare July 10, 2021 03:50

crazy-max merged commit 0304821 into moby:master Jul 11, 2021

crazy-max mentioned this pull request Jul 12, 2021

GitHub Actions cache docs #2244

Merged

crazy-max mentioned this pull request Jul 13, 2021

Cache backend API example docker/build-push-action#406

Merged

tonistiigi mentioned this pull request Jul 14, 2021

add mock backend to help testing tonistiigi/go-actions-cache#3

Open

shyouhei mentioned this pull request Sep 29, 2022

use of type=gha ruby/ruby-ci-image#14

Merged

Conversation

tonistiigi commented Feb 6, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

crazy-max commented Feb 6, 2021

Uh oh!

tonistiigi commented Feb 6, 2021

Uh oh!

chrispat commented Jun 10, 2021

Uh oh!

AkihiroSuda Jun 15, 2021

Choose a reason for hiding this comment

Uh oh!

AkihiroSuda Jun 15, 2021

Choose a reason for hiding this comment

Uh oh!

tonistiigi Jun 28, 2021

Choose a reason for hiding this comment

Uh oh!

AkihiroSuda commented Jul 2, 2021

Uh oh!

Uh oh!

crazy-max left a comment

Choose a reason for hiding this comment

Uh oh!

crazy-max commented Jul 7, 2021

Uh oh!

tonistiigi commented Jul 7, 2021

Uh oh!

crazy-max commented Jul 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mlissner commented Jul 12, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

crazy-max commented Jul 8, 2021 •

edited

Loading