Redis Cluster with RedisJSON + RedisSearch but for production

This is meant if you wanna do redis clustering on production, it will open up redis on different services.

If you want to do it locally on development, here is the branch for it https://github.com/Pogy-Bot/redis-cluster-example/tree/clustering-development

Notes

• If you wanna build the plugins, make sure you have the language rust installed
• You should be using systemd to manage your services or it will not work

Summary of Steps

Step 1 and 2 are incase plugins cannot somehow work in the plugins folder in this repo.

• Download RedisJSON plugin - optional
• Download Redis Search plugin - optional
• Initializing
• Run the redis command to link the clusters

1- Download RedisJSON plugin - optional

If you decided to build it from source, here are the commands to do so:

git clone https://github.com/RedisJSON/RedisJSON
cd RedisJSON
cargo build --release
cd .. # go back to where you started

then go to each redis.conf and change the path to

loadmodule /path/to/RedisJSON/target/release/librejson.so

2- Download Redis Search plugin - optional

If you decided to build it from source, here are the commands to do so:

git clone --recursive https://github.com/RediSearch/RediSearch.git
cd RediSearch
make setup
make build
cd .. # go back to where you started

then go to each redis.conf and change the path. To find the path run:

find . -name "redisearch.so"

and use the path that is returned.

3- Initializing

Install redis-server and disable the service

sudo apt-get update # update the package list
sudo apt-get install redis-server # install redis
sudo systemctl disable redis-server.service # disable the service

Create and edit the /etc/rc.local file by running the following command:

sudo nano /etc/rc.local

and add to its content, press CTRL + X then Y to save and exit

 #!/bin/sh -e
 #
 # rc.local
 #
 # This script is executed at the end of each multiuser runlevel.
 # Make sure that the script will "exit 0" on success or any other
 # value on error.
 #
 # In order to enable or disable this script just change the execution
 # bits.
 #
 # By default this script does nothing.
 echo never > /sys/kernel/mm/transparent_hugepage/enabled
 sysctl -w net.core.somaxconn=65535

 exit 0

Give executable permissions to the /etc/rc.local file by running the following command:

sudo chmod +x /etc/rc.local

Edit the /etc/sysctl.conf by running the following command:

sudo nano /etc/sysctl.conf

Add the following line at the end of the file:

vm.overcommit_memory=1

clone the current repo and CD to it

git clone https://github.com/Pogy-Bot/redis-cluster-example
cd redis-cluster-example

Customize anything you want then copy the files to /etc/redis/ and /var/lib/redis/

sudo cp -r * /etc/redis/
sudo cp -r * /var/lib/redis/

Create a redis user and a redis group for the Redis Server services and give them the correct permissions by running the following commands:

sudo chown redis:redis -R /var/lib/redis
sudo chmod 770 -R /var/lib/redis
sudo chown redis:redis -R /etc/redis

Now, we will have create the systemd services. Let's start by giving create.sh execution permissions

chmod +x create.sh

and run it

sudo sh ./create.sh

Now let's enable all the services

chmod +x enable.sh # give execution permissions
sudo sh ./enable.sh # enable the services

now start all the services

chmod +x start.sh # give execution permissions
sudo sh ./start.sh # start the services

to check the status of any services

systemctl status redis_node_<port>

#or to see all
systemctl list-units --type=service

to get logs:

sudo tail -n 100 /var/log/redis/redis_node_<port>.log

4- Run the redis command to link the clusters

The command is used to create a Redis cluster.

redis-cli is the Redis command line interface.

The --cluster create option is used to create a new Redis cluster.

The IP addresses and port numbers provided in the command 127.0.0.1:7001 127.0.0.1:7002 127.0.0.1:7003 127.0.0.1:7004 127.0.0.1:7005 127.0.0.1:7006 etc specify the nodes that will be part of the cluster. The IP address 127.0.0.1 is the localhost address, which means the nodes are running on the same machine as the Redis client. The port numbers specify the individual nodes of the cluster.

The --cluster-replicas 1 option sets the number of replicas for each key in the cluster to 1. This means that for each key, there will be one additional copy stored in another node in the cluster to provide redundancy in case of a node failure.

In conclusion, this command creates a Redis cluster with the specified nodes, with each key having one replica stored in another node.

redis-cli --cluster create \
  127.0.0.1:7001 127.0.0.1:7002 127.0.0.1:7003 \
  127.0.0.1:7004 127.0.0.1:7005 127.0.0.1:7006 \
  127.0.0.1:7007 127.0.0.1:7008 127.0.0.1:7009 \
  127.0.0.1:7010 127.0.0.1:7011 127.0.0.1:7012 \
  --cluster-replicas 1

Extra

you can use the redis-cli to connect to the cluster and run commands

ex, checking your clusters:

redis-cli -c -p 7001

then

CLUSTER NODES

If you want to purge the main redis server:

sudo apt-get --purge remove redis-server
sudo rm -rf /etc/redis/dump.rdb

To reinstall

sudo apt-get update
sudo apt-get install redis-server

Commands

# start
sudo systemctl start redis_node_<port>.service

# stop
sudo systemctl stop redis_node_<port>.service

# restart
sudo systemctl restart redis_node_<port>.service

# enable
sudo systemctl enable redis_node_<port>.service

# disable
sudo systemctl disable redis_node_<port>.service

# status
systemctl status redis_node_<port>.service

Mass Commands

sudo sh create.sh # create all services
sudo sh start.sh # start all services
sudo sh stop.sh # stop all services
sudo sh restart.sh # restart all services
sudo sh enable.sh # enable all services

Errors

• If you get cluster formatting errors use

tr -d '\r' < filename.sh > filename_fixed.sh

and then run ./filename_fixed.sh instead.