Company Blog

Getting started with RLEC – How to Install and Setup

Getting started with RLEC – how to install and setup

Posts in this series:

  1. Introduction to Redis Labs Enterprise Cluster (RLEC)
  2. Getting started with RLEC – How to Install and Setup
  3. Getting started with RLEC – Installing on AWS Cloud
  4. Getting started with RLEC – How to Create and Configure a Database
  5. Getting Started with RLEC – Viewing Graphs & Metrics

In my previous blog post, I talked about why RLEC is the fastest, simplest way to extend, manage and monitor your Redis deployments. Now, in this post I will show you how easy this truly is using a step by step walk-through of how to install and setup RLEC.

First, you need to prepare the servers you would like to install RLEC on. For production purposes you should have an odd number of servers with a minimum of three, in order to ensure proper cluster functionality (in case of network splits and the likes…).

For testing purposes you can install it on any number of servers, but if you have less than two servers then some of the more interesting functionalities like high-availability, or sharding a database across multiple nodes, would not be available.

You can install RLEC on different OSs, as indicated in the download page. For the purpose of this blog post I will install it on Ubuntu 14.04. There might be some slight differences in other OSs, like Red Hat Enterprise Linux, or CentOS, that are documented in the documentation.

In the next post I will give step by step instructions how to install RLEC on instances on Amazon AWS cloud.

Installation

  1. First, download the installation package (.tar file), for the OS you are going to use, from the download page.
  2. Copy the package to all the servers you are going to install RLEC on.
  3. Open the OS Command Line Interface (CLI) and navigate to the folder to which you copied the package.
  4. Unpack the package – the command is: tar xvf [name of the .tar package].
  5. Run the install script – the command is: ./install.sh.
  6. The install script runs, checks for all dependencies and installs all the needed components.
  7. The install script will then prompt and ask you whether you would like to automatically tune the system for best performance. It is recommended to answer ‘y’.
  8. The install script will then continue to run and prompt you again and ask you whether you would like to setup NTP time synchronization. It is recommended to answer ‘y’. Time synchronization between the different cluster nodes is crucial for proper cluster functionality, if you choose to answer ‘n’ then it is recommended that you manually configure NTP on all servers, otherwise if the time is not synchronized across the servers the cluster might block you from adding additional nodes, or malfunction later on.
  9. The install script will continue running and upon successful completion it will provide you with a URL you should copy/paste into your browser in order to initiate the setup process.
    The URL has the structure of: https://[server IP address]:8443.

Running the setup process on the first cluster node

  1. Open the browser on any machine on the same network and paste the URL indicated above: https://[server IP address]:8443. You get a privacy warning from the browser, approve it and continue to this URL.
  2. You will now see the setup page which looks similar to the following:
    Setup
  3. Click on the Setup button.
  4. The “Node configuration“ page will be shown, similar to the below.
    • For simplicity you can leave the persistent and ephemeral storage paths with their default values.
    • In the “Cluster configuration“ section keep the “Create new cluster“ option chosen.
    • Enter a “Cluster name (FQDN)” for the cluster. You can click on the “Read more“ link to understand the different cluster naming options and how they should be configured, or read this section in the documentation.
    • For simplicity purposes do not check the “Enable rack-zone awareness“ checkbox.

    Click Next.

    Node configuration

  5. In the “Cluster authentication“ page click Next. If you have a cluster key then you can enter it in this step. You can also enter the cluster key later on once the cluster is setup in the Settings page.
  6. In the “Cluster registration“ page click Next. If you would like to register to receive email notifications on software upgrades, you can fill your details in this page.
  7. In the “Set admin credentials“ page you need to give a valid email address for a person that will be an administrator of the cluster, and a password. It is important to remember the email and password you provided, these will be used later on to login to the management UI, and in order to add additional nodes to the cluster. After you are logged in to the UI, you can add additional users that will be able to login to the system.
    Click Next.
    Set admin credentials
  8. You will be shown a progress indicator, and after the few seconds the cluster will be created and ready. You are shown the following page enabling you to create new databases:
    Create new database

Congratulations! You have just created your first RLEC cluster, wasn’t that simple?!

Adding additional nodes to the cluster

As indicated at the beginning of this post, a cluster with only one node does not support the full functionality of RLEC, and a production cluster should have an odd number of nodes with a minimum of three nodes.

Follow the instruction below on each server you would like to add as a node to the cluster.

  1. First, follow the instructions in the Installation section above.
  2. Once that is done, open the URL for the new node in the browser. If you get a privacy warning from the browser approve it and continue to this URL.
  3. You will see the Setup page again, as before, click on the Setup button.
  4. You will be shown the “Node configuration“ page again, as shown below.
    • For simplicity you can leave the persistent and ephemeral storage paths with their default values.
    • This time, in the “Cluster configuration“ choose the “Join cluster“ option, as shown below.
    • In the “Cluster name or IP address of a node in the cluster“ field you should enter the IP of the server you previously installed the cluster on, or the cluster name you provided in case you registered the cluster in your DNS. Once again, you can click on the “Read more“ link to understand the different options and how they should be configured, or read this section in the documentation.
    • Enter the admin email address and password you provided when you created the cluster earlier.

    Click “Next“.
    Node configuration

  5. You will be shown a progress indicator, and after the few seconds the new node will be added to the cluster and you will be shown the Nodes page showing you all the nodes in the cluster, as shown below.
    Nodes

You can follow the same steps on additional nodes and add them to the cluster, there is no limit on the number of nodes you can add.

If you encounter any difficulties please make sure to review the Troubleshooting section of the documentation, or shoot me an email at: itai.raz@redislabs.com.

That’s it for now!

If you would like to learn more about RLEC and how to enable more advanced functionalities please refer to the documentation that can be found here: https://redislabs.com/redis-enterprise-documentation/overview.

If you have any feedback or questions please don’t hesitate to reach out to me at: itai.raz@redislabs.com.

Subscribe

Get the latest Blog posts by email.