Skip to content

Latest commit

 

History

History
120 lines (104 loc) · 5.55 KB

README.md

File metadata and controls

120 lines (104 loc) · 5.55 KB
Raw

Bow

As simple as possible docker registry frontend/UI

Pictures

Features

  • V2 registries support only (secure, self-signed and insecure, DNS and IP:PORT)
  • internal DB (BoltBD) gives it the ability to store info, and as the result, it responses much faster than after direct API call, and can provide more data
  • the app can pars, store and show info from registry such as:
  • image layers info:
    • name / tag
    • image size and a number of pushes
    • upload and push dates
  • an image creating commands history
  • it is possible to set multiple repositories and watch all registries in one place
  • show statistics pretty, draw curves of uploads number and image sizes for a tag with respects to dates
  • find a parent of an image, in case, the parent in the same repo (it is clickable!)
  • show tree-graph of parents for image
  • enabled image deletion (registry --version >= 2.4.0)
  • (new) API compatibility checks
  • (the newest) Bearer token auth support (secure and self-signed auth servers)
  • (killerfeature) Namespace layer and parents graph filters

Image deletion

To enable image deletion you need to:

  1. Run your registry with the flag -e REGISTRY_STORAGE_DELETE_ENABLED=true
    Example:
docker run -d -p 5000:5000 --restart=always --name registry \
  -v ./auth:/auth \
  -e "REGISTRY_AUTH=htpasswd" \
  -e "REGISTRY_AUTH_HTPASSWD_REALM=Registry Realm" \
  -e REGISTRY_AUTH_HTPASSWD_PATH=/auth/htpasswd \
  -e REGISTRY_STORAGE_DELETE_ENABLED=true \
  registry:2
  1. Set up cron to run garbage collection
    Example:
    10 * * * * docker exec registry bin/registry garbage-collect /etc/docker/registry/config.yml
  2. Also be aware, that there is a known issue in docker registry 2.6.2 and earlier. It means, that if you delete an image from a repository, you will not able to push the exactly same image in that repository. To fix it, you will need to perform rebuilding of image with --no-cache mode each time or restarting the registry docker restart registry once after deletion.

See more:
docker-archive/docker-registry#988 (comment)
https://docs.docker.com/registry/configuration/#delete
https://docs.docker.com/registry/garbage-collection/#/how-garbage-collection-works

Bearer token auth

What is it and how it works see docker documentation.
Bow was tested to work with cesanta/docker_auth in this configuration.

Prospects

I can say that this app almost fit my needs, so in all likelihood, soon, I will not improve it hardly, but this is the list of ideas just for case:

  • info for the whole repository: size, number of pushes so on so on soon
  • add button 'Don't Track', to store repo data but not update it
  • add tests for bearer token and image deletion

How to start to use Bow

docker run -d \
   --name=Bow \
   -e BS_LOG_SILENT=yes \
   -e BS_TIME_WATCH=no \
   -v ~/db/bow:/var/lib/bow \
   -p 5001:19808 \
   evedel/bow

There are some parameters, that can be set only as environment variables. Short descriptions with default value:

  • BS_LOG_SILENT="" -- logging level, default is full logging
  • BS_DB_PATH="/var/lib/bow" -- path to store your db
  • BS_DB_NAME="asapdrf.db" -- name of db and db file
  • BS_SERVE_ADD="19808" -- port address to serve
  • BS_CHECKER_TIMEOUT="300" -- seconds, time to renew data
  • BS_TIME_WATCH="yes" -- print time of execution for qurl queries and page-renderers

The full list of available tags can be found at hub.docker.com.

evedel/bow:latest -- the last build based on debian:jessie image (68MB)
evedel/bow:debian-latest -- the same last build based on debian image (68MB)
evedel/bow:alpine-latest -- the last alpine based build (4.7MB)
evedel/bow:debian-$(buildNumber) -- tagged previously released versions based on debian (68MB).
evedel/bow:alpine-$(buildNumber) -- tagged previously released versions based on alpine (4.7MB).
evedel/bow:$(buildNumber) -- tagged previously released versions based on debian.

How to start contribute to Bow

If you have interest, you can easily start with

git clone https://github.com/evedel/bow.git
cd bow && git clone https://github.com/fperucic/treant-js project/resources/treant-js
docker-compose -f develop/devcompose.yml up -d
docker exec -it develop_golang_1 go get
docker exec -it develop_golang_1 go test -v qurl -repo='https://UsErNaMe:PaSsWoRd@myownregistry.org'
docker exec -it develop_golang_1 go run main.go

Code and packages

This app is written on golang with use of standard packages and:
https://github.com/boltdb/bolt -- BoltDB
https://github.com/fatih/color -- to make cli shiny
https://github.com/wader/disable_sendfile_vbox_linux -- to develop on docker-machine
http://www.chartjs.org/ -- to draw best graphs ever
https://github.com/fperucic/treant-js -- to draw parents graphs