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

Return to the regular view of this page.

Getting started

Getting started with Elastx The Vault

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 - 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.

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:

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>