Getting Started

Creating a Cloudalus KV database as a drop-in replacement for Redis could not be easier. In this guide we'll walk you through creating and connecting to your new database.

Step 1: Create a Database

When you first login you'll have an organisation automatically created called "Default Organisation". Think of an organisation as a project folder you can invite others to.

On the left navigation bar, select "Databases". Next click "Create"

Step 2: Connect from the dashboard

Next to your database, click the icon. This will open a terminal in your browser.

You can use this terminal to quickly connect to your database. You can also use the terminal to run commands such as GET and SET.

Step 3: Create an access key

To connect to your database from a Redis compatible client, you'll need to create an access key.

On the left navigation bar, select "Access Keys". Next click "Create"

Make sure to copy the access key secret, as you'll need it to connect to your database. The secret key is only shown once, so make sure to save it somewhere safe.

Step 4: Grant access to your database

By default, access keys do not have any permissions. You'll need to grant access to your database before you can use it.

Next to the access key you just created, click the icon. This will open a page where you can update your access key's permissions.

For this guide, we'll grant the access key full access to all databases. Select the managed policy "KvDB Execute All Commands" / kvdb-execute-any and click "Save".

Step 5: Connect from a Redis client

Now that you've granted access to your database, you can connect to it from a Redis compatible client.

When connecting you'll need to authenticate and select a database. There are a few ways to do this:

Seperate AUTH and USE commands

You can use the AUTH command to authenticate with the access key. You can then use the USE command to select the database:

  AUTH aks_fakeaccesskeysecret
  USE kvdb_fakedatabaseid

Single AUTH command

You can use the AUTH command to authenticate with the access key and select the database in a single command.

AUTH recognises both username and password as seperate fields, or a single field with a colon separating the username and password.

  AUTH kvdb_fakedatabaseid aks_fakeaccesskeysecret

  AUTH kvdb_fakedatabaseid:aks_fakeaccesskeysecret

Using the Redis CLI

As an example, here's how you can connect to your database using the Redis CLI:

redis-cli \
        --tls \
        -p 6380 \
        -h us-east-1.kvdb.cloudalus.com \
        -a kvdb_fakedatabaseid:aks_fakeaccesskeysecret