Redis on Flash (RoF) quick start
This page guides you through a quick setup of a Redis on Flash cluster with a single node for testing and demo purposes.
For production environments, you can find more detailed installation instructions in the install and setup section.
The steps to set up a Redis Enterprise Software cluster using Redis on Flash with a single node are:
- Install Redis Enterprise Software or run it in a Docker container.
- Set up a Redis Enterprise Software cluster with Redis on Flash.
- Create a new Redis on Flash database.
- Connect to your new database.
Install Redis Enterprise Software
Bare metal, VM, Cloud instance
To install on bare metal, a virtual machine, or an instance:
Download the binaries from the Redis Enterprise download center.
Upload the binaries to a Linux-based operating system.
Extract the image:
tar -vxf <downloaded tar file name>
- After the
tarcommand completes, you can find a new
install.shscript in the current directory:
sudo ./install.sh -y
For testing purposes, you can run a Redis Enterprise Software Docker container on Windows, MacOS, and Linux.
docker run -d --cap-add sys_resource --name rp -p 8443:8443 -p 12000:12000 redislabs/redis:latest
Set up a cluster and enable Redis on Flash
- Direct your browser to
https://localhost:8443/on the host machine to see the Redis Enterprise Software admin console. Select the Setup button to get started.
- On the node configuration page, select the Enable flash storage support checkbox and provide a cluster FQDN: mycluster.local. Then select the Next button.
If you don’t have a license key yet, select the Next button to try the trial version of the product.
On the next screen, set up account credentials for a cluster administrator.
Select OK to confirm that you are aware of the replacement of the HTTPS SSL/TLS certificate on the node, and proceed through the browser warning.
Create a database
Select the “new redis db flash” option.
On the create database page:
- Enter myredisflashdb for a database name.
- Enter 12000 for the endpoint port number.
- Select show advanced options to see the various alerts available.
- Select Activate to create your database.
You now have a Redis on Flash database!
Connect to your database
You are ready to connect to your database to store data. See the test connectivity page to learn how to connect to your database.
If you want to generate load against the database or add a bunch of data for cluster testing, see the memtier_benchmark quick start for help.
To see the true performance and scale of Redis on Flash, you must tune your I/O path and set the flash path to the mounted path of SSD or NVMe flash memory as that is what it is designed to run on. For more information, see Redis on Flash.