TrueCloudLab/distribution
13
0
Fork 3
Code Issues 3 Pull requests Projects Releases 2 Packages Wiki Activity Actions

Fix table formatting and endpoint template examples (#2726)

Browse source
This commit is contained in:
Jonathan Lee 2017-04-11 16:42:55 -04:00 committed by John Mulhausen
parent 5cf9203223
commit 39a8fcd85e
1 changed files with 112 additions and 108 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

170
docs/storage-drivers/oss.md
View file

@ -10,112 +10,116 @@ An implementation of the `storagedriver.StorageDriver` interface which uses
## Parameters ## Parameters
<table> <table>
<thead>
<tr> <tr>
<th>Parameter</th> <th>Parameter</th>
<th>Required</th> <th>Required</th>
<th>Description</th> <th>Description</th>
</tr> </tr>
<tr> </thead>
<tbody>
<tr>
<td> <td>
<code>accesskeyid</code> <code>accesskeyid</code>
</td> </td>
<td> <td>
yes yes
</td> </td>
<td> <td>
Your access key ID. Your access key ID.
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td>
<code>accesskeysecret</code> <code>accesskeysecret</code>
</td> </td>
<td> <td>
yes yes
</td> </td>
<td> <td>
Your access key secret. Your access key secret.
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td>
<code>region</code> <code>region</code>
</td> </td>
<td> <td>
yes yes
</td> </td>
<td> The name of the OSS region in which you would like to store objects (for example `oss-cn-beijing`). For a list of regions, you can look at [https://docs.aliyun.com/#/oss/product-documentation/domain-region](https://docs.aliyun.com/#/oss/product-documentation/domain-region). <td> The name of the OSS region in which you would like to store objects (for example `oss-cn-beijing`). For a list of regions, you can look at [https://docs.aliyun.com/#/oss/product-documentation/domain-region](https://docs.aliyun.com/#/oss/product-documentation/domain-region).
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td>
<code>endpoint</code> <code>endpoint</code>
</td> </td>
<td> <td>
no no
</td> </td>
<td> <td>
An endpoint which defaults to `<bucket>.<region>.aliyuncs.com` or `<bucket>.<region>-internal.aliyuncs.com` (when `internal=true`). You can change the default endpoint by changing this value. An endpoint which defaults to `[bucket].[region].aliyuncs.com` or `[bucket].[region]-internal.aliyuncs.com` (when `internal=true`). You can change the default endpoint by changing this value.
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td>
<code>internal</code> <code>internal</code>
</td> </td>
<td> <td>
no no
</td> </td>
<td> An internal endpoint or the public endpoint for OSS access. The default is false. For a list of regions, you can look at [https://docs.aliyun.com/#/oss/product-documentation/domain-region](https://docs.aliyun.com/#/oss/product-documentation/domain-region). <td> An internal endpoint or the public endpoint for OSS access. The default is false. For a list of regions, you can look at [https://docs.aliyun.com/#/oss/product-documentation/domain-region](https://docs.aliyun.com/#/oss/product-documentation/domain-region).
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td>
<code>bucket</code> <code>bucket</code>
</td> </td>
<td> <td>
yes yes
</td> </td>
<td> The name of your OSS bucket where you wish to store objects (needs to already be created prior to driver initialization). <td> The name of your OSS bucket where you wish to store objects (needs to already be created prior to driver initialization).
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td>
<code>encrypt</code> <code>encrypt</code>
</td> </td>
<td> <td>
no no
</td> </td>
<td> Specifies whether you would like your data encrypted on the server side. Defaults to false if not specified. <td> Specifies whether you would like your data encrypted on the server side. Defaults to false if not specified.
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td>
<code>secure</code> <code>secure</code>
</td> </td>
<td> <td>
no no
</td> </td>
<td> Specifies whether to transfer data to the bucket over ssl or not. If you omit this value, `true` is used. <td> Specifies whether to transfer data to the bucket over ssl or not. If you omit this value, `true` is used.
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td>
<code>chunksize</code> <code>chunksize</code>
</td> </td>
<td> <td>
no no
</td> </td>
<td> The default part size for multipart uploads (performed by WriteStream) to OSS. The default is 10 MB. Keep in mind that the minimum part size for OSS is 5MB. You might experience better performance for larger chunk sizes depending on the speed of your connection to OSS. <td> The default part size for multipart uploads (performed by WriteStream) to OSS. The default is 10 MB. Keep in mind that the minimum part size for OSS is 5MB. You might experience better performance for larger chunk sizes depending on the speed of your connection to OSS.
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td>
<code>rootdirectory</code> <code>rootdirectory</code>
</td> </td>
<td> <td>
no no
</td> </td>
<td> The root directory tree in which to store all registry files. Defaults to an empty string (bucket root). <td> The root directory tree in which to store all registry files. Defaults to an empty string (bucket root).
</td> </td>
</tr> </tr>
</tbody>
</table> </table>