Before you can use RedisGears, you have to install the RedisGears module on your Redis Enterprise cluster.

Minimum requirements

  • Redis Enterprise 6.0.12 or later
  • The cluster is setup and all of the nodes are joined to the cluster

Install RedisGears

If your cluster uses Redis Enterprise v6.0.12 or later and has internet access, you only need to download the RedisGears package. It automatically fetches dependencies like the Python and JVM plugins during online installation.

Offline installation requires you to manually upload dependencies to the master node.

Install RedisGears and dependencies

  1. Download the RedisGears package from the download center.

    Note:
    For offline installation of RedisGears v1.2 and later, you also need to download the RedisGears Dependencies packages for both Python and Java.

    For RedisGears v1.0, you only need the Python dependency package.
  2. Upload the RedisGears package to a node in the cluster.

  3. For offline installation only, copy the dependencies to the following directory on the master node: $modulesdatadir/rg/<version-integer>/deps/

    $ cp redisgears-jvm.<OS>.<version>.tgz $modulesdatadir/rg/<version-integer>/deps/
    

    Replace these fields with your own values:

    • <OS>: the operating system running Redis Enterprise

    • <version>: the RedisGears version (x.y.z)

    • <version-integer>: the RedisGears version as an integer, calculated as (x*10000 + y*100 + z)

      For example, the <version-integer> for RedisGears version 1.2.5 is 10205.

    Note:
    Skip this step unless your cluster does not have internet access.
  4. Add RedisGears to the cluster with a POST request to the master node’s /v2/modules REST API endpoint:

    POST https://[host][:port]/v2/modules
    {"[email protected]/tmp/redisgears.<OS>.<version>.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.

After the install is complete, RedisGears will appear in the list of available modules on the settings and create database pages of the Redis Enterprise admin console.

Enable RedisGears for a database

After installation, create a new database and enable RedisGears:

Uninstall RedisGears

To uninstall RedisGears, make a DELETE request to the /v2/modules REST API endpoint.