Install a module on a cluster

Redis Enterprise Software comes packaged with several modules that provide additional Redis capabilities such as search and query, JSON, time series, and probabilistic data structures. As of version 8.0, Redis Enterprise Software includes four feature sets, compatible with different Redis database versions. You can view the installed modules, their versions, and their minimum compatible Redis database versions from Cluster > Modules in the Cluster Manager UI.

To use other modules or upgrade an existing module to a more recent version, you need to install the new module package on your cluster.

Get packaged modules

To install or upgrade a module on a Redis Enterprise Software cluster, you need a module package.

• For versions of official Redis modules that are not available from the Redis download center, contact support.

• For custom-packaged modules, download a custom-packaged module from the developer.

Add a user-defined module to a cluster (Redis Software v8.0.x and later)

To add a custom module to a cluster running Redis Enterprise Software version 8.0.x or later, use the following REST API requests:

1. Upload the custom module configuration. Replace the values in the following example with your own.

   POST https://<host>:<port>/v2/modules/user-defined
   {
     "module_name": "TestModule",
     "version": 1,
     "semantic_version": "0.0.1",
     "display_name": "test module",
     "commands": [
       {
         "command_arity": -1,
         "command_name": "module.command",
         "first_key": 1,
         "flags": ["write"],
         "last_key": 1,
         "step": 1
       }
     ],
     "command_line_args": "",
     "capabilities": ["list", "of", "capabilities"],
     "min_redis_version": "2.1"
   }
   

2. For each node in the cluster, upload the custom module artifact:

   POST https://<host>:<port>/v2/local/modules/user-defined/artifacts
   "module=@/tmp/custom-module.so"
   

   The module parameter specifies the full path of the module artifact and must be submitted as form-data. In addition, the module artifact must be available and accessible to the server processing the request.

Add a module to a cluster (Redis Software v7.22.x and earlier)

Use one of the following methods to add a module to a cluster running Redis Enterprise Software version 7.22.x or earlier:

For RedisGears, follow these installation instructions instead.

Next steps

• Create a database and enable the new module.
• Upgrade a module to the new version.