Create S3 Server Allocation

Use Züs as an S3 server with no code change

This flow is triggered at your first login to Blimp, by choosing "S3 Server" or when you click the "Create New Allocation" button from the S3 allocation section of the Manage Allocations page.

To be able to follow along what we'll be doing in this flow, there should be an introduction of how S3-compatible allocations work on Züs. Here's a simple diagram of the whole flow.

You create a normal (Multi-cloud) allocation.
You'll need to deploy an instance of the Züs S3 server, which is responsible for providing an S3-compatible API for your allocation data. You'll need to configure this on Blimp while you're creating your allocation.

3-5. When you need to access your data, blimp simply sends your S3 request to your Züs S3 server, which will access your allocation using the normal Züs multi-cloud allocation API to get the data you want.

Now since we know how the flow works under the hood, let's create our first S3 allocation on Züs!

Pre-requisites: Get a cloud machine

As we saw in the flow diagram above, you need to deploy the ZS3 server, for which you need a machine with a public IP address which you'll be using while setting up your allocation. You can create a machine on any of the major cloud providers or setup your own on-premise machine with VPC. The specs of this machine varies according to your needs, but the minimum requirements are:

2 CPU cores
4GB RAM

Once you've created your machine and can ssh into it using its IP address, you're good to go.

Step 1-4: Create Multi-cloud allocation

This is exactly what we did in the previous page.

Step 5: Generate the Züs S3 Server Installation Script

Here you'll need to provide the IP address of your machine so blimp generates you the script you'll run to get ZS3 server up and running. Click "Generate Script" and you'll then be prompted to enter a Secret Key that will be used for Grafana, which is the monitoring tool for your ZS3 server.

Once you enter the Secret Key, click "Confirm" and you'll be shown the script and the instructions to run it on your machine.

Once you run the script on your machine and it passes successfully, Blimp will detect your server and move you to the next step. A successful run of the script should look like this:

Step6: Conduct S3 Operation

By this step, you've successfully deployed the ZS3 Server and created the S3-compatible allocation, good job! This screen is where you'll be interacting with your allocation. Using this page, you can:

Perform any S3-compatible operation.
View the results of your operation in the right panel.
View S3 Logs of your server from the button at the top-right corner.

Let's take a quick detour of the operations you can perform in this page:

Create a Bucket

To create a bucket, choose "Create Bucket" from the "Type of Request" list, then enter the name of the bucket and click "Run Curl Request".

Once your request gets a response, you can find this response on the right panel.

You can also use curl tool in your terminal to send this request by copying the command generated under the "Using CLI" section.

List all buckets

To list all buckets, select "Buckets" under the "List operations" list of the "Type of Request" menu, then click "Run Curl Request".

Once your request gets a response, you can find this response on the right panel. Your request contains the buckets you have in your allocation.

Put/Upload a file to a bucket

To Upload/Put an object, select "Put" under the "Object operations" list of the "Type of Request" menu, specify your bucket name and click or drag to upload the file, then click "Run Curl Request".

To encrypt you uploaded file, you should specify the special bucket named "Encrypted" which is auto-created for your allocation.

Once your request gets a response, you can find this response on the right panel.

Get all the object within a bucket

To list all object in a bucket, choose "Objects" from the "List operations" list under the "Type of Request" menu, then specify the name of the bucket and click "Run Curl Request".

Once your request gets a response, you can find this response on the right panel. The request contains all the files within this bucket.

Get/Download an object

To Get/Download an object, choose "Get" from the "Object operations" list undet the "Type of Request" menu, then specify the name of your bucket and object, and click "Run Curl Request".

Once the file is downloaded, you'll see the response as well as a window to save your file locally.

Remove an object

To remove an object, choose "Remove" from the "Object operations" list under the "Type of Request" menu, then specify the name of the bucket and the object and click "Run Curl Request"

Once your request gets a response, you can find this response on the right panel.

List all buckets with their objects

To list all the buckets associated with their objects, choose "Bucket Objects" from the "Bucket Operations" list under the "Type of Request" menu, then click "Run Curl Request"

Once your request gets a response, you can find this response on the right panel. The response contains your buckets and objects within them.