From 3d2d63f71e04404be70fda9653394915f4e7458a Mon Sep 17 00:00:00 2001 From: Harshavardhana Date: Mon, 16 Oct 2017 19:42:44 -0700 Subject: [PATCH] Fix gateway docs remove redundant files (#5072) --- docs/gateway/azure-limitations.md | 17 ----------------- docs/gateway/azure.md | 11 ++++++++++- docs/gateway/b2.md | 17 ++++++++++------- docs/gateway/gcs-limitations.md | 9 --------- docs/gateway/gcs.md | 11 ++++++++++- 5 files changed, 30 insertions(+), 35 deletions(-) delete mode 100644 docs/gateway/azure-limitations.md delete mode 100644 docs/gateway/gcs-limitations.md diff --git a/docs/gateway/azure-limitations.md b/docs/gateway/azure-limitations.md deleted file mode 100644 index fb1d15629..000000000 --- a/docs/gateway/azure-limitations.md +++ /dev/null @@ -1,17 +0,0 @@ -## Minio Azure Gateway Limitations - -Gateway inherits the following Azure limitations: - -- No support for prefix based bucket policies. Only top level bucket policy is supported. -- Gateway restart implies all the ongoing multipart uploads must be restarted. - i.e clients must again start with NewMultipartUpload - This is because S3 clients send metadata in NewMultipartUpload but Azure expects metadata to - be set during CompleteMultipartUpload (PutBlockList in Azure terminology). We store the metadata - sent by the client during NewMultipartUpload in memory so that it can be set on Azure later during - CompleteMultipartUpload. When the gateway is restarted this information is lost. -- Bucket names with "." in the bucket name is not supported. -- Non-empty buckets get removed on a DeleteBucket() call. - -Other limitations: -- Current implementation of ListMultipartUploads is incomplete. Right now it returns if the object with name "prefix" has any uploaded parts. -- Bucket notification not supported. diff --git a/docs/gateway/azure.md b/docs/gateway/azure.md index 4df19e0fc..e5124eb77 100644 --- a/docs/gateway/azure.md +++ b/docs/gateway/azure.md @@ -37,7 +37,16 @@ mc ls myazure ``` ### Known limitations -[Limitations](https://github.com/minio/minio/blob/master/docs/gateway/azure-limitations.md) +Gateway inherits the following Azure limitations: + +- Only read-only bucket policy supported at bucket level, all other variations will return API Notimplemented error. +- Bucket names with "." in the bucket name are not supported. +- Non-empty buckets get removed on a DeleteBucket() call. +- _List Multipart Uploads_ and _List Object parts_ always returns empty list. i.e Client will need to remember all the parts that it has uploaded and use it for _Complete Multipart Upload_ + +Other limitations: + +- Bucket notification APIs are not supported. ## Explore Further - [`mc` command-line interface](https://docs.minio.io/docs/minio-client-quickstart-guide) diff --git a/docs/gateway/b2.md b/docs/gateway/b2.md index 932d2ebe1..366395c2e 100644 --- a/docs/gateway/b2.md +++ b/docs/gateway/b2.md @@ -4,14 +4,14 @@ Minio Gateway adds Amazon S3 compatibility to Backblaze B2 Cloud Storage. ## Run Minio Gateway for Backblaze B2 Cloud Storage Please follow this [guide](https://www.backblaze.com/b2/docs/quick_account.html) to create an account on backblaze.com to obtain your access credentisals for B2 Cloud storage. -### Using Binary -Please download the test binary for gateway B2 support https://data.minio.io:10000/minio-b2/linux-amd64/minio-b2 - +### Using Docker ``` -export MINIO_ACCESS_KEY=b2_accound_id -export MINIO_SECRET_KEY=b2_application_key -minio gateway b2 +docker run -p 9000:9000 --name azure-s3 \ + -e "MINIO_ACCESS_KEY=b2_accound_id" \ + -e "MINIO_SECRET_KEY=b2_application_key" \ + minio/minio:edge gateway b2 ``` + ## Test using Minio Browser Minio Gateway comes with an embedded web based object browser. Point your web browser to http://127.0.0.1:9000 ensure your server has started successfully. @@ -35,12 +35,15 @@ mc ls myb2 ### Known limitations Gateway inherits the following B2 limitations: + - No support for CopyObject S3 API (There are no equivalent APIs available on Backblaze B2). - No support for CopyObjectPart S3 API (There are no equivalent APIs available on Backblaze B2). - Only read-only bucket policy supported at bucket level, all other variations will return API Notimplemented error. +- DeleteObject() might not delete the object right away on Backblaze B2, so you might see the object immediately after a Delete request. Other limitations: -- Bucket notification APIs are not supported on Gateway. + +- Bucket notification APIs are not supported. ## Explore Further - [`mc` command-line interface](https://docs.minio.io/docs/minio-client-quickstart-guide) diff --git a/docs/gateway/gcs-limitations.md b/docs/gateway/gcs-limitations.md deleted file mode 100644 index 3d362b8ee..000000000 --- a/docs/gateway/gcs-limitations.md +++ /dev/null @@ -1,9 +0,0 @@ -## Minio GCS Gateway Limitations - -Gateway inherits the following GCS limitations: - -- Maximum number of parts per upload is 1024. -- No support for bucket policies yet. -- No support for bucket notifications yet. -- _List Multipart Uploads_ and _List Object parts_ always returns empty list. i.e Client will need to remember all the parts that it has uploaded and use it for _Complete Multipart Upload_ - diff --git a/docs/gateway/gcs.md b/docs/gateway/gcs.md index e1b92c59e..cbb825b21 100644 --- a/docs/gateway/gcs.md +++ b/docs/gateway/gcs.md @@ -53,7 +53,16 @@ mc ls mygcs ``` ### Known limitations -[Limitations](https://github.com/minio/minio/blob/master/docs/gateway/gcs-limitations.md) + +Gateway inherits the following GCS limitations: + +- Maximum number of multipart parts per upload is 1024. +- Only read-only or write-only bucket policy supported at bucket level, all other variations will return API Notimplemented error. +- _List Multipart Uploads_ and _List Object parts_ always returns empty list. i.e Client will need to remember all the parts that it has uploaded and use it for _Complete Multipart Upload_ + +Other limitations: + +- Bucket notification APIs are not supported. ## Explore Further - [`mc` command-line interface](https://docs.minio.io/docs/minio-client-quickstart-guide)