Developing with Redis Modules in Redis Enterprise Software (RS)
Note: Modules are not supported in Redis Enterprise Software on RHEL/CentOS 6.x
Redis Labs Packaged Modules
There are three modules Redis Labs has developed, certified, and packaged for use with Redis Enterprise Software (RS) clusters. They are:
- RedisGraph (version 5.4 and higher)
- RediSearch Enterprise
Enterprise modules are pre-installed in version 5.0.2 and higher.
To download these modules, please go to the Redis Enterprise downloads page.
To upgrade these modules, please go to Upgrading a Module.
Critical: Redis Labs does not and can not support third party modules or databases created with them.
Packaging Non-Certified Modules
In addition to the ones Redis Labs packages and certifies, there are other modules that can be installed and extend Redis databases in Redis Enterprise Software. While many are compatible with RS, not all of them are. If they work, they must be packaged so RS knows how to deploy and use them in the cluster.
Deploying a custom module and creating a database utilizing that modules require six steps:
- Get the module from git
- Compile the module
- Install ramp-packer utility
- Wrap the custom module using ramp utility
- Deploy the custom module to the cluster using the web UI
- Create a database that utilizes the module
Get the Module from Github
$ git clone https://github.com/account/myModule.git
Compile the Module
To compile the module just run:
$ cd myModule/;make
Install ramp-packer Utility
RAMP or "Redis Automatic Module Packaging", is a utility created by Redis Labs for packaging up modules to be installed into Redis Enterprise.
Run the next command to install ramp-packer:
$ pip install ramp-packer
Wrap the Custom Module Using Ramp Utility
$ ramp pack <PATH_TO_myModule.so> -a "Your Name" -e "firstname.lastname@example.org" -A "x86_64" -d "My Module" -h "https://www.mymodule.com/" -l "LicenseType" -r "4.0.2"
To deploy the packaged module, see Installing a Module.