Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
s3compatibleapi [2018_01_30 21:43] – steven | s3compatibleapi [2018_08_24 23:26] – steven | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | # Amazon S3 compatible API |
- | We provide support for another API that is becoming ubiquitous. In this case it is the Amazon S3 API. This is already used in solutions such as Eucalyptus Walrus, and we have now also added it as entry point for **any files** accessed through a SMEStorage Account. This means you can use the S3 compatible API to access | + | We provide support for the Amazon S3 API. This means you can use the S3 compatible |
- | For those interested, moving from a file based structure to a flat file object structure was achieved using the [[http:// | + | The S3 API is available on our SaaS services and on the appliance. |
- | Below is a practical implementation of using the S3 API. | + | It can be used by may tools including: |
- | ===== 1 Setting up an S3 Tool to work with SMEStorage ===== | + | * [[https:// |
+ | * [[https:// | ||
+ | * [[standalone/ | ||
+ | * CloudBerry | ||
+ | * Cyberduck | ||
+ | ## Authentication | ||
+ | To use the S3 API you will need an: | ||
- | {{:/ | + | 1. Endpoint |
+ | 1. Access Key ID | ||
+ | 1. Secret Access Key | ||
- | Lets look at a practical implementation of the S3 API using a tool that supports S3 compatible endpoints, CloudBerry explorer. We'll use this to access our Google Docs / Drive, although we could have chosen DropBox, or any other number of clouds to access. | + | ### 1. Endpoint |
+ | For our SaaS services use one of the following S3 API endpoints: | ||
- | ===== 2 Creating a New Account ===== | + | * http:// |
+ | * https:// | ||
+ | * http:// | ||
+ | * https:// | ||
- | {{:/ | + | Naturally http endpoints are not secure and should not be used for production data. |
- | Choose to add an account and fill in the endpoint as either: | + | For appliances contact your administrator for the "Cloud S3 Domain Name". |
- | **//s3.storagemadeeasy.com// | + | ### 2. Access Key ID |
- | and the QueryID should be set as the SME username. | + | The Access Key ID is your SME or File Fabric |
+ | ### 3. Secret Access Key | ||
- | ===== 3 Confirm Connection ===== | + | 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**. |
- | {{:/ | + | ## Usefulness |
- | + | ||
- | Now you can choose to access the service using the CloudBerry explorer: | + | |
- | + | ||
- | ===== 4 Accessing Service ===== | + | |
- | + | ||
- | {{:/ | + | |
- | + | ||
- | You can can now browse, download, upload files directly from your SME Clouds which is happening over the S3 API. | + | |
- | + | ||
- | ===== 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: | The S3 API can be useful in a number of scenarios. For example: | ||
Line 54: | Line 49: | ||
* Using S3 Tools and scripts to work with Clouds other than S3 | * Using S3 Tools and scripts to work with Clouds other than S3 | ||
- | ===== 7 Useful Apps ===== | + | ## Restrictions |
- | {{:/ | + | SME S3 API does not support multi-part upload. |
- | Useful Apps for interacting with SME over the Amazon | + | Certain |
- | * [[http:// | + | |
+ | 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:// | ||
- | ===== 8 Note! ===== | + | ## Implementation |
- | {{:/ | + | SME supports the following Amazon |
- | + | ||
- | 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:// | + | |
- | SME supports the following Amazon S3 API Requests:\\ \\ | + | * **[[http:// |
- | **PUT request** to create a bucket http:// | + | * **[[http:// |
+ | * **[[http:// | ||
+ | | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||