Add ceph-s3 config section; clean up Ceph documentation

Author: carmstrong

README.md

@@ -25,7 +25,7 @@ The fastest way to get running:
 That will use the
 [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:  
+Here is another example that will launch a container on port 5000, and store images in an Amazon S3 bucket:
 ```
 docker run \
          -e SETTINGS_FLAVOR=s3 \
@@ -62,6 +62,7 @@ In the `config_sample.yml` file, you'll see several sample flavors:
 1. `common`: used by all other flavors as base settings
 1. `local`: stores data on the local filesystem
 1. `s3`: stores data in an AWS S3 bucket
+1. `ceph-s3`: stores data in a Ceph cluster via a Ceph Object Gateway, using the S3 API
 1. `dev`: basic configuration using the `local` flavor
 1. `test`: used by unit tests
 1. `prod`: production configuration (basically a synonym for the `s3` flavor)
@@ -156,9 +157,9 @@ When using the `config_sample.yml`, you can pass all options through as environm
 1. `boto_host`/`boto_port`: If you are using `storage: s3` the
    [standard boto config file locations](http://docs.pythonboto.org/en/latest/boto_config_tut.html#details)
    (`/etc/boto.cfg, ~/.boto`) will be used.  If you are using a
-   *non*-Amazon S3-compliant object store, in one of the boto config files'
+   *non*-Amazon S3-compliant object store (such as Ceph), in one of the boto config files'
    `[Credentials]` section, set `boto_host`, `boto_port` as appropriate for the
-   service you are using.
+   service you are using. Alternatively, set `boto_host` and `boto_port` in the config file.
 1. `bugsnag`: The bugsnag API key (note that if you don't use the official docker container, you need to install the registry with bugsnag enabled: `pip install docker-registry[bugsnag]`)
 
 ### Authentication options
@@ -184,7 +185,7 @@ When using the `config_sample.yml`, you can pass all options through as environm
 ##### Generating keys with `openssl`
 
 You will need to install the python-rsa package (`pip install rsa`) in addition to using `openssl`.
-Generating the public key using openssl will lead to producing a key in a format not supported by 
+Generating the public key using openssl will lead to producing a key in a format not supported by
 the RSA library the registry is using.
 
 Generate private key:
@@ -204,7 +205,7 @@ can configure the backend with a configuration like:
 
 The `search_backend` setting selects the search backend to use.  If
 `search_backend` is empty, no index is built, and the search endpoint always
-returns empty results.  
+returns empty results.
 
 1. `search_backend`: The name of the search backend engine to use.
    Currently supported backends are:
@@ -370,23 +371,6 @@ prod:
   s3_secret_key: xdDowwlK7TJajV1Y7EoOZrmuPEJlHYcNP2k4j49T
 ```
 
-Example *non*-Amazon S3-compliant object store (e.g. Ceph and Riak CS):
-```yaml
-prod:
-  storage: s3
-  s3_bucket: acme-docker
-  s3_secure: false
-  s3_encrypt: false
-  storage_path: /registry
-  s3_access_key: AKIAHSHB43HS3J92MXZ
-  s3_secret_key: xdDowwlK7TJajV1Y7EoOZrmuPEJlHYcNP2k4j49T
-  boto_host: myowns3.com
-  boto_port: 80
-  boto_debug: true
-  boto_calling_format: OrdinaryCallingFormat
-
-```
-
 Run the Registry
 ----------------
 
@@ -417,10 +401,10 @@ is already taken, find out which container is already using it by running `docke
 ```
 docker run \
          -e SETTINGS_FLAVOR=s3 \
-         -e AWS_BUCKET=acme-docker \
+         -e AWS_BUCKET=mybucket \
          -e STORAGE_PATH=/registry \
-         -e AWS_KEY=AKIAHSHB43HS3J92MXZ \
-         -e AWS_SECRET=xdDowwlK7TJajV1Y7EoOZrmuPEJlHYcNP2k4j49T \
+         -e AWS_KEY=myawskey \
+         -e AWS_SECRET=myawssecret \
          -e SEARCH_BACKEND=sqlalchemy \
          -p 5000:5000 \
          -p AWS_HOST=myowns3.com \
@@ -495,7 +479,7 @@ behind a nginx server which supports chunked transfer-encoding (nginx >= 1.3.9).
 
 #### nginx
 
-[Here is an nginx configuration file example.](https://github.com/docker/docker-registry/blob/master/contrib/nginx/nginx.conf), which applies to versions < 1.3.9 which are compiled with the [HttpChunkinModule](http://wiki.nginx.org/HttpChunkinModule). 
+[Here is an nginx configuration file example.](https://github.com/docker/docker-registry/blob/master/contrib/nginx/nginx.conf), which applies to versions < 1.3.9 which are compiled with the [HttpChunkinModule](http://wiki.nginx.org/HttpChunkinModule).
 
 [This is another example nginx configuration file](https://github.com/docker/docker-registry/blob/master/contrib/nginx/nginx_1-3-9.conf) that applies to versions of nginx greater than 1.3.9 that have support for the chunked_transfer_encoding directive.
 

config/config_sample.yml

@@ -86,7 +86,23 @@ s3: &s3
     s3_secret_key: _env:AWS_SECRET
     boto_host: _env:AWS_HOST
     boto_port: _env:AWS_PORT
-    boto_debug: _env:AWS_DEBUG
+
+# Ceph Object Gateway Configuration
+# See http://ceph.com/docs/master/radosgw/ for details on installing this service.
+ceph-s3: &ceph-s3
+    <<: *common
+    storage: s3
+    s3_region: ~
+    s3_bucket: _env:AWS_BUCKET
+    s3_encrypt: _env:AWS_ENCRYPT:false
+    s3_secure: _env:AWS_SECURE:false
+    storage_path: _env:STORAGE_PATH:/registry
+    s3_access_key: _env:AWS_KEY
+    s3_secret_key: _env:AWS_SECRET
+    boto_bucket: _env:AWS_BUCKET
+    boto_host: _env:AWS_HOST
+    boto_port: _env:AWS_PORT
+    boto_debug: _env:AWS_DEBUG:0
     boto_calling_format: _env:AWS_CALLING_FORMAT
 
 # Google Cloud Storage Configuration