github.com/mika/distribution@v2.2.2-0.20160108133430-a75790e3d8e0+incompatible/docs/storage-drivers/rados.md (about)

     1  <!--[metadata]>
     2  +++
     3  title = "Ceph RADOS storage driver"
     4  description = "Explains how to use the Ceph RADOS storage driver"
     5  keywords = ["registry, service, driver, images, storage, ceph,  rados"]
     6  +++
     7  <![end-metadata]-->
     8  
     9  
    10  # Ceph RADOS storage driver
    11  
    12  An implementation of the `storagedriver.StorageDriver` interface which uses
    13  [Ceph RADOS Object Storage][rados] for storage backend.
    14  
    15  ## Parameters
    16  
    17  The following parameters must be used to configure the storage driver
    18  (case-sensitive):
    19  
    20  * `poolname`: Name of the Ceph pool
    21  * `username` *optional*: The user to connect as (i.e. admin, not client.admin)
    22  * `chunksize` *optional*: Size of the written RADOS objects. Default value is
    23  4MB (4194304).
    24  
    25  This drivers loads the [Ceph client configuration][rados-config] from the
    26  following regular paths (the first found is used):
    27  
    28  * `$CEPH_CONF` (environment variable)
    29  * `/etc/ceph/ceph.conf`
    30  * `~/.ceph/config`
    31  * `ceph.conf` (in the current working directory)
    32  
    33  ## Developing
    34  
    35  To include this driver when building Docker Distribution, use the build tag
    36  `include_rados`. Please see the [building documentation][building] for details.
    37  
    38  [rados]: http://ceph.com/docs/master/rados/
    39  [rados-config]: http://ceph.com/docs/master/rados/configuration/ceph-conf/
    40  [building]: https://github.com/docker/distribution/blob/master/docs/building.md#optional-build-tags