This section covers everything you need to know to get up and running with RS.

Note -

In addition to using the RS web UI to manage the cluster, you can also do cluster operations with the cluster REST API.

To access the cluster REST API documentation, either:

  • Open the HTML files in the RS software package:
    1. Download the RS software package.
    2. Unarchive the package.
    3. Unarchive the rlec_docs.tar.gz package.
    4. Open the rlec_docs\html\index.html file in a web browser.
  • Open the HTML files in an installed RS node:
    1. Connect to the terminal of an RS node.
    2. Change directory to the installation directory of RS, for example /opt.
    3. Copy the rlec_rest_api.tar.gz package to a host with a web browser and unarchive it.
    4. Open the rlec_docs\html\index.html file in a web browser.

    Active-Active Geo-Distributed Redis (CRDB)

    In Redis Enterprise, active-active geo-distribution is based on CRDT technology. The Redis Enterprise implementation of CRDT is called Conflict-Free Replicated Database (CRDB). With CRDBs, applications can read and write to the same data set from different geographical locations seamlessly and with latency less than 1 ms, without changing the way the application connects to the database. CRDBs also provide disaster recovery and accelerated data read-access for geographically distributed users.

    Active-Passive Geo-Distributed Redis (Replica-Of)

    In Redis Enterprise, active-passive geo-distribution provides applications read-only access to replicas of the data set from different geographical locations. The Redis Enterprise implementation of active-passive replication is called Replica Of. In Replica Of, an administrator designates a database as a replica (destination) of one or more databases (sources). After the initial data load from source to destination is completed, all write commands are synchronized from the sources to the destination.

    Cluster Operations

    This section has all you need to know pertaining to administering the cluster in Redis Enterprise Software. Adding a Node to an Existing Cluster When you install RS on the first node of a cluster, you create the new cluster. After you install the first node, you can add more nodes to the cluster. Prerequisites The clocks on all nodes must always be synchronized. If the clock in the node you are trying to join to the cluster is not synchronized with the nodes already in the cluster, the action fails and an error message is shown indicating that you must synchronize the clocks first.

    Database Operations

    This section contains all you need to know to operate databases hosted on Redis Enterprise Software. Causal Consistency in a Conflict-free Replicated Database (CRDB) When enabling Causal Consistency in CRDBs, the order of operations on a specific key are maintained across all CRDB instances. For instance, if operations A and B were applied on the same key, and B was performed after the effect of A was observed by the CRDB Instance that initiated B, then all CRDB instances would observe the effect of A before observing the effect of B.

    Designing for Production

    The information in the section discusses important topics you need to know about when designing your Redis Enterprise Software cluster for a production deployment. Hardware requirements The hardware requirements for Redis Enterprise Software (RS) are different for development and production environments. In a development environment you can test your application with a live RS database. If you want to test your application under production conditions, use the production environment requirements.

    Logging and Audit Events

    Management actions performed with Redis Enterprise are audited in order to fulfill two major objectives: To make sure that system management tasks are appropriately performed and/or monitored by the Administrators To facilitate compliance with regulatory standards In order to fulfill both objectives, the audit records contain the following information: Who performed the action? What exactly was the performed action? When was the action performed? Did the action succeed or not?

    Monitoring and Metrics

    Metrics Definitions Redis Enterprise Software (RS) includes many useful metrics give you a detailed picture of what is going on in the cluster, node, database, and shard. For Redis on Flash (ROF) databases, additional metrics are available. Standard Metrics Metric Components measured Description More information Connections Cluster, Node, Database Number of connections used to access the database CPU usage Cluster, Node Percent usage of the CPU Evicted objects/sec Database, Shard Number of objects evicted per second The eviction process is taken place if:

    Redis Enterprise Software Product Lifecycle

    You can view the Redis Enterprise Software subscription agreement here. This Product Lifecycle fully reflects our subscription agreement. However, for any discrepancy between the two policies, the subscription agreement prevails. Redis Enterprise modules follow the modules lifecycle. Release Numbering Redis Labs uses a four-place numbering scheme to designate released versions of its products. The format is “Major1.Major2.Minor-Build”. Major sections of the version number represents fundamental changes and additions in capabilities to Redis Enterprise Software.


    This section includes various troubleshooting tips and tricks for Redis Enterprise Software (RS). Topics: Creating a Support Package If you encounter any issues that you are not able to resolve yourself and need to contact Redis Labs support for assistance, you can create a support package that gathers all essential information to help us debug your issues. Creating a support package To create a support package: Click Support at the top right of the management UI.