Merge pull request #473 from wking/versions-endpoint

docker_registry.app: Add a /_versions endpoint

Author: dmp42

README.md

@@ -149,6 +149,7 @@ When using the `config_sample.yml`, you can pass all options through as environm
 1. `loglevel`: string, level of debugging. Any of python's
    [logging](http://docs.python.org/2/library/logging.html) module levels:
    `debug`, `info`, `warn`, `error` or `critical`
+1. `debug_versions`: boolean, enable the `/_versions` endpoint for debugging.
 1. `storage_redirect`: Redirect resource requested if storage engine supports
    this, e.g. S3 will redirect signed URLs, this can be used to offload the
    server.

config/config_sample.yml

@@ -2,6 +2,8 @@
 common: &common
     # Default log level is info
     loglevel: _env:LOGLEVEL:info
+    # Enable the debugging /_versions endpoint
+    debug_versions: _env:DEBUG_VERSIONS:false
     # By default, the registry acts standalone (eg: doesn't query the index)
     standalone: _env:STANDALONE:true
     # The default endpoint to use (if NOT standalone) is index.docker.io
@@ -143,6 +145,7 @@ elliptics:
 dev: &dev
     <<: *local
     loglevel: _env:LOGLEVEL:debug
+    debug_versions: _env:DEBUG_VERSIONS:true
     search_backend: _env:SEARCH_BACKEND:sqlalchemy
 
 # This flavor is used by unit tests

docker_registry/app.py

@@ -3,6 +3,7 @@
 import logging
 import logging.handlers
 import os
+import sys
 
 try:
     import bugsnag
@@ -37,6 +38,30 @@ def ping():
     return toolkit.response(headers=headers)
 
 
+@app.route('/_versions')
+@app.route('/v1/_versions')
+def versions():
+    """Return a JSON object ({"package-name": "package-version", ...}).
+
+    This is an unofficial endpoint for debugging your docker-registry
+    install.  If you're running a publicly-accessible endpoint, it's
+    probably best to disable this endpoint to avoid leaking
+    implementation details.
+    """
+    versions = {}
+    if cfg.debug_versions:
+        for name, module in sys.modules.items():
+            if name.startswith('_'):
+                continue
+            try:
+                version = module.__version__
+            except AttributeError:
+                continue
+            versions[name] = version
+        versions['python'] = sys.version
+    return toolkit.response(versions)
+
+
 @app.route('/')
 def root():
     return toolkit.response('docker-registry server ({0}) (v{1})'