Getting Started

This document is a guide for getting started with using the evroc Object Storage service. In this guide you will create a Bucket, upload some data to it, download the data, and then clean up the data and the Bucket.

1. Prerequisites

This guide requires you to have the evroc CLI downloaded and for the CLI to be logged in to your evroc Organisation. For instructions on this please follow the instruction on the Getting Started page.

2. Create a Bucket

The first step to use the evroc Object Storage service is to create a Bucket, which is a named top-level container for storing your data. Each Bucket has a unique name inside its Resource Group which is used to identify it and its content. For this guide we will use the name my-bucket.

To create a Bucket use the storage bucket create command with the evroc CLI:

evroc storage bucket create my-bucket

If successful the evroc CLI will respond with a message that the creation of your Bucket has been requested. Your terminal output should look like this:

$ evroc storage bucket create my-bucket
my-bucket creation requested

In order to verify that the Bucket has been successfully created and is ready, use the storage bucket show command with the evroc CLI:

evroc storage bucket show my-bucket

The output in your terminal should look similar to this example:

$ evroc storage bucket show my-bucket
 Name        Age     Owners           Bucket URL       Ready   Reason   Errors 
----------- ------- ---------------- ---------------- ------- -------- --------
 my-bucket   0m30s   alice@acme.com   s3://my-bucket   True    Ready           

To show more information, re-run the command using the --verbose flag.

Note how the Ready column shows True for this Bucket. This means that the creation of the Bucket has been completed and that it is ready for use.

3. Upload a file to the Bucket

Next we will upload a file to the Bucket. For the guide we will create a small text file in the terminal named my-file.txt containing a small message:

echo "Hello, evroc Cloud" > my-file.txt

To upload a file from your local computer to the Bucket use the following storage bucket copy command with the evroc CLI:

evroc storage bucket copy --from my-file.txt --to s3://my-bucket/my-file.txt

This command takes two arguments to specify the upload: --from to specify which file to upload, and --to to specify the target. In this specific command the argument we specify are:

--from my-file.txt, referencing the local file my-file.txt that you recently created
--to s3://my-bucket/my-file.txt, referencing an Object called my-file.txt in the Bucket called my-bucket. The s3:// prefix in this argument specifies that this is a remote location, the lack of this prefix specifies a local location.

If successful your terminal output should look similar to this:

$ evroc storage bucket copy --from my-file.txt --to s3://my-bucket/my-file.txt
Successfully copied object my-file.txt to my-file.txt

4. List the Objects in the Bucket

In order to see what Objects are stored in a Bucket use the storage bucket list command with the evroc CLI:

evroc storage bucket list my-bucket

This command will list all the Objects stored inside the specified Bucket, in this case the Bucket my-bucket. Your terminal output should look similar to this:

$ evroc storage bucket list my-bucket
 Name          Size[bytes]   Last Modified          Storage Class 
------------- ------------- ---------------------- ---------------
 my-file.txt   19            2025-08-11T09:00:00Z   STANDARD

Here you can see the name of the Object, its size in bytes, and when it was last modified. In this case there is only a single Object in the Bucket, my-file.txt, which we uploaded in the previous step.

5. Download an Object

To download an Object stored in your Bucket you can again use the storage bucket copy command with the evroc CLI, but this time with the arguments switched:

evroc storage bucket copy --from s3://my-bucket/my-file.txt --to my-file-from-evroc-cloud.txt

This command is similar to the one we earlier used to upload the file, except that this time the --from argument refers to the remote location and the --to argument refers to a local location. If successful your terminal output should look similar to this:

$ evroc storage bucket copy --from s3://my-bucket/my-file.txt --to my-file-from-evroc-cloud.txt
Successfully copied object my-file-from-evroc-cloud.txt to my-file.txt

Once downloaded you can verify that the file you just downloaded contains the correct data, with e.g. cat:

$ cat my-file-from-evroc-cloud.txt
Hello, evroc Cloud

6. Delete an Object

To delete Objects whose data you no longer need to store you can use the storage bucket delete command with the evroc CLI:

evroc storage bucket delete s3://my-bucket/my-file.txt

Here we refer to a remote location with the s3:// prefix, which means that we are targeting an Object inside the Bucket. If successful your terminal output should look similar to this:

$ evroc storage bucket delete s3://my-bucket/my-file.txt
Deleted object "my-file.txt" from bucket "my-bucket"

7. Delete a Bucket

To delete a Bucket that you no longer need use the storage bucket delete command with the evroc CLI:

NOTE: This action requires the Bucket to be empty, which it should be if you have followed this guide correctly. For more information about this, see Bucket Deletion.

evroc storage bucket delete my-bucket

Note that this time there is no s3:// prefix, which means that we are targeting the Bucket itself instead of any Objects inside it.

$ evroc storage bucket delete my-bucket
my-bucket deletion requested

evroc User Documentation