S3 object storage

AWS S3 is an object storage service provided by Amazon that exposes a HTTP based API known as the S3 API. Binero cloud provides it’s own object storage service that supports this HTTP based S3 API.

You are able to consume our object storage by using the S3 API from any of our Storage regions and availability zones, either from one availability zone at a time or both using replication.

In S3 terminology a bucket holds objects and is the same as a container in Swift terminology.

Note

The complete list of S3 features is available here

Note

See known limitations for more information on compatibility and interoperability between the S3 and Swift APIs.

Setting up credentials

To access the S3 service you need to create a EC2 credential, this credential consists of an access key and a secret key for your API user and can impersonate that user by using the credential.

Important

Sharing the EC2 credential will allow that entity to impersonate your API user and gives access to the cloud platform and not only the S3 service.

You can only create an EC2 credential using the OpenStack Terminal Client by running the openstack ec2 credentials create command which creates a new EC2 credential for your API user.

You can list existing EC2 credentials for your API user by using openstack credential list --type ec2.

When you create a new EC2 credential save the access and secret key that is the credential itself.

You can read more about EC2 Credential in our Users documentation.

S3 client

S3 is an HTTP based API protocol, meaning to administer it you would use HTTP API requests.

To simplify the management of S3 in the cloud, we recommend installing the official client from AWS, its available here.

Once its installed, you should be able to run aws --version and get an output.

Configure your client with your credentials (see the section above) by creating the file (on a Linux or MacOS based computer) ~/.aws/credentials as such:

[default]
aws_access_key_id=[ACCESS_KEY]
aws_secret_access_key=[SECRET_KEY]

When you’ve completed the configuration, you are now able to test reaching the cloud by for example running this command: aws --endpoint=https://object-eu-se-1a.binero.cloud s3api list-buckets which will list the buckets in the account from the non replicated endpoint of availability zone europe-se-1a.

If you have no buckets setup, it will return an empty Buckets array.

Creating a bucket

To create a bucket via S3, you would either use the API (not covered in this documentation) or the S3 client. To use the latter to create a bucket:

  • Decide which storage policy you want to use. Save the name.

  • Decide if you need to use replication or not.

  • Decide in what availability zone to store your data, save the name.

  • Based on replication (or not) and availability zone, choose the right endpoint. Save the endpoint URL.

  • Based on replication (or not) the LocationConstraint will be either europe-se-1 or europe-se-1-rep, save the one that is right for your use-case.

  • Run this command:

    aws --endpoint=[ENDPOINT_URL] s3api create-bucket --bucket [BUCKET_NAME] --create-bucket-configuration LocationConstraint=[LOCAL_CONSTRAINT]:[STORAGE_POLICY_NAME]``

Replacing the items in angle brackets with the proper data from previous steps. The storage policy is optional and will use the default if not specified.

  • Verify by running this command: aws --endpoint=[ENDPOINT_URL] s3api list-buckets

You are now able to use your bucket to save data in using your credentials from your application.

Deleting a bucket

Delete a bucket by using the aws terminal client.

  • Run this command: aws --endpoint=[ENDPOINT_URL] s3api list-buckets, save the name of the bucket you want to delete.

  • Run this command: aws --endpoint=[ENDPOINT_URL] s3api delete-bucket --bucket [BUCKET_NAME], replace [BUCKET_NAME] with the name of the bucket.

Note

The delete will fail unless the bucket is empty.