Link Search Menu Expand Document

Manage Vaults

Table of Contents

You can manage your Elastio vaults using the Elastio CLI in the following ways:

Create a vault

Use the following command to create (or initialize) a new vault:

elastio vault deploy <vault-name>

Note: For the time being, please limit the amount of vault to maximum 5 per region.

There is a flag you can use to make sure that S3 objects of a vault are additionally protected from being deleted: ‘–lock-s3-objects’. An example of it’s use and sample output can be seen below:

ThinkPad-T15-Gen-1:~$ elastio vault deploy test1 --lock-s3-objects

dynamodb_table_name = "elastio-vault-test1-catalog"
key_id = "fc1f0000-0000-0000-0000-1d726f000000"
s3_bucket_name = "elastio-vault-test1-000000000"
s3_object_lock_enabled = true
stack_version = "0.20.27"
Key: fc1f0000-0000-0000-0000-1d726f000000
Bucket: elastio-vault-test1-000000000
DynamoDB table: elastio-vault-test1-catalog
Stack version: 0.20.27
⠳ Adding a vault to the database...
Created new vault!

This option will soon be introduced into the Elastio Tenant also.

List vaults

Use the following command to return a list of the available vaults:

elastio vault list

Default vault

Use the following command to return the default vault for the current region and account:

elastio vault default

Use the following command to change the default vault:

elastio vault default <vault-name>

Note: You can skip using the --vault flag when you set your default vault. It is no longer necessary to add the vault name every time you run a command that requires the vault. The system will use the default vault if none is specified.

Delete a vault

Use the following command to delete a vault:

elastio vault delete <vault-name>

Pin vault shard

When running a backup or restore, the Elastio Provisioner service automatically spins up EC2 Spot resources and terminates these resources when no longer required, saving money. However, if you do not want to wait the few minutes it takes for the Provisioner to spin up the requisite resources more than once, you can use the Pin operation, which ensures that ScaleZ is always running and ready to accept backups and perform restores or mounts.

Note: ScaleZ is specifically designed to work with EC2 Spot instances. Consequently, it can tolerate the occasional termination of the EC2 Spot compute function without any data loss and seamlessly migrate to a replacement instance, potentially in another availability zone (AZ).

To pin or unpin an EC2 Spot instance, you must pass the following two required parameters:

  • <vault> - the name of the vault (positional argument)
  • --shard - shard type, where the fixed shard type is used for block, EC2 and EBS operations, and all other types are handled by the variable shard s0.

Run the following command to pin the spot instance to prevent it from being terminated:

elastio vault pin <vault-name> --shard <fixed/variable>

The Provisioner will automatically start the spot instance when you run any backup, restore or mount operation.

Run the following command to unpin this instance when you no longer need it pinned:

elastio vault unpin <vault-name> --shard <fixed/variable>

Note: While sudo -E is used for the EBS, block and EC2 commands, and root access is sometimes required for other operations, these elastio commands must be accompanied by --preserve-env=HOME on RHEL, Fedora, and CentOs.