Create your first instance and connect to it

Prerequisites

• You have a STACKIT customer account: Create a customer Account
• You have a STACKIT user account: Create a user account
• You have a STACKIT project: Create a project

Prepare, order and create an instance

In this Getting started guide you will create an instance and configure it. This guide shows the most common settings for a small developer environment. When following this guide, you will work with the STACKIT Portal. There are many other ways to manage instances. For a deeper understanding, please consult Create and manage instances for Redis.

1. Visit the STACKIT portal
2. On the sidebar click on Redis.
3. On the bar on the top click on Create Redis.

After completing the steps, you see an overlay with three sections (General information, Plans and Custom parameters).

General information

• Either leave the name for the instance as it is or insert a custom one.
• On Instance version select the Redis version you want to use. For new projects we recommend to use the newest available version.

Plans

• Leave the plan setting as it is (1 Node, 1 vCPU, 4GB RAM and 10GB Disk) unless you know in advance how much resources you’ll need. You can not change the plan afterwards within some boundaries.

Custom parameters

• Leave the disk threshold settings as it is (80%).

• Add your clients IPv4 address to the list of ACLs.

  If you want to connect with the computer, with which you are browsing these docs, use Cloudflare’s IP trace tool to determine your IPv4 address. Open your browser of choice and visit the Cloudflare Trace Tool . Copy the value behind ip. It should look like xxx.xxx.xxx.xxx. Now append /32 to it and add it as ACL entry. To do so, append it with a leading comma to the existing entries. For a deeper understanding of ACL entries, visit Create and manage instances for Redis.

If you don’t add your external clients IPv4 address to the list of ACLs, you won’t be able to connect from it to your instance!

After reviewing every setting, click on Order fee-based to create your new instance. Then you will see a confirmation that your instance is created. Your new instance will be added to the list of instances. After a few minutes it will switch from Processing to Active.

Configure your instance

To make any changes to your instance, you need to select it. Please click on the sidebar on Redis and then on your newly created instance. Then the overview page of you instance will be displayed.

Create credentials

You need to wait for your instance to become Active. Otherwise the Credentials pane doesn’t show up.

1. On the sidebar click on Credentials.
2. Click on Create credentials.
3. Copy the informations from the popup to a safe location.
4. Click on Close.

Connect to your new instance

To connect to your new instance, you need a client software. In this guide we use Redis Insight. You can download it on the Redis Insight Download Page . An alternative is the redis-cli command. Visit the Redis-CLI docs to get more information.

Follow the instructions of your Operating System to install the downloaded Redis Insight installation package. After successful installation open Redis Insight and add your connection:

1. After opening Redis Insight click on + Add Redis database.

2. On the new pane paste the connection string, that you’ve otained in the Create credentials section, into the Connection URL field.

3. Then click on Connection Settings and switch to the Security tab.

   

4. Click on Use SNI and leave the prefilled field as it is.

5. Click on Add Redis Database

If you receive the error Reached the max retries per request limit (which is 1). Refer to "maxRetriesPerRequest" option for details. while adding the connection, double check your ACL settings!

After your client has established a connection, you can insert some sample leaderboard data as an real-world use case:

In the lower left click on >_ CLI and insert a set of four players and their score representing a leaderboard:

ZADD leaderboard 1200 "alice" 950 "bob" 1430 "carol" 500 "dave"

The database will return:

(integer) 4

Now let the database return the top 3 players:

ZREVRANGE leaderboard 0 2 WITHSCORES

The database will return:

1) "carol"
2) "1430"
3) "alice"
4) "1200"
5) "bob"
6) "950"

Now a player wins and 275 score points are added to his account:

ZINCRBY leaderboard 575 "dave"

The database will return the new score from Dave:

"775"

Now let the database return the top 3 players again:

ZREVRANGE leaderboard 0 2 WITHSCORES

The new output will be:

1) "carol"
2) "1430"
3) "alice"
4) "1200"
5) "dave"
6) "1075"

including Dave now in the top 3.

In this example you executed some basic commands with Redis. From here on you may want to dig deeper with the How-tos.