This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

The Vault (Technical Preview)

Documentation of Elastx The Vault object storage

This service is offered as a Technical Preview.

1 - Overview

Elastx The Vault

Elastx The Vault is S3-compatible object storage for secondary storage: backups, archives and long-term retention.

Features

  • S3-compatible: Works with standard S3 tools and SDKs.
  • Isolated: Hosted in a dedicated, physically protected region of the Elastx Cloud Platform.
  • Encryption at rest: All data is encrypted.
  • Immutable storage: Object locking protects data from deletion and tampering, including ransomware.
  • Elastx IDP: Access is managed through Elastx IDP with MFA.

Endpoints

Service URL
S3 API https://vault.elastx.cloud
Console https://vault-console.elastx.cloud

Limits

Limits apply per source IP. Requests over a limit get HTTP 429; most S3 clients retry automatically with backoff.

Limit Value
Concurrent connections 65
Requests per second 100
Object retention changes per second 30
Max size of a single request 10 GiB

Objects larger than 10 GiB must use multipart upload. mc, aws and rclone do this automatically.

The Vault is built for large backup and archive objects, not for millions of small objects. For many small files, see Backup solutions.

Learn more

2 - Getting started

Getting started with Elastx The Vault

2.1 - Users and access keys

Roles, console login and access keys

Roles

An authorized manager assigns roles to users in the Elastx Cloud Console. Your organization needs at least one user with the admin role.

Role Use for
admin Managing buckets, objects and access keys
readonly Downloading objects
writeonly Uploading objects

See Roles and permissions for details.

Console

Log in to The Vault Console with your Elastx ID. Only users with the admin role have access.

Access keys

Applications and S3 clients authenticate with access keys.

  1. Log in to the console.
  2. Go to Access Keys → Create access key.
  3. Copy the access key and secret key. The secret key is shown only once.
  • A key has the same permissions as the admin who created it.
  • Keys belong to the admin who created them. Other admins in the same organization cannot see them.
  • To limit a key, enable Restrict beyond user policy and remove permissions from the JSON policy shown. A key can never get more access than its admin.

Example: a key that can only read one bucket. Replace the policy shown under Restrict beyond user policy with:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": ["s3:GetObject", "s3:ListBucket"],
      "Resource": [
        "arn:aws:s3:::<prefix>.<bucket-name>",
        "arn:aws:s3:::<prefix>.<bucket-name>/*"
      ]
    }
  ]
}

Policies use standard S3 action names. See supported S3 policy actions.

2.2 - Roles and permissions

What each role can do
Action admin readonly writeonly
Console login and access keys ✓
Create and delete buckets ✓
List buckets and objects ✓
Download objects ✓ ✓
Upload objects ✓ ✓
Delete objects and versions ✓
Object locking, retention and legal hold ✓
Bypass governance locks ✓
Versioning, tags and lifecycle rules ✓
Bucket policies and replication ✓
  • readonly downloads the current version of objects by exact name. It cannot list, so the object names must be known.
  • writeonly can overwrite existing objects. In a versioned bucket the previous version is kept.

2.3 - Connecting

Configure S3 clients for The Vault
Setting Value
Endpoint https://vault.elastx.cloud
Region us-east-1
Addressing style Path-style

MinIO Client (mc)

Install: MinIO Client

mc alias set thevault https://vault.elastx.cloud <access-key> <secret-key>
mc ls thevault

AWS CLI

Requires AWS CLI v2.13 or later.

~/.aws/config:

[profile thevault]
region = us-east-1
endpoint_url = https://vault.elastx.cloud
s3 =
  addressing_style = path

~/.aws/credentials:

[thevault]
aws_access_key_id = <access-key>
aws_secret_access_key = <secret-key>
aws --profile thevault s3 ls

rclone

~/.config/rclone/rclone.conf:

[thevault]
type = s3
provider = Minio
endpoint = https://vault.elastx.cloud
access_key_id = <access-key>
secret_access_key = <secret-key>
rclone lsd thevault:

2.4 - Buckets

Naming and creating buckets

Naming

Bucket names must start with your organization’s prefix followed by a dot:

<prefix>.<bucket-name>

Find your prefix in the Elastx Cloud Console. Names without the prefix are rejected.

Create a bucket

mc mb thevault/<prefix>.<bucket-name>

With object locking (immutability):

mc mb --with-lock thevault/<prefix>.<bucket-name>

Note: Object locking can only be enabled when the bucket is created. It also enables versioning, which cannot be turned off. See Object locking.

Upload and download

mc cp ./file.tar.gz thevault/<prefix>.<bucket-name>/
mc cp thevault/<prefix>.<bucket-name>/file.tar.gz ./
mc ls thevault/<prefix>.<bucket-name>

3 - Guides

Guides for Elastx The Vault

3.1 - Object locking

Protect objects from deletion and changes

Object locking requires a bucket created with --with-lock. See Buckets.

Modes

Mode Locked versions can be deleted before expiry
governance Only by users with the admin role, with an explicit bypass
compliance Never, by any user, including admins

Warning: A compliance lock cannot be removed or shortened by any user. Test with governance and short durations.

Default retention for a bucket

New objects are locked automatically:

mc retention set --default governance 30d thevault/<prefix>.<bucket-name>
mc retention info --default thevault/<prefix>.<bucket-name>

Lock a single object

mc retention set governance 30d thevault/<prefix>.<bucket-name>/<object>
mc retention info thevault/<prefix>.<bucket-name>/<object>

Locks an object until the hold is removed, regardless of retention. It also blocks deletion with bypass; clear the hold first.

mc legalhold set thevault/<prefix>.<bucket-name>/<object>
mc legalhold clear thevault/<prefix>.<bucket-name>/<object>

Delete a locked version (governance)

Requires the admin role. Find the version ID:

mc ls --versions thevault/<prefix>.<bucket-name>/<object>

Delete it with bypass:

mc rm --version-id <version-id> --bypass thevault/<prefix>.<bucket-name>/<object>

AWS CLI:

aws --profile thevault s3api delete-object \
  --bucket <prefix>.<bucket-name> --key <object> --version-id <version-id> \
  --bypass-governance-retention

Other clients: send the header x-amz-bypass-governance-retention: true.

Note: mc rm without --version-id or --versions does not delete locked data. It only adds a delete marker that hides the object.

4 - Knowledge base

Articles on specific issues/subjects

4.1 - FAQ

Frequently Asked Questions

I can’t get the “Object Locking” functionality to work. What is wrong?

Unfortunately there is a bug in the GUI and this functionality can only be accessed via the API.

5 - Backup solutions

How to integrate software to optimize backup and recovery

Introduction

This page describes solutions för running backups against The Vault object storage.

The goal is to create an efficient backup solution especially when you have many small files that you need to backup. This will reduce the number of objects stored and the number of requests needed against The Vault to a minimum.

Juicefs

This solution is a High-Performance, Cloud-Native, Distributed File System. In this case we will primarily use it to reduce the number of requests against The Vault. This is a good solution if you want to backup a large number of small files. Juicefs handles all metadata in a database so all requests during a sync are handled against the database instead of requests in The Vault.

Setup

Install the juicefs binary in a Linux instance.

curl -sSL https://d.juicefs.com/install | sh -

Install sqllite

apt-get install sqlite3

Setup the drive using The Vault and SQLite

juicefs format --storage minio --bucket https://vault.elastx.cloud/<bucket> --access-key <access> --secret-key <secret> "sqlite3://thevaultfs.db" thevaultfs

Mount drive

mkdir /thevaultfs
juicefs mount sqlite3://thevaultfs.db /thevaultfs -d

Now you can sync data using rclone or other tools and to compare content between the primary and The Vault through juicefs does not require any requests on The Vault.

Setup using Swift as storage

Setup the drive using swift s3 (ec2 credentials) and SQLite

juicefs format --storage swift --bucket https://<container>.swift.elastx.cloud --access-key <access> --secret-key <secret> sqlite3://swiftfs.db swiftfs

Mount drive

mkdir /swiftfs
juicefs mount sqlite3://swiftfs.db /swiftfs -d

Veeam

Install a Veeam backup server to take backups of object storage or other resources and store those backups in The Vault.

Create a Bucket in The Vualt with immutable support.

mc mb --with-lock thevault/<bucket-name>

Setup

This is an instruction on how to install the Veeam Software Appliance in Openstack IaaS. Download the VeeamSoftwareAppliance iso file from Veeam. Create an account if you don’t have one and start a trial if you want to test.

Create an openstack image from the iso file using the openstack cli.

openstack image create  --container-format bare --disk-format iso --property hw_firmware_type=uefi --file VeeamSoftwareAppliance_13.0.1.1071_20251217.iso VeeamSoftwareAppliance_13.0.1.1071_20251217-iso

Create a volume from the iso file and place the volume in the availability zone where you want to run the Veeam server.

openstack volume create --image VeeamSoftwareAppliance_13.0.1.1071_20251217-iso --availability-zone <az> --type v2-1k --size 15 veeam-iso

Create a boot volume, a data volume and then create an instance that attaches the boot volume, the data volume and the volume with the Veeam iso image. All must be located in the same availability zone. Both the boot and data volume needs to be at least 240 GB in size.

On the boot volume set the following property to make the instance use uefi.

openstack volume set --image-property hw_firmware_type=uefi <veeam-iso-volume-id>

Create the backup server instance.

openstack server create --flavor <flavor-id> --availability-zone <az> --volume <boot-volume-id> --block-device uuid=<data-volume-id>,source_type=volume,destination_type=volume --block-device uuid=<veeam-iso-volume-id>,source_type=volume,destination_type=volume,boot_index=1,device_type=cdrom,disk_bus=sata --nic net-id=<network-id> veeam-server

Follow the instructions and install the Veeam Server Appliance.