Differences
This shows you the differences between two versions of the page.
Next revision | Previous revisionNext revisionBoth sides next revision | ||
s3compatibleapi [2018_01_30 17:23] – external edit 127.0.0.1 | s3compatibleapi [2018_08_24 23:26] – steven | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | # Amazon S3 compatible API | ||
+ | We provide support for the Amazon S3 API. This means you can use the S3 compatible object storage API to access files on Google Docs, RackSpace Cloud Files, or Microsoft OneDrive, or any of the many other clouds that we support. | ||
+ | The S3 API is available on our SaaS services and on the appliance. | ||
+ | It can be used by may tools including: | ||
- | ====== Amazon | + | * [[https:// |
+ | * [[https:// | ||
+ | * [[standalone/ | ||
+ | * CloudBerry | ||
+ | * Cyberduck | ||
+ | ## Authentication | ||
- | We provide support for another API that is becoming ubiquitous. In this case it is the Amazon | + | To use the S3 API you will need an: |
- | ===== 1 Setting up an S3 Tool to work with SMEStorage ===== | + | 1. Endpoint |
+ | 1. Access Key ID | ||
+ | 1. Secret Access Key | ||
+ | ### 1. Endpoint | ||
+ | For our SaaS services use one of the following S3 API endpoints: | ||
- | {{:/s3compatibleapi:steps:sme_1_setting_up_an_s3_too.png}} | + | * http:// |
+ | * https:// | ||
+ | * http:// | ||
+ | * https:// | ||
- | Lets look at a practical implementation of the S3 API using a tool that supports S3 compatible | + | Naturally http endpoints |
+ | For appliances contact your administrator for the "Cloud S3 Domain Name". | ||
- | ===== 2 Creating a New Account ===== | + | ### 2. Access Key ID |
+ | The Access Key ID is your SME or File Fabric username. | ||
+ | ### 3. Secret Access Key | ||
- | {{:/ | + | You can obtain the API secret key by logging into the File Fabric going to **My Account** from the sidebar and copying the key from where it says **API secret key**. |
- | Choose to add an account and fill in the endpoint as either:\\ \\ â**// | + | ## Usefulness |
+ | The S3 API can be useful in a number of scenarios. For example: | ||
+ | * Building an S3 compatible Cloud but using one or more different Storage implementations to deliver it, using the SMEStorage Cloud Appliance. | ||
+ | * Transitioning from existing S3 use to a different Cloud but without having to change code ie. only changing the endpoint implementation | ||
+ | * Using S3 Tools and scripts to work with Clouds other than S3 | ||
- | ===== 3 Confirm Connection ===== | + | ## Restrictions |
+ | SME S3 API does not support multi-part upload. | ||
+ | Certain S3 client tools may need you to change a setting to turn off multi-part upload. | ||
- | {{:/s3compatibleapi: | + | For example you need to do this with Cyberduck.Multipart uploads can be disabled by setting the hidden option s3.upload.multipart to false.. See https:// |
- | Now you can choose to access the service using the CloudBerry explorer: | + | ## Implementation |
+ | SME supports the following Amazon S3 API Requests: | ||
- | ===== 4 Accessing Service ===== | + | * **[[http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html|PUT request]]** to create a bucket |
- | + | * **[[http:// | |
- | + | * **[[http:// | |
- | + | * **[[http:// | |
- | {{:/ | + | * **[[http:// |
- | + | * **[[http:// | |
- | You can can now browse, download, upload files directly from your SME Clouds which is happening over the S3 API. | + | * **[[http:// |
- | + | * **[[http:// | |
- | + | * **[[http:// | |
- | ===== 5 Working with Clouds ===== | + | |
- | + | ||
- | + | ||
- | + | ||
- | {{:/ | + | |
- | + | ||
- | This screenshot shows the root view of the Google Docs folder being access via CloudBerry using the S3 compatible API. Accessing different Clouds is just as easy as changing directories for Clouds that are mapped to an account. | + | |
- | + | ||
- | + | ||
- | ===== 6 Usefulness ===== | + | |
- | + | ||
- | + | ||
- | + | ||
- | {{:/ | + | |
- | + | ||
- | The S3 API can be useful in a number of scenarios. For example:\\ \\ - Building an S3 compatible Cloud but using one or more different Storage implementations to deliver it, using the SMEStorage Cloud Appliance.\\ \\ - Transitioning from existing S3 use to a different Cloud but without having to change code ie. only changing the endpoint implementation\\ \\ - Using S3 Tools and scripts to work with Clouds other than S3 | + | |
- | + | ||
- | + | ||
- | ===== 7 Useful Apps ===== | + | |
- | + | ||
- | + | ||
- | + | ||
- | {{:/ | + | |
- | + | ||
- | Useful Apps for interacting with SME over the Amazon S3 API are:\\ \\ [[http://www.cloudberrylab.com/free-amazon-s3-explorer-cloudfront-IAM.aspx|CloudBerry]] (Windows)\\ [[http://cyberduck.ch|Cyberduck]] (Windows | + | |
- | + | ||
- | + | ||
- | ===== 8 Note! ===== | + | |
- | + | ||
- | + | ||
- | + | ||
- | {{:/ | + | |
- | + | ||
- | SME S3 API does not support multi-part upload (as it makes no sense as we interacting with back end clouds that do not support it). \\ \\ Certain S3 client tools may need you to change a setting to turn off multi-part upload. \\ \\ For example you need to do this with Cyberduck.Multipart uploads can be disabled by setting the hidden option s3.upload.multipart to false.. See https:// | + | |