Add tag delete API by joaodrp · Pull Request #3427 · distribution/distribution

joaodrp · 2021-05-27T22:24:22Z

The tag delete API operation has finally made it to the OCI Distribution spec, in v1.0.0 (source). This PR makes the required changes to incorporate such functionality.

Signed-off-by: João Pereira 484633+joaodrp@users.noreply.github.com

Signed-off-by: João Pereira <484633+joaodrp@users.noreply.github.com>

codecov-commenter · 2021-05-27T22:59:50Z

Codecov Report

Merging #3427 (81f081f) into main (d80a63f) will increase coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3427      +/-   ##
==========================================
+ Coverage   56.16%   56.19%   +0.02%     
==========================================
  Files         102      102              
  Lines        7303     7323      +20     
==========================================
+ Hits         4102     4115      +13     
- Misses       2553     2556       +3     
- Partials      648      652       +4

Impacted Files	Coverage Δ
...ibution/distribution/registry/client/repository.go	`56.79% <0.00%> (-0.12%)`	⬇️
...ribution/distribution/registry/storage/tagstore.go	`75.47% <0.00%> (+0.47%)`	⬆️
...bution/distribution/registry/handlers/manifests.go	`52.50% <0.00%> (+1.11%)`	⬆️

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 d80a63f...81f081f. Read the comment docs.

docs/spec/api.md

joaodrp · 2021-05-27T23:00:38Z

notifications/listener_test.go

+	if err := repository.Tags(ctx).Tag(ctx, tag, distribution.Descriptor{Digest: dgst}); err != nil {
+		t.Fatalf("unexpected error tagging manifest: %v", err)
+	}
+


The manifest was not tagged in this test, so there was no tag to delete...

joaodrp · 2021-05-27T23:01:48Z

notifications/listener_test.go

+	err = repository.Tags(ctx).Untag(ctx, m.Tag)
+	if err != nil {
+		t.Fatalf("unexpected error deleting tag: %v", err)
+	}


We have to delete the tag first and only then the manifest, not otherwise (as the tag would be deleted after deleting the manifest). That's why I'm moving this higher up.

This test was not failing until now because we were ignoring not found errors (see #3427 (comment)).

joaodrp · 2021-05-27T23:03:52Z

registry/storage/tagstore.go

-	if err := ts.blobStore.driver.Delete(ctx, tagPath); err != nil {
-		switch err.(type) {
-		case storagedriver.PathNotFoundError:
-			return nil // Untag is idempotent, we don't care if it didn't exist


This is no longer true. We must respond with 404 Not Found if a tag is not found at the API level. So returning the error here and letting the caller decide what to do with it.

registry/storage/tagstore_test.go

milosgajdos

LGTM, I only have one question I'd like to get cleared up.

docs/spec/api.md

registry/handlers/manifests.go

Signed-off-by: João Pereira <484633+joaodrp@users.noreply.github.com>

milosgajdos

LGTM.

wy65701436 · 2021-06-04T02:31:06Z

registry/handlers/manifests.go

+			case distribution.ErrTagUnknown, driver.PathNotFoundError:
+				imh.Errors = append(imh.Errors, v2.ErrorCodeManifestUnknown)
+			default:
+				imh.Errors = append(imh.Errors, errcode.ErrorCodeUnknown)


it's better to append the details, errcode.ErrorCodeUnknown.WithDetail(err)

registry/handlers/manifests.go

wy65701436 · 2021-06-04T02:46:30Z

registry/handlers/manifests.go


+	if imh.Tag != "" {
+		tagService := imh.Repository.Tags(imh.Context)
+		if err := tagService.Untag(imh.Context, imh.Tag); err != nil {


add log here? dcontext.GetLogger(imh).Debug("DeleteImageTag")

Signed-off-by: João Pereira <484633+joaodrp@users.noreply.github.com>

wy65701436

lgtm

antoinetran · 2022-02-07T10:24:17Z

Hi, hem it does not seems to me that this merge is included in 2.8.0.beta1? I looked at the changelog and can't find it. Even https://docs.docker.com/registry/spec/api/#detail does not include the doc modification. ping @milosgajdos maybe? Thank you.

milosgajdos · 2022-02-07T10:57:53Z

@antoinetran no, it isn't in 2.x. We made a decision to not include anything new in the last 2.x release. You'll have to build of main or pull :edge tag, I'm afraid.

chethankumar4046 · 2023-04-13T08:11:16Z

@milosgajdos @wy65701436 Where can i see documentation about, Delete image by tag. in V2.
Thanks

milosgajdos · 2023-04-13T08:56:42Z

@chethankumar4046 this PR diff will show you where the docs are. It pays off looking into diffs.

chethankumar4046 · 2023-04-14T09:41:24Z

@milosgajdos I gone through PR But I need more clarification Because i see some open ticket and I tried above method but it deleted my whole image,
When i try to list image i got this output, when i run this api /v2/chethantest/tags/list
{"errors":[{"code":"NAME_UNKNOWN","message":"repository name not known to registry","detail":{"name":"chethantest"}}]}
#2317 (comment)

ioparaskev · 2024-09-27T14:17:46Z

@milosgajdos this fix doesn't seem to be released currently in any of the 2.x released versions (at least according to the release notes). Is there a plan of releasing it in version 2.x at some point? If yes, I was wondering if there's any optimistic timeline for this. Or if there's a milestone for releasing a stable 3.x version

milosgajdos · 2024-09-29T19:43:46Z

@milosgajdos this fix doesn't seem to be released currently in any of the 2.x released versions

Correct. 2.x is basically in a maintenance mode at this point.

Or if there's a milestone for releasing a stable 3.x version

The original plan was by the end of this year but as you may have noticed we have 10+ maintainers on this repo and I'm the only one active. Or I was until I gave up on chasing the others, so no ETA.

ioparaskev · 2024-09-30T06:32:59Z

@milosgajdos this fix doesn't seem to be released currently in any of the 2.x released versions

Correct. 2.x is basically in a maintenance mode at this point.

Or if there's a milestone for releasing a stable 3.x version

The original plan was by the end of this year but as you may have noticed we have 10+ maintainers on this repo and I'm the only one active. Or I was until I gave up on chasing the others, so no ETA.

I see. Thanks for the update!

joaodrp added feature conformance Related to conformance to distribution specification labels May 27, 2021

Add tag delete API

6ae6df7

Signed-off-by: João Pereira <484633+joaodrp@users.noreply.github.com>

joaodrp force-pushed the tag-delete branch from 2d34979 to 6ae6df7 Compare May 27, 2021 22:27

Fix listener tests

22053f5

Signed-off-by: João Pereira <484633+joaodrp@users.noreply.github.com>

joaodrp commented May 27, 2021

View reviewed changes

joaodrp requested review from milosgajdos and thaJeztah May 27, 2021 23:09

joaodrp mentioned this pull request May 27, 2021

New Tags API #2169

Closed

milosgajdos reviewed May 28, 2021

View reviewed changes

docs/spec/api.md Outdated Show resolved Hide resolved

registry/handlers/manifests.go Outdated Show resolved Hide resolved

milosgajdos added this to the Registry/3.0.0 milestone May 28, 2021

Remove unrelated spec update

1398d3b

Signed-off-by: João Pereira <484633+joaodrp@users.noreply.github.com>

milosgajdos requested a review from wy65701436 May 28, 2021 09:26

Group case values

81f081f

Signed-off-by: João Pereira <484633+joaodrp@users.noreply.github.com>

milosgajdos approved these changes May 28, 2021

View reviewed changes

milosgajdos requested a review from waynr May 28, 2021 15:52

wy65701436 reviewed Jun 4, 2021

View reviewed changes

registry/handlers/manifests.go Outdated Show resolved Hide resolved

wy65701436 reviewed Jun 4, 2021

View reviewed changes

registry/handlers/manifests.go Show resolved Hide resolved

wy65701436 reviewed Jun 4, 2021

View reviewed changes

apply feedback

033683d

Signed-off-by: João Pereira <484633+joaodrp@users.noreply.github.com>

milosgajdos requested a review from wy65701436 June 13, 2021 19:55

wy65701436 approved these changes Jun 14, 2021

View reviewed changes

milosgajdos merged commit af8ac80 into distribution:main Jun 14, 2021

milosgajdos mentioned this pull request Jun 16, 2021

docker registry: image deletion by name and tag #3394

Closed

tianon mentioned this pull request Jul 23, 2021

docker registry: image deletion by name and tag distribution/distribution-library-image#119

Closed

mtrmac mentioned this pull request Aug 26, 2021

skopeo delete command deletes by reference even when we provide tag containers/skopeo#1432

Open

hcguersoy mentioned this pull request Feb 22, 2022

Delete at least the tag if using ignore option hcguersoy/cleanreg#7

Open

kohtala mentioned this pull request Dec 8, 2022

Deleting tags without deleting the image #2317

Open

antoinetran mentioned this pull request Mar 10, 2023

Roadmap for release registry v3 #3858

Closed

Conversation

joaodrp commented May 27, 2021 • edited by thaJeztah Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented May 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

joaodrp May 27, 2021

Choose a reason for hiding this comment

Uh oh!

joaodrp May 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joaodrp May 27, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

milosgajdos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

milosgajdos left a comment

Choose a reason for hiding this comment

Uh oh!

wy65701436 Jun 4, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joaodrp Jun 6, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

wy65701436 Jun 4, 2021

Choose a reason for hiding this comment

Uh oh!

joaodrp Jun 6, 2021

Choose a reason for hiding this comment

Uh oh!

wy65701436 left a comment

Choose a reason for hiding this comment

Uh oh!

antoinetran commented Feb 7, 2022

Uh oh!

milosgajdos commented Feb 7, 2022

Uh oh!

chethankumar4046 commented Apr 13, 2023

Uh oh!

milosgajdos commented Apr 13, 2023

Uh oh!

chethankumar4046 commented Apr 14, 2023

Uh oh!

ioparaskev commented Sep 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

milosgajdos commented Sep 29, 2024

Uh oh!

ioparaskev commented Sep 30, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

joaodrp commented May 27, 2021 •

edited by thaJeztah

Loading

codecov-commenter commented May 27, 2021 •

edited

Loading

joaodrp May 27, 2021 •

edited

Loading

wy65701436 Jun 4, 2021 •

edited

Loading

ioparaskev commented Sep 27, 2024 •

edited

Loading