Skip to content

Commit 22da757

Browse files
usha-mandyausha-mandya
authored
Update tables from html to markdown format (docker#10360)
1 parent a68383b commit 22da757

File tree

5 files changed

+61
-577
lines changed

5 files changed

+61
-577
lines changed

‎registry/storage-drivers/gcs.md‎

Lines changed: 7 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -8,68 +8,12 @@ An implementation of the `storagedriver.StorageDriver` interface which uses Goog
88

99
## Parameters
1010

11+
| Parameter | Required | Description |
12+
|:--------------|:---------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
13+
| `bucket` | yes | The name of your Google Cloud Storage bucket where you wish to store objects (needs to already be created prior to driver initialization). |
14+
| `keyfile` | no | A private service account key file in JSON format used for [Service Account Authentication](https://cloud.google.com/storage/docs/authentication#service_accounts). |
15+
| `rootdirectory` | no | The root directory tree in which all registry files are stored. Defaults to the empty string (bucket root). If a prefix is used, the path `bucketname/<prefix>` has to be pre-created before starting the registry. The prefix is applied to all Google Cloud Storage keys to allow you to segment data in your bucket if necessary.|
16+
| `chunksize` | no (default 5242880) | This is the chunk size used for uploading large blobs, must be a multiple of 256*1024. |
1117

12-
<table>
13-
<thead>
14-
<tr>
15-
<th>Parameter</th>
16-
<th>Required</th>
17-
<th>Description</th>
18-
</tr>
19-
</thead>
20-
<tbody>
21-
<tr>
22-
<td>
23-
<code>bucket</code>
24-
</td>
25-
<td>
26-
yes
27-
</td>
28-
<td>
29-
Storage bucket name.
30-
</td>
31-
</tr>
32-
<tr>
33-
<td>
34-
<code>keyfile</code>
35-
</td>
36-
<td>
37-
no
38-
</td>
39-
<td>
40-
A private service account key file in JSON format. Instead of a key file <a href="https://developers.google.com/identity/protocols/application-default-credentials">Google Application Default Credentials</a> can be used.
41-
</td>
42-
</tr>
43-
<tr>
44-
<td>
45-
<code>rootdirectory</code>
46-
</td>
47-
<td>
48-
no
49-
</td>
50-
<td>
51-
This is a prefix that is applied to all Google Cloud Storage keys to allow you to segment data in your bucket if necessary.
52-
</td>
53-
</tr>
54-
<tr>
55-
<td>
56-
<code>chunksize</code>
57-
</td>
58-
<td>
59-
no (default 5242880)
60-
</td>
61-
<td>
62-
This is the chunk size used for uploading large blobs, must be a multiple of 256*1024.
63-
</td>
64-
</tr>
65-
</tbody>
66-
</table>
18+
**Note:** Instead of a key file you can use [Google Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials).
6719

68-
69-
`bucket`: The name of your Google Cloud Storage bucket where you wish to store objects (needs to already be created prior to driver initialization).
70-
71-
`keyfile`: (optional) A private key file in JSON format, used for [Service Account Authentication](https://cloud.google.com/storage/docs/authentication#service_accounts).
72-
73-
**Note** Instead of a key file you can use [Google Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials).
74-
75-
`rootdirectory`: (optional) The root directory tree in which all registry files are stored. Defaults to the empty string (bucket root). If a prefix is used, the path `bucketname/<prefix>` has to be pre-created before starting the registry.

‎registry/storage-drivers/inmemory.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ volatile memory, use the [`filesystem` driver](filesystem.md) on a ramdisk.
1313

1414
## Parameters
1515

16-
None
16+
None

‎registry/storage-drivers/oss.md‎

Lines changed: 12 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -9,118 +9,15 @@ An implementation of the `storagedriver.StorageDriver` interface which uses
99

1010
## Parameters
1111

12-
<table>
13-
<thead>
14-
<tr>
15-
<th>Parameter</th>
16-
<th>Required</th>
17-
<th>Description</th>
18-
</tr>
19-
</thead>
20-
<tbody>
21-
<tr>
22-
<td>
23-
<code>accesskeyid</code>
24-
</td>
25-
<td>
26-
yes
27-
</td>
28-
<td>
29-
Your access key ID.
30-
</td>
31-
</tr>
32-
<tr>
33-
<td>
34-
<code>accesskeysecret</code>
35-
</td>
36-
<td>
37-
yes
38-
</td>
39-
<td>
40-
Your access key secret.
41-
</td>
42-
</tr>
43-
<tr>
44-
<td>
45-
<code>region</code>
46-
</td>
47-
<td>
48-
yes
49-
</td>
50-
<td> The name of the OSS region in which you would like to store objects (for example <code>oss-cn-beijing</code>). For a list of regions, you can look at <a href="https://www.alibabacloud.com/help/doc-detail/31837.htm">the official documentation</a>.
51-
</td>
52-
</tr>
53-
<tr>
54-
<td>
55-
<code>endpoint</code>
56-
</td>
57-
<td>
58-
no
59-
</td>
60-
<td>
61-
An endpoint which defaults to <code>[bucket].[region].aliyuncs.com</code> or <code>[bucket].[region]-internal.aliyuncs.com</code> (when <code>internal=true</code>). You can change the default endpoint by changing this value.
62-
</td>
63-
</tr>
64-
<tr>
65-
<td>
66-
<code>internal</code>
67-
</td>
68-
<td>
69-
no
70-
</td>
71-
<td> An internal endpoint or the public endpoint for OSS access. The default is false.
72-
For a list of regions, you can look at <a href="https://www.alibabacloud.com/help/doc-detail/31837.htm">the official documentation</a>.
73-
</td>
74-
</tr>
75-
<tr>
76-
<td>
77-
<code>bucket</code>
78-
</td>
79-
<td>
80-
yes
81-
</td>
82-
<td> The name of your OSS bucket where you wish to store objects (needs to already be created prior to driver initialization).
83-
</td>
84-
</tr>
85-
<tr>
86-
<td>
87-
<code>encrypt</code>
88-
</td>
89-
<td>
90-
no
91-
</td>
92-
<td> Specifies whether you would like your data encrypted on the server side. Defaults to false if not specified.
93-
</td>
94-
</tr>
95-
<tr>
96-
<td>
97-
<code>secure</code>
98-
</td>
99-
<td>
100-
no
101-
</td>
102-
<td> Specifies whether to transfer data to the bucket over ssl or not. If you omit this value, <code>true</code> is used.
103-
</td>
104-
</tr>
105-
<tr>
106-
<td>
107-
<code>chunksize</code>
108-
</td>
109-
<td>
110-
no
111-
</td>
112-
<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.
113-
</td>
114-
</tr>
115-
<tr>
116-
<td>
117-
<code>rootdirectory</code>
118-
</td>
119-
<td>
120-
no
121-
</td>
122-
<td> The root directory tree in which to store all registry files. Defaults to an empty string (bucket root).
123-
</td>
124-
</tr>
125-
</tbody>
126-
</table>
12+
| Parameter | Required | Description |
13+
|:--------------|:---------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
14+
| `accesskeyid` | yes | Your access key ID. |
15+
| `accesskeysecret` | yes | Your access key secret. |
16+
| `region` | yes | 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 the [official documentation](https://www.alibabacloud.com/help/doc-detail/31837.html). |
17+
| `endpoint` | no | 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. |
18+
| `internal` | no | An internal endpoint or the public endpoint for OSS access. The default is false. For a list of regions, you can look at the [official documentation](https://www.alibabacloud.com/help/doc-detail/31837.html). |
19+
| `bucket` | yes | The name of your OSS bucket where you wish to store objects (needs to already be created prior to driver initialization). |
20+
| `encrypt` | no | Specifies whether you would like your data encrypted on the server side. Defaults to false if not specified. |
21+
| `secure` | no | Specifies whether to transfer data to the bucket over ssl or not. If you omit this value, `true` is used. |
22+
| `chunksize` | no | 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. |
23+
| `rootdirectory` | no | The root directory tree in which to store all registry files. Defaults to an empty string (bucket root). |

0 commit comments

Comments
 (0)