github.com/npaton/distribution@v2.3.1-rc.0+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  
    18  <table>
    19    <tr>
    20      <th>Parameter</th>
    21      <th>Required</th>
    22      <th>Description</th>
    23    </tr>
    24    <tr>
    25      <td>
    26        <code>poolname</code>
    27      </td>
    28      <td>
    29        yes
    30      </td>
    31      <td>
    32        Ceph pool name.
    33      </td>
    34    </tr>
    35     <tr>
    36      <td>
    37        <code>username</code>
    38      </td>
    39      <td>
    40        no
    41      </td>
    42      <td>
    43        Ceph cluster user to connect as (i.e. admin, not client.admin).
    44      </td>
    45    </tr>
    46     <tr>
    47      <td>
    48        <code>chunksize</code>
    49      </td>
    50      <td>
    51        no
    52      </td>
    53      <td>
    54        Size of the written RADOS objects. Default value is 4MB (4194304).
    55      </td>
    56    </tr>
    57  </table>
    58  
    59  
    60  The following parameters must be used to configure the storage driver
    61  (case-sensitive):
    62  
    63  * `poolname`: Name of the Ceph pool
    64  * `username` *optional*: The user to connect as (i.e. admin, not client.admin)
    65  * `chunksize` *optional*: Size of the written RADOS objects. Default value is
    66  4MB (4194304).
    67  
    68  This drivers loads the [Ceph client configuration][rados-config] from the
    69  following regular paths (the first found is used):
    70  
    71  * `$CEPH_CONF` (environment variable)
    72  * `/etc/ceph/ceph.conf`
    73  * `~/.ceph/config`
    74  * `ceph.conf` (in the current working directory)
    75  
    76  ## Developing
    77  
    78  To include this driver when building Docker Distribution, use the build tag
    79  `include_rados`. Please see the [building documentation][building] for details.
    80  
    81  [rados]: http://ceph.com/docs/master/rados/
    82  [rados-config]: http://ceph.com/docs/master/rados/configuration/ceph-conf/
    83  [building]: https://github.com/docker/distribution/blob/master/docs/building.md#optional-build-tags