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

update doc add endpoint

Browse source
This commit is contained in:
tgic 2015-07-24 10:20:50 +08:00
parent 8e5c901a26
commit 76174ad57e
1 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -10,20 +10,22 @@ An implementation of the `storagedriver.StorageDriver` interface which uses Aliy
## Parameters
`accesskeyid`: Your access key ID.
* `accesskeyid`: Your access key ID.
`accesskeysecret`: Your access key secret.
* `accesskeysecret`: Your access key secret.
`region`: 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 [http://docs.aliyun.com/?spm=5176.383663.9.2.0JzTP8#/oss/product-documentation/domain-region](http://docs.aliyun.com/?spm=5176.383663.9.2.0JzTP8#/oss/product-documentation/domain-region)
* `region`: 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 <http://docs.aliyun.com/#/oss/product-documentation/domain-region>
`internal`: (optional) Using internal endpoint or the public endpoint for OSS access. The default is false. For a list of regions, you can look at [http://docs.aliyun.com/?spm=5176.383663.9.2.0JzTP8#/oss/product-documentation/domain-region](http://docs.aliyun.com/?spm=5176.383663.9.2.0JzTP8#/oss/product-documentation/domain-region)
* `endpoint`: (optional) By default, the endpoint shoulb be `<bucket>.<region>.aliyuncs.com` or `<bucket>.<region>-internal.aliyuncs.com` (when internal=true). You can change the default endpoint via changing this value.
`bucket`: The name of your OSS bucket where you wish to store objects (needs to already be created prior to driver initialization).
* `internal`: (optional) Using internal endpoint or the public endpoint for OSS access. The default is false. For a list of regions, you can look at <http://docs.aliyun.com/#/oss/product-documentation/domain-region>
`encrypt`: (optional) Whether you would like your data encrypted on the server side (defaults to false if not specified).
* `bucket`: The name of your OSS bucket where you wish to store objects (needs to already be created prior to driver initialization).
`secure`: (optional) Whether you would like to transfer data to the bucket over ssl or not. Defaults to false if not specified.
* `encrypt`: (optional) Whether you would like your data encrypted on the server side (defaults to false if not specified).
`chunksize`: (optional) 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.
* `secure`: (optional) Whether you would like to transfer data to the bucket over ssl or not. Defaults to false if not specified.
`rootdirectory`: (optional) The root directory tree in which all registry files will be stored. Defaults to the empty string (bucket root).
* `chunksize`: (optional) 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.
* `rootdirectory`: (optional) The root directory tree in which all registry files will be stored. Defaults to the empty string (bucket root).