-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
new: usr: simplified information about API supported in README.md
new: usr: proposals updated with design issues involved. Signed-off-by: Richard Lea <chigix@zoho.com>
- Loading branch information
Showing
2 changed files
with
29 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,34 @@ | ||
Chizuru -- Amazon S3 compatible Object Storage Service Server component. | ||
================ | ||
|
||
# API Supported | ||
|
||
The design of Chizuru Server Component is based upon the Amazon S3 RESTful API, which is exactly much better and friendly for developers usage on Object Storage. | ||
|
||
* GET Service | ||
* DELETE Bucket | ||
* GET Bucket (List Objects) Version 2 | ||
* GET Bucket location | ||
* HEAD Bucket | ||
* List Multipart Uploads | ||
* PUT Bucket | ||
* Delete Multiple Objects (POST Bucket) | ||
* GET Object | ||
* PUT Object | ||
* Complete Multipart Upload | ||
* Initiate Multipart Upload | ||
* List Parts | ||
* Upload Part | ||
|
||
|
||
# Configuration | ||
|
||
Currently, supported Configuration options for Chizuru Server Component are: | ||
|
||
* `MAX_CHUNKSIZE` : The standard size set for chunk unit in physical storage on disk. Every chunk will not exeed configured size. | ||
* `TRANSFER_BUFFERSIZE` : The size configuration which would be used when IO buffer for transferring is to be allocated. | ||
|
||
# Including | ||
|
||
There are amazon signature testing materials included in the testing package, downloading from [Signature Version 4 Test Suite](https://docs.aws.amazon.com/ja_jp/general/latest/gr/signature-v4-test-suite.html). | ||
* There are amazon signature testing materials included in the testing package, downloading from [Signature Version 4 Test Suite](https://docs.aws.amazon.com/ja_jp/general/latest/gr/signature-v4-test-suite.html). | ||
* There is a list as a proposals related to the problems of design on this component, as a scatch version of best practice in the future. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,2 @@ | ||
* If no map db file support, directly use the list of files in this directory, surely the directory information would be impossible to be recorded for files. | ||
* Authentication request should be solved by PHP web service, rather than Netty IO service. | ||
* The real file name and virtual directory information should be stored in application layer, of course the Strategy of access control should also be implimented in application. |