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 [2023_06_22 05:41] – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | # Amazon S3 compatible API | ||
+ | The Enterprise File Fabric provides support for an Amazon S3 compatible API. This means the S3 compatible object storage API can be used to access files that have been mapped to the File Fabric, such as files available on Google Drive, RackSpace Cloud Files, or Microsoft OneDrive, or any of the many other clouds that the solution supports. | ||
+ | The S3 API is available on the SaaS hosted service and also on the enterprise on-premises edition of the product. | ||
+ | ## Client Configuration | ||
- | ====== Amazon | + | To use the S3 API the: |
+ | 1. Cloud S3 Endpoint | ||
+ | 2. Access Key ID | ||
+ | 3. Secret Access Key | ||
- | 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 your files on Google Docs, or Google Storage, or RackSpace Cloud Files, or Microsoft OneDrive, or any of the many other Clouds that we support.\\ \\ For those interested, moving from a file based structure to a flat file object structure was achieved using the [[http:// | + | are required. |
- | ===== 1 Setting up an S3 Tool to work with SMEStorage ===== | + | ### 1. Cloud S3 Endpoint |
+ | For the SaaS hosted service it is required to use one of the following S3 API endpoints: | ||
+ | * http:// | ||
+ | * https:// | ||
+ | * http:// | ||
+ | * https:// | ||
- | {{:/ | + | Naturally http endpoints are not secure and should not be used for production data. |
- | Lets look at a practical implementation | + | For the enterprise on-premises version |
+ | ### 2. Access Key ID | ||
- | ===== 2 Creating a New Account ===== | + | The Access Key ID is the 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**. | ||
- | {{:/ | + | ## Use With a Variety of S3 Clients |
- | Choose to add an account | + | The File Fabric' |
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | ## API Implementation | ||
- | ===== 3 Confirm Connection ===== | + | The File Fabric implements |
- | + | ||
- | + | ||
- | + | ||
- | {{:/ | + | |
- | + | ||
- | 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:\\ \\ - 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:// | + | |
- | + | ||
- | + | ||
- | ===== 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:// | + | |
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | * **[[http:// | ||
+ | ## S3 Signatures Supported | ||
+ | The S3 API supports V2 and V4 signatures. Which one is used is dependent on the client request. |