Merge pull request #525 from docker/next

Next

Author: shin-

.travis.yml

@@ -4,6 +4,11 @@ python:
   - "2.6"
   - "2.7"
 
+before_install:
+  - sudo apt-get update
+  - sudo apt-get install redis-server
+  - sudo apt-get install libevent-dev liblzma-dev
+
 install:
 ## This below should be separated when core lives elsewhere
 # Install core tests reqs
@@ -16,9 +21,10 @@ install:
   - pip install -rrequirements/test.txt
   - pip install .
 
-# XXX should run the core tests as well
-script: SETTINGS_FLAVOR=test DOCKER_REGISTRY_CONFIG=config_sample.yml flake8 . && SETTINGS_FLAVOR=test DOCKER_REGISTRY_CONFIG=config_sample.yml python setup.py nosetests
+before_script:
+  - redis-server &
 
-before_install:
-  - sudo apt-get update
-  - sudo apt-get install libevent-dev liblzma-dev
+script:
+  - SETTINGS_FLAVOR=test DOCKER_REGISTRY_CONFIG=config_sample.yml flake8
+  - SETTINGS_FLAVOR=test DOCKER_REGISTRY_CONFIG=config_sample.yml python setup.py nosetests
+  - cd depends/docker-registry-core && python setup.py nosetests

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Docker-registry
 
+## 0.9.0-dev
+
+ * "loose" dependencies mechanism (DEPS=loose environment var will let you install without strictly versioned dependencies)
+ * enhanced python version compatibility
+ * enhanced style checking
+ * enhanced testing
+ * uniformized various gunicorn start stances
+ 
+
 ## 0.8.0
 
  * configuration rehaul: https://github.com/docker/docker-registry/pull/444 - beware this breaks API for the drivers, and the core package has been updated accordingly to denote that

CONTRIBUTE.md

@@ -103,3 +103,10 @@ Pretty much:
 
 Drivers are expected to receive bytes and to return bytes.
 Don't try to decode or encode content.
+
+## Development environement notes
+
+We don't currently run any tests for python3, as we are stuck on gevent not being py3 ready.
+
+On OSX, in order for the dependencies to compile properly (inside tox venv) you might need to have extra include and lib specified. Environment variables are provided for that, namely $TOX_INCLUDE and $TOX_LIB.
+

README.md

@@ -19,11 +19,11 @@ Quick start
 
 The fastest way to get running:
 
- * install docker according to the [following instructions](http://docs.docker.io/installation/#installation)
+ * install docker according to the [following instructions](https://docs.docker.com/installation/#installation)
  * run the registry: `docker run -p 5000:5000 registry`
 
 That will use the
-[official image from the Docker index](https://index.docker.io/_/registry/).
+[official image from the Docker index](https://registry.hub.docker.com/_/registry/).
 
 Here is another example that will launch a container on port 5000, and store images in an Amazon S3 bucket:  
 ```
@@ -407,10 +407,10 @@ Then install the Registry app:
 sudo pip install docker-registry
 ```
 
-If you need extra requirements, like bugsnag, specify them:
+If you need extra requirements, like bugsnag, or new-relic specify them:
 
 ```
-sudo pip install docker-registry[bugsnag]
+sudo pip install docker-registry[bugsnag,newrelic]
 ```
 
 
@@ -430,15 +430,15 @@ should not require the additional repositories.
 Then install the Registry app:
 
 ```
-sudo python-pip install docker-registry[bugsnag]
+sudo python-pip install docker-registry[bugsnag,newrelic]
 ```
 
 (or clone the repository and `pip install .`)
 
 #### Run it
 
 ```
-gunicorn --access-logfile - -k gevent -b 0.0.0.0:5000 -w 4 --max-requests 100 docker_registry.wsgi:application
+docker-registry
 ```
 
 ### How do I setup user accounts?
@@ -452,13 +452,6 @@ auth enabled (see `contrib/` for examples).
 The recommended setting to run the Registry in a prod environment is gunicorn
 behind a nginx server which supports chunked transfer-encoding (nginx >= 1.3.9).
 
-You could use for instance supervisord to spawn the registry with 8 workers
-using this command:
-
-```
-gunicorn -k gevent --max-requests 100 --graceful-timeout 3600 -t 3600 -b localhost:5000 -w 8 docker_registry.wsgi:application
-```
-
 #### nginx
 
 [Here is an nginx configuration file example.](https://github.com/docker/docker-registry/blob/master/contrib/nginx.conf), which applies to versions < 1.3.9 which are compiled with the [HttpChunkinModule](http://wiki.nginx.org/HttpChunkinModule). 
@@ -482,6 +475,20 @@ requests to the Docker Registry:
   ProxyPassReverse   /  http://localhost:5000/
 ```
 
+#### Advanced start options (NOT recommended)
+
+If you want greater control over gunicorn:
+
+```
+gunicorn -c contrib/gunicorn.py docker_registry.wsgi:application
+```
+
+or even bare
+
+```
+gunicorn --access-logfile - --error-logfile - -k gevent -b 0.0.0.0:5000 -w 4 --max-requests 100 docker_registry.wsgi:application
+```
+
 For developers
 --------------
 

config/gunicorn_config.py

@@ -0,0 +1,28 @@
+# Gunicorn config file
+
+import os
+
+flavor = os.environ.get('SETTINGS_FLAVOR', 'dev')
+
+reload = True
+bind = '%s:%s' % (
+    os.environ.get('REGISTRY_HOST', '0.0.0.0'),
+    os.environ.get('REGISTRY_PORT', '5000')
+)
+graceful_timeout = int(os.environ.get('GUNICORN_GRACEFUL_TIMEOUT'), 3600)
+timeout = int(os.environ.get('GUNICORN_SILENT_TIMEOUT'), 3600)
+worker_class = 'gevent'
+max_requests = 100
+workers = int(os.environ.get('GUNICORN_WORKERS', 4))
+log_level = 'debug'
+debug = True
+accesslog = os.environ.get('GUNICORN_ACCESS_LOG_FILE', '-')
+errorlog = os.environ.get('GUNICORN_ERROR_LOG_FILE', '-')
+access_log_format = ('%(h)s %(l)s %(u)s %(t)s "%(r)s" %(s)s %(b)s "%(f)s" '
+                     '"%(a)s" %(D)s %({X-Docker-Size}o)s')
+
+if flavor == 'prod' or flavor == 'staging':
+    reload = False
+    workers = 8
+    debug = False
+    log_level = 'info'

contrib/gunicorn_config.py

@@ -47,6 +47,10 @@
 __title__ = 'docker-registry-core'
 __build__ = 0x000000
 
+__url__ = 'https://github.com/docker/docker-registry'
+__description__ = 'Docker registry core package'
+__download__ = 'https://github.com/docker/docker-registry/archive/master.zip'
+
 try:
     NullHandler = logging.NullHandler
 except AttributeError:

depends/docker-registry-core/docker_registry/core/__init__.py

@@ -37,7 +37,6 @@
 
 from . import driver
 from . import lru
-
 from .exceptions import FileNotFoundError
 
 logger = logging.getLogger(__name__)

depends/docker-registry-core/docker_registry/core/boto.py

@@ -41,8 +41,9 @@
 
 class Base(object):
 
-    """Storage is a convenience class that describes methods that must be
-    implemented by any backend.
+    """Storage is a convenience class...
+
+    ... that describes methods that must be implemented by any backend.
     You should inherit (or duck type) this if you are implementing your own.
 
     :param host: host name
@@ -157,60 +158,52 @@ def put_bytes(self, path, content):
         return self.put_content(path, content)
 
     def get_content(self, path):
-        """Method to get content
-        """
+        """Method to get content."""
         raise NotImplementedError(
             "You must implement get_content(self, path) on your storage %s" %
             self.__class__.__name__)
 
     def put_content(self, path, content):
-        """Method to put content
-        """
+        """Method to put content."""
         raise NotImplementedError(
             "You must implement put_content(self, path, content) on %s" %
             self.__class__.__name__)
 
     def stream_read(self, path, bytes_range=None):
-        """Method to stream read
-        """
+        """Method to stream read."""
         raise NotImplementedError(
             "You must implement stream_read(self, path, , bytes_range=None) " +
             "on your storage %s" %
             self.__class__.__name__)
 
     def stream_write(self, path, fp):
-        """Method to stream write
-        """
+        """Method to stream write."""
         raise NotImplementedError(
             "You must implement stream_write(self, path, fp) " +
             "on your storage %s" %
             self.__class__.__name__)
 
     def list_directory(self, path=None):
-        """Method to list directory
-        """
+        """Method to list directory."""
         raise NotImplementedError(
             "You must implement list_directory(self, path=None) " +
             "on your storage %s" %
             self.__class__.__name__)
 
     def exists(self, path):
-        """Method to test exists
-        """
+        """Method to test exists."""
         raise NotImplementedError(
             "You must implement exists(self, path) on your storage %s" %
             self.__class__.__name__)
 
     def remove(self, path):
-        """Method to remove
-        """
+        """Method to remove."""
         raise NotImplementedError(
             "You must implement remove(self, path) on your storage %s" %
             self.__class__.__name__)
 
     def get_size(self, path):
-        """Method to get the size
-        """
+        """Method to get the size."""
         raise NotImplementedError(
             "You must implement get_size(self, path) on your storage %s" %
             self.__class__.__name__)

depends/docker-registry-core/docker_registry/core/driver.py

@@ -34,8 +34,7 @@
 
 class UnspecifiedError(Exception):
 
-    """Base class for all exceptions in docker_registry
-    """
+    """Base class for all exceptions in docker_registry."""
 
     def __init__(self, *args, **kwargs):
         self.message = kwargs.pop('message', 'No details')
@@ -44,8 +43,9 @@ def __init__(self, *args, **kwargs):
 
 class UsageError(UnspecifiedError):
 
-    """Exceptions related to use of the library, like missing files,
-    wrong argument type, etc.
+    """Exceptions related to use of the library.
+
+    Missing files, wrong argument type, etc.
     """