Redis Enterprise comes packaged with several modules. You can view the installed modules and their versions from settings > redis modules in the Redis Enterprise admin console.

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.

Note:
Modules are not supported in Redis Enterprise Software on RHEL/CentOS 6.x.

Get packaged modules

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

Add a module to a cluster

Use one of the following methods to add a module to a Redis Enterprise cluster:

REST API method

To add a module to the cluster using the REST API:

  1. Download the module package from the download center.

  2. Copy the package to a node in the cluster.

  3. Add the module to the cluster with a POST request to the /v1/modules endpoint:

    POST https://[host][:port]/v1/modules
    {"[email protected]/tmp/redisearch.Linux-ubuntu16.04-x86_64.2.2.6.zip"}
    

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

  4. If the module installation succeeds, the POST request returns a JSON object that represents the new module. If it fails, it may return a JSON object with an error_code and description with more details.

Admin console method

To add a module to the cluster using the admin console:

  1. In the Redis Enterprise admin console, select settings.

  2. From redis modules, select the Add module button:

    The Add module button
  3. Use the file browser to select the packaged module.

  4. Verify Selected module shows the correct filename and select the Upload button:

    The Upload module button
  5. The new module version should appear in the list of Redis modules:

    The Redis modules list
    Note:
    If you don’t see the updated module version, refresh the page.

Next steps