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

     1  <!--[metadata]>
     2  +++
     3  title = "Swift storage driver"
     4  description = "Explains how to use the OpenStack swift storage driver"
     5  keywords = ["registry, service, driver, images, storage,  swift"]
     6  +++
     7  <![end-metadata]-->
     8  
     9  
    10  # OpenStack Swift storage driver
    11  
    12  An implementation of the `storagedriver.StorageDriver` interface that uses [OpenStack Swift](http://docs.openstack.org/developer/swift/) for object storage.
    13  
    14  ## Parameters
    15  
    16  <table>
    17  <tr>
    18    <td>
    19    <code>authurl</code>
    20    </td>
    21    <td>
    22      <p>URL for obtaining an auth token.</p>
    23    </td>
    24  </tr>
    25  <tr>
    26    <td>
    27    <code>username</code>
    28    </td>
    29    <td>
    30    <p>
    31    Your OpenStack user name.</p>
    32    </p>
    33    </td>
    34  </tr>
    35  <tr>
    36    <td>
    37    <code>password</code>
    38    <p>
    39    </td>
    40    <td>
    41    <p>
    42    Your OpenStack password.
    43    </p>
    44    </td>
    45  </tr>
    46  <tr>
    47    <td>
    48    <code>container</code>
    49    </td>
    50    <td>
    51    <p>
    52  	The name of your Swift container where you wish to store the registry's data. The driver creates the named container during its initialization.
    53    </p>
    54    </td>
    55  </tr>
    56  <tr>
    57    <td>
    58    <code>tenant</code>
    59    </td>
    60    <td>
    61    <p>
    62    Optionally, your OpenStack tenant name. You can either use <code>tenant</code> or <code>tenantid</code>.
    63    </p>
    64    </td>
    65  </tr>
    66  <tr>
    67      <td>
    68      <code>tenantid</code>
    69      </td>
    70      <td>
    71      <p>
    72      Optionally, your OpenStack tenant id. You can either use <code>tenant</code> or <code>tenantid</code>.
    73      </p>
    74      </td>
    75  </tr>
    76  <tr>
    77      <td>
    78      <code>domain</code>
    79      </td>
    80      <td>
    81      <p>
    82      Optionally, your OpenStack domain name for Identity v3 API. You can either use <code>domain</code> or <code>domainid</code>.
    83      </p>
    84      </td>
    85  </tr>
    86  <tr>
    87      <td>
    88      <code>domainid</code>
    89      </td>
    90      <td>
    91      <p>
    92      Optionally, your OpenStack domain id for Identity v3 API. You can either use <code>domain</code> or <code>domainid</code>.
    93      </p>
    94      </td>
    95  </tr>
    96  <tr>
    97      <td>
    98      <code>trustid</code>
    99      </td>
   100      <td>
   101      <p>
   102      Optionally, your OpenStack trust id for Identity v3 API.
   103      </p>
   104      </td>
   105  </tr>
   106  <tr>
   107      <td>
   108      <code>insecureskipverify</code>
   109      </td>
   110      <td>
   111      <p>
   112      Optionally, set <code>insecureskipverify</code> to true to skip TLS verification for your OpenStack provider. The driver uses false by default.
   113      </p>
   114      </td>
   115  </tr>
   116  <tr>
   117      <td>
   118      <code>region</code>
   119      </td>
   120      <td>
   121      <p>
   122      Optionally, specify the OpenStack region name in which you would like to store objects (for example <code>fr</code>).
   123      </p>
   124      </td>
   125  </tr>
   126  <tr>
   127      <td>
   128      <code>chunksize</code>
   129      </td>
   130      <td>
   131      <p>
   132      Optionally, specify the segment size for Dynamic Large Objects uploads (performed by WriteStream) to Swift. The default is 5 MB. You might experience better performance for larger chunk sizes depending on the speed of your connection to Swift.
   133      </p>
   134      </td>
   135  </tr>
   136  <tr>
   137      <td>
   138      <code>prefix</code>
   139      </td>
   140      <td>
   141      <p>
   142      Optionally, supply a prefix that will be applied to all Swift keys to allow you to segment data in your container if necessary. Defaults to the empty string which is the container's root.</p>
   143      </p>
   144      </td>
   145  </tr>
   146  <tr>
   147      <td>
   148      <code>secretkey</code>
   149      </td>
   150      <td>
   151      <p>
   152      Optionally, the secret key used to generate temporary URLs.</p>
   153      </p>
   154      </td>
   155  </tr>
   156  <tr>
   157      <td>
   158      <code>accesskey</code>
   159      </td>
   160      <td>
   161      <p>
   162      Optionally, the access key to generate temporary URLs. It is used by HP Cloud Object Storage in addition to the `secretkey` parameter.</p>
   163      </p>
   164      </td>
   165  </tr>
   166  </table>
   167  
   168  The features supported by the Swift server are queried by requesting the `/info` URL on the server. In case the administrator
   169  disabled that feature, the configuration file can specify the following optional parameters :
   170  
   171  <table>
   172  <tr>
   173      <td>
   174      <code>tempurlcontainerkey</code>
   175      </td>
   176      <td>
   177      <p>
   178      Specify whether to use container secret key to generate temporary URL when set to true, or the account secret key otherwise.</p>
   179      </p>
   180      </td>
   181  </tr>
   182  <tr>
   183      <td>
   184      <code>tempurlmethods</code>
   185      </td>
   186      <td>
   187      <p>
   188      Array of HTTP methods that are supported by the TempURL middleware of the Swift server. Example:</p>
   189      <code>
   190      - tempurlmethods:
   191        - GET
   192        - PUT
   193        - HEAD
   194        - POST
   195        - DELETE
   196      </code>
   197      </p>
   198      </td>
   199  </tr>
   200  </table>