mirror of
https://github.com/minio/minio.git
synced 2024-12-25 06:35:56 -05:00
Merge pull request #462 from harshavardhana/pr_out_remove_docs_minimal_docs_going_to_be_at_minio_io_instead_and_rest_amazon_docs
This commit is contained in:
Harshavardhana
commit
0128481f45
@ -2,10 +2,9 @@
|
||||
### Build Dependencies
|
||||
This installation document assumes Ubuntu 14.04 or later on x86-64 platform.
|
||||
|
||||
##### Install Git, GCC and MkDocs
|
||||
##### Install Git, GCC
|
||||
```sh
|
||||
$ sudo apt-get install git build-essential python-pip
|
||||
$ sudo pip install mkdocs
|
||||
$ sudo apt-get install git build-essential
|
||||
```
|
||||
|
||||
##### Install YASM
|
||||
@ -53,10 +52,9 @@ This installation document assumes Mac OSX Yosemite 10.10 or later on x86-64 pla
|
||||
$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
|
||||
```
|
||||
|
||||
##### Install Git, Python and MkDocs
|
||||
##### Install Git, Python
|
||||
```sh
|
||||
$ brew install git python
|
||||
$ pip install mkdocs
|
||||
```
|
||||
|
||||
##### Install YASM
|
||||
|
||||
@ -14,24 +14,21 @@ RUN apt-get update -y && apt-get install -y -q \
|
||||
git \
|
||||
build-essential \
|
||||
ca-certificates \
|
||||
yasm \
|
||||
python-pip
|
||||
yasm
|
||||
|
||||
RUN curl -O -s https://storage.googleapis.com/golang/${GOLANG_TARBALL} && \
|
||||
tar -xzf ${GOLANG_TARBALL} -C ${GOROOT%*go*} && \
|
||||
rm ${GOLANG_TARBALL} && \
|
||||
pip install mkdocs
|
||||
rm ${GOLANG_TARBALL}
|
||||
|
||||
ADD . ${GOPATH}/src/github.com/minio-io/minio
|
||||
|
||||
RUN cd ${GOPATH}/src/github.com/minio-io/minio && \
|
||||
make
|
||||
|
||||
RUN apt-get remove -y build-essential curl git python-pip && \
|
||||
RUN apt-get remove -y build-essential curl git && \
|
||||
apt-get -y autoremove && \
|
||||
rm -rf /var/lib/apt/lists/*
|
||||
|
||||
EXPOSE 9000 9001
|
||||
|
||||
CMD ["sh", "-c", "${GOPATH}/bin/minio"]
|
||||
|
||||
|
||||
3
Makefile
3
Makefile
@ -62,9 +62,6 @@ restore:
|
||||
env:
|
||||
@godep go env
|
||||
|
||||
docs-deploy:
|
||||
@mkdocs gh-deploy --clean
|
||||
|
||||
clean:
|
||||
@echo "Cleaning up all the generated files:"
|
||||
@rm -fv cover.out
|
||||
|
||||
3
NOTICE
3
NOTICE
@ -1,5 +1,4 @@
|
||||
Minimalist Object Storage
|
||||
Copyright 2014 Minio, Inc.
|
||||
Minimalist Object Storage, (C) 2014,2015 Minio, Inc.
|
||||
|
||||
This product includes software developed at Minio, Inc.
|
||||
(http://minio.io/).
|
||||
|
||||
@ -7,9 +7,6 @@ Minio's design is inspired by Amazon's S3 for its API and Facebook's Haystack fo
|
||||
* Community hangout on Gitter [](https://gitter.im/Minio-io/minio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
* Ask questions on Quora [](http://www.quora.com/Minio)
|
||||
|
||||
### Documentation
|
||||
* [Minio Reference](http://minio-io.github.io/minio/)
|
||||
|
||||
### Developers
|
||||
* [Get Source](./CONTRIBUTING.md)
|
||||
* [Build Dependencies](./BUILDDEPS.md)
|
||||
|
||||
@ -1 +0,0 @@
|
||||
### Overview
|
||||
@ -1 +0,0 @@
|
||||
../CONTRIBUTING.md
|
||||
@ -1,63 +0,0 @@
|
||||
### List of Error Responses
|
||||
|
||||
This section provides information about Minio API errors. XML and JSON results have been prettified for readability. As a result, the Content-Length may not match exactly for both styles
|
||||
|
||||
#### Error Codes Table
|
||||
|
||||
The following table lists Minio error codes.
|
||||
|
||||
| Error Code | Description | HTTP Status Code |
|
||||
|:---------- |:----------- |:----------------:|
|
||||
| AccessDenied | Access Denied | 403 Forbidden |
|
||||
| BadDigest | The Content-MD5 you specified did not match what we received. | 400 Bad Request |
|
||||
| BucketAlreadyExists | The requested bucket name is not available. | 409 Conflict |
|
||||
| EntityTooSmall | Your proposed upload is smaller than the minimum allowed object size. | 400 Bad Request |
|
||||
| EntityTooLarge | Your proposed upload exceeds the maximum allowed object size. | 400 Bad Request |
|
||||
| IncompleteBody | You did not provide the number of bytes specified by the Content-Length HTTP header | 400 Bad Request |
|
||||
| InternalError | We encountered an internal error. Please try again. | 500 Internal Server Error |
|
||||
| InvalidAccessKeyId | The access key Id you provided does not exist in our records. | 403 Forbidden |
|
||||
| InvalidBucketName | The specified bucket is not valid. | 400 Bad Request |
|
||||
| InvalidDigest | The Content-MD5 you specified is not valid. | 400 Bad Request |
|
||||
| InvalidRange | The requested range cannot be satisfied. | 416 Requested Range Not Satisfiable |
|
||||
| MalformedXML | The XML you provided was not well-formed or did not validate against our published schema. | 400 Bad Request |
|
||||
| MissingContentLength | You must provide the Content-Length HTTP header. | 411 Length Required |
|
||||
| MissingRequestBodyError | Request body is empty. | 400 Bad Request |
|
||||
| NoSuchBucket | The specified bucket does not exist. | 404 Not Found |
|
||||
| NoSuchKey | The specified key does not exist. | 404 Not Found |
|
||||
| NoSuchUpload | The specified multipart upload does not exist | 404 Not Found |
|
||||
| NotImplemented | A header you provided implies functionality that is not implemented. | 501 Not Implemented |
|
||||
| RequestTimeTooSkewed | The difference between the request time and the server's time is too large. | 403 Forbidden |
|
||||
| SignatureDoesNotMatch | The request signature we calculated does not match the signature you provided. | 403 Forbidden |
|
||||
| TooManyBuckets | You have attempted to create more buckets than allowed. | 400 Bad Request |
|
||||
| InvalidPolicyDocument | The content of the form does not meet the conditions specified in the policy document. | 400 Bad Request |
|
||||
| NoSuchBucketPolicy | The specified bucket does not have a bucket policy. | 404 Not Found |
|
||||
<br />
|
||||
|
||||
#### REST Error Responses
|
||||
|
||||
When there is an error, the header information contains:
|
||||
|
||||
- Content-Type: application/xml or application/json (Depending on ``Accept`` HTTP header)
|
||||
- An appropriate 4xx, or 5xx HTTP status code
|
||||
|
||||
The body or the response also contains information about the error. The following sample error response shows the structure of response elements common to all REST error responses.
|
||||
|
||||
```
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<Error>
|
||||
<Code>NoSuchKey</Code>
|
||||
<Message>The resource you requested does not exist</Message>
|
||||
<Resource>/minio-bucket/images.bz2</Resource>
|
||||
<RequestId>********</RequestId>
|
||||
</Error>
|
||||
```
|
||||
|
||||
The following table explains the REST error response elements
|
||||
|
||||
| Name | Description |
|
||||
|:---------- |:-----------|
|
||||
|*Code*| The error code is a string that uniquely identifies an error condition. <br />*Type: String*<br />*Ancestor: Error*|
|
||||
|*Error*| XML container for error. <br />*Type: Container*<br />*Ancestor: None*|
|
||||
|*Message*| The error message contains a generic description of the error condition. <br />*Type: String*<br />*Ancestor: Error*|
|
||||
|*RequestId*| ID of the request associated with the error. <br />*Type: String*<br />*Ancestor: Error*|
|
||||
|*Resource*| The bucket or object for which the error generated. <br />*Type: String*<br />*Ancestor: Error*|
|
||||
@ -1,11 +0,0 @@
|
||||
# Welcome to *MINIO*
|
||||
|
||||
Minio is an open source object storage released under [Apache license v2](http://www.apache.org/licenses/LICENSE-2.0).
|
||||
|
||||
It uses ``Rubberband Erasure`` coding to dynamically protect the data. This documents explains various API operations, related request and response structures, and error codes.
|
||||
|
||||
## Topics
|
||||
|
||||
- [Minio](./architecture.md)
|
||||
- [Minio API](./minio.md)
|
||||
- [Error Codes](./errors.md)
|
||||
@ -1,3 +0,0 @@
|
||||
### Minio API Reference
|
||||
|
||||
This API reference explains Minio operations, their parameters, responses, and errors. There are separate sections for each API, which include example requests and responses.
|
||||
@ -1,3 +0,0 @@
|
||||
### Management API
|
||||
|
||||
#### GET /
|
||||
214
docs/minio.md
214
docs/minio.md
@ -1,214 +0,0 @@
|
||||
### Minio API
|
||||
|
||||
#### General Overview
|
||||
|
||||
Minio stores and retrieves data in a logical format based upon REST based URLs.
|
||||
|
||||
**Note about examples:**
|
||||
|
||||
XML and JSON results have been prettified for readability. As a result, the Content-Length may not match exactly.
|
||||
```
|
||||
Form:
|
||||
http://minio.example.com/{bucket}/{path:.*}
|
||||
|
||||
Examples:
|
||||
http://minio.example.com/bucket/object
|
||||
http://minio.example.com/bucket/path/to/object
|
||||
http://minio.example.com/bucket2/path/to/object
|
||||
```
|
||||
|
||||
#### GET /
|
||||
|
||||
List buckets accessible by the user.
|
||||
|
||||
The default output is XML. JSON output may also be requested by adding the following header:
|
||||
|
||||
```
|
||||
Accept: "application/json"
|
||||
```
|
||||
|
||||
Example:
|
||||
```
|
||||
GET / HTTP/1.1
|
||||
```
|
||||
```
|
||||
HTTP/1.1 200 OK
|
||||
Connection: close
|
||||
Content-Type: application/xml
|
||||
Server: Minio
|
||||
Date: Mon, 02 Feb 2015 22:09:00 GMT
|
||||
Content-Length: 306
|
||||
|
||||
<ListAllMyBucketsResult>
|
||||
<Owner>
|
||||
<ID>minio</ID>
|
||||
<DisplayName>minio</DisplayName>
|
||||
</Owner>
|
||||
<Buckets>
|
||||
<Bucket>
|
||||
<Name>bucket</Name>
|
||||
<CreationDate>2015-01-30T15:20:09.013Z</CreationDate>
|
||||
</Bucket>
|
||||
<Bucket>
|
||||
<Name>minio</Name>
|
||||
<CreationDate>2015-01-27T17:46:28.264Z</CreationDate>
|
||||
</Bucket>
|
||||
</Buckets>
|
||||
</ListAllMyBucketsResult>
|
||||
```
|
||||
|
||||
```
|
||||
GET / HTTP/1.1
|
||||
Accept: application/json
|
||||
```
|
||||
|
||||
```
|
||||
HTTP/1.1 200 OK
|
||||
Connection: close
|
||||
Content-Type: application/json
|
||||
Server: Minio
|
||||
Date: Wed, 04 Feb 2015 21:59:10 GMT
|
||||
Content-Length: 223
|
||||
|
||||
{
|
||||
"Owner" : {
|
||||
"ID" : "minio"
|
||||
"DisplayName" : "minio",
|
||||
},
|
||||
"Buckets" : {
|
||||
"Bucket" : [
|
||||
{
|
||||
"Name" : "bucket",
|
||||
"CreationDate" : "2015-01-30T15:20:09.013Z"
|
||||
},
|
||||
{
|
||||
"Name" : "minio",
|
||||
"CreationDate" : "2015-02-02T14:52:34.914Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
NOTE: ``Accept: application/json`` is Minio Object Server specific
|
||||
|
||||
#### GET /{bucket}/
|
||||
|
||||
Lists objects in a bucket.
|
||||
|
||||
Example:
|
||||
```
|
||||
GET /minio/ HTTP/1.1
|
||||
```
|
||||
```
|
||||
HTTP/1.1 200 OK
|
||||
Connection: close
|
||||
Content-Type: application/xml
|
||||
Server: Minio
|
||||
Date: Tue, 03 Feb 2015 00:57:59 GMT
|
||||
Content-Length: 579
|
||||
|
||||
<ListBucketResult>
|
||||
<Name>minio</Name>
|
||||
<Marker/>
|
||||
<MaxKeys>1000</MaxKeys>
|
||||
<IsTruncated>false</IsTruncated>
|
||||
<Contents>
|
||||
<Key>hello</Key>
|
||||
<LastModified>2015-02-02T14:52:34.914Z</LastModified>
|
||||
<ETag>minio#hello</ETag>
|
||||
<Size>75</Size>
|
||||
<StorageClass>STANDARD</StorageClass>
|
||||
<Owner>
|
||||
<ID>minio</ID>
|
||||
<DisplayName>minio</DisplayName>
|
||||
</Owner>
|
||||
</Contents>
|
||||
<Contents>
|
||||
<Key>one</Key>
|
||||
<LastModified>2015-01-27T17:46:28.264Z</LastModified>
|
||||
<ETag>minio#one</ETag>
|
||||
<Size>4096</Size>
|
||||
<StorageClass>STANDARD</StorageClass>
|
||||
<Owner>
|
||||
<ID>minio</ID>
|
||||
<DisplayName>minio</DisplayName>
|
||||
</Owner>
|
||||
</Contents>
|
||||
</ListBucketResult>
|
||||
```
|
||||
|
||||
#### PUT /{bucket}/
|
||||
|
||||
Example:
|
||||
```
|
||||
PUT /books/ HTTP/1.1
|
||||
```
|
||||
```
|
||||
HTTP/1.1 200 OK
|
||||
Connection: close
|
||||
Server: Minio
|
||||
Date: Mon, 02 Feb 2015 22:05:43 GMT
|
||||
Content-Length: 0
|
||||
Content-Type: text/plain; charset=utf-8
|
||||
```
|
||||
|
||||
EXAMPLE
|
||||
#### GET /{bucket}/{object}
|
||||
|
||||
```
|
||||
GET /minio/hello HTTP/1.1
|
||||
```
|
||||
```
|
||||
HTTP/1.1 200 OK
|
||||
Connection: close
|
||||
Content-Length: 75
|
||||
Content-Type: text/plain
|
||||
Etag: minio#hello
|
||||
Last-Modified: Mon, 02 Feb 2015 14:52:34 PST
|
||||
Server: Minio
|
||||
Date: Mon, 02 Feb 2015 22:59:51 GMT
|
||||
|
||||
<?xml version="1.0"?>
|
||||
<html>
|
||||
<head/>
|
||||
<body>Hello World!</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
Retrieves an object from a bucket
|
||||
|
||||
#### HEAD /{bucket}/{object}
|
||||
```
|
||||
HEAD /minio/hello HTTP/1.1
|
||||
```
|
||||
```
|
||||
HTTP/1.1 200 OK
|
||||
Connection: close
|
||||
Content-Length: 75
|
||||
Content-Type: text/plain
|
||||
Etag: minio#hello
|
||||
Last-Modified: Mon, 02 Feb 2015 14:52:34 PST
|
||||
Server: Minio
|
||||
Date: Mon, 02 Feb 2015 23:02:30 GMT
|
||||
```
|
||||
|
||||
Retrieves meta-data about an object
|
||||
|
||||
#### PUT /{bucket}/{object}
|
||||
|
||||
Stores an object
|
||||
|
||||
```
|
||||
PUT /minio/hello HTTP/1.1
|
||||
Content-Length: 75
|
||||
|
||||
<?xml version="1.0"?>
|
||||
<html>
|
||||
<head/>
|
||||
<body>Hello World!</body>
|
||||
</html>
|
||||
```
|
||||
```
|
||||
HTTP/1.1 200 OK
|
||||
```
|
||||
12
mkdocs.yml
12
mkdocs.yml
@ -1,12 +0,0 @@
|
||||
site_name: Minio Documentation
|
||||
copyright: Minio, Inc.
|
||||
include_search: true
|
||||
pages:
|
||||
- ['index.md', Welcome to Minio]
|
||||
- ['architecture.md', 'Minio', Architecture]
|
||||
- ['contributing.md', 'Minio', Contribute]
|
||||
- ['introduction.md', 'API', Reference]
|
||||
- ['minio.md', 'API', REST API]
|
||||
- ['errors.md', 'API', Error Responses]
|
||||
- ['manage.md', 'API', Management API]
|
||||
theme: readthedocs
|
||||
@ -1,3 +0,0 @@
|
||||
package main
|
||||
|
||||
//go:generate mkdocs build --clean
|
||||
Loading…
Reference in New Issue
Block a user