byrnedo / docker-reg-tool

Docker registry cli tool, primarily for deleting images.

Docker Registry Tool

Small bash script to do repetitive things with docker registry > 2.1 ( I think, whichever version supports delete by manifest)

Dependencies

Jq

Usage:

    ./docker_reg_tool REGISTRY_BASE_URL ACTION [OPTIONS..]

    Actions:

    - list               list repos

    - list REPO          list tags for repo

    - delete REPO TAG    delete tag for repo

    Example:

    List all repos
        /$ ./docker_reg_tool https://registry.my.domain list

    List tags for one repo
        /$ ./docker_reg_tool https://registry.my.domain list some-repo

    Delete tag for a repo
        /$ ./docker_reg_tool https://registry.my.domain delete some-repo some-tag

If you want something more fully featured then check out crane.

Docker config file location

If your config.json location is not ~/.docker/config.json, you can define the location with the DOCKER_CONFIG environment variable.

DOCKER_CONFIG="/your/path/to/docker/config.json" ./docker_reg_tool ...

Credentials

...are sniffed out of ~/.docker/config.json. So you need to do docker login... before you can use this tool.

They can also be set with the BASIC_AUTH environment variable.

BASIC_AUTH=user:pass ./docker_reg_tool ...

Only been tested on Basic auth.

Insecure Registry

Set the INSECURE_REGISTRY to true;

INSECURE_REGISTRY=true ./docker_reg_tool ...

Registry Settings

In order for this to work, the registry needs to be running with If docker image:

REGISTRY_STORAGE_DELETE_ENABLED="true"

Or in the config file:

storage:
  delete:
    enabled: true

Also, the size will not decrease until the garbage collector runs. You can trigger it manually with:

docker exec registry /bin/registry garbage-collect -m=true /etc/docker/registry/config.yml

Debugging

Set the TRACE environment variable to true to turn on set -x

TRACE=true ./docker_reg_tool ...

Docker Image

See https://hub.docker.com/r/byrnedo/reg-tool/

docker-reg-tool's Issues

~/.docker/config.json cannot have the protocol specified

In my ~/.docker/config.json file I have the protocol specified. That causes the following error:

$ ./docker_reg_tool https://docker-reg:5000 list repo
jq: error (at <stdin>:1): Cannot iterate over null (null)

I've created a pull request (#7) to allow the protocol to be specified in the ~/.docker/config.json file as well as ensure that jq doesn't return null silently when trying to extract the creds.

Cannot iterate over null

Hi!

Hoping this tool can help me delete some repo.

I tried list on two different repos and get
jq: error (at <stdin>:3): Cannot iterate over null (null)

I installed the latest version 1.6 of jq on Mac OS.
The credentials are stored in the docker config.json file.

Failed to delete: 405

Hi!
Hoping this script can help me delete some tags.

I tried delete and the error is:

DIGEST: sha256:b32067df1e504742bdea7c169916ddc51b848856f0d02c7b1c6a99c6533e5921
Failed to delete: 405

Regards

Change ~ to $HOME

Not sure why but "~" is not being expanded in https://github.com/byrnedo/docker-reg-tool/blob/master/docker_reg_tool#L52
Maybe setting to $HOME is more standar.

curl DELETE unsupported

Hello,

When I want to delete an image tag, my registry returns an error on curl DELETE request;

+ digest=sha256:1129ffce3939335244f6332524072bfef27b9bd8fe23a64aa1e288752b36526c
+ echo 'DIGEST: sha256:1129ffce3939335244f6332524072bfef27b9bd8fe23a64aa1e288752b36526c'
DIGEST: sha256:1129ffce3939335244f6332524072bfef27b9bd8fe23a64aa1e288752b36526c
++ curlCmd -s -o /dev/null -w '%{http_code}' -H Accept:application/vnd.docker.distribution.manifest.v2+json -X DELETE http://registry.domain.com/v2/myimage/manifests/sha256:1129ffce3939335244f6332524072bfef27b9bd8fe23a64aa1e288752b36526c
++ curl '' --header '' -s -o /dev/null -w '%{http_code}' -H Accept:application/vnd.docker.distribution.manifest.v2+json -X DELETE http://registry.domain.com/v2/myimage/manifests/sha256:1129ffce3939335244f6332524072bfef27b9bd8fe23a64aa1e288752b36526c
+ result='000{"errors":[{"code":"UNSUPPORTED","message":"The operation is unsupported."}]}
405'
+ '[' '000{"errors":[{"code":"UNSUPPORTED","message":"The operation is unsupported."}]}
405' -eq 202 ']'
./docker_reg_tool: line 116: [: 000{"errors":[{"code":"UNSUPPORTED","message":"The operation is unsupported."}]}
405: integer expression expected
+ echo 'Failed to delete: 000{"errors":[{"code":"UNSUPPORTED","message":"The operation is unsupported."}]}
405'
Failed to delete: 000{"errors":[{"code":"UNSUPPORTED","message":"The operation is unsupported."}]}
405
+ exit 3```

conditional binary operator expected

I catch this error conditional binary operator expected on every line with

if [[ -v "VARNAME" ]] ...

consider using

if [[ ${VARNAME} ]] ...

instead. It seems -v was introduced in bash 4+ while macos still uses version 3

Delete successfully but total size of registry data still equal before delete

Hi All,
I deleted sucessfully, but total size in folder registry data still the same as before i deleted. So when we delete repo with tag, it will delete data or not ?

Delete repo tag

https://github.com/byrnedo/docker-reg-tool/blob/master/docker_reg_tool#L30

The help is missing the TAG value.

Command not found

Hi there!

Wanted to use your script, but when I issue this command:
root@test:~ ./docker_reg_tool http://localhost:5000 list
I get this error msg:
./docker_reg_tool: line 73: jq: command not found

Tried to add +x to the second line of the file, didnt help.
Any idea?
Thanks! :)

listing does not work on Ubuntu 18

I've got registry under URL:
https://registry.***.com/v2/_catalog

When I run

sudo ./docker_reg_tool https://registry.***.com list

I have just one line in console (Ubuntu 18):

jq: error (at <stdin>:1): Cannot iterate over null (null)

Create Docker image for docker-reg-tool

Hi,
Would you be up for creating a docker image for docker-reg-tool? 😊

insecure registry and list restricted to first 100 entries

Thank you for the script. Very useful.

I needed to add -k in curl as my local registry is insecure.

Any way - the list reports only 100 entries. This may be restriction from the API. Any idea on getting list of all entries. My private registry has more than 300 entries.

Might want to mention that `REGISTRY_STORAGE_DELETE_ENABLED` needs to be `true`

I wasn't able to delete until I started my private repo with this flag:

  -e REGISTRY_STORAGE_DELETE_ENABLED="true"

Maybe this could be noted in the readme?

delete all tags when run delete repo tag

delete all tags of the repo when run delete repo tag
./docker_reg_tool https://registry.my.domain delete some-repo some-tag