We are constantly working to improve the modules. To get the latest features and fixes for a module, you must upgrade the module in Redis.

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

Getting the Packaged Modules

Deploying the Packaged Module into Redis Enterprise Software

To deploy an upgraded package:

  1. In the Redis Enterprise web UI, go to the: settings
  2. In redis modules, click Add Module.

    upgrade_module-1

  3. Browse to the packaged module and upload it.

  4. Note the version number of the new module version.

  5. In databases, select the configuration section.

    The database configuration shows that a new version of the module is available for the database.

    update_available-1

Upgrading the Module for the Database

Note -
After you upgrade the module for a database, the database shards are restarted. This causes a short interruption in the availability of this database across the cluster.

When you upgrade the module for a database, you can either:

  • Specify the module arguments to replace the current arguments.
  • Specify the 'keep_module_args' flag to use the current argument.
  1. Connect to the terminal of a node in the cluster
  2. Run rladmin status to list the databases on the node.
  3. Copy the name of the database that uses the module that you want to upgrade.

    rladmin_status-1

  4. Find the exact module name and version:

    1. Extract the module archive (zip) file.
    2. Open the JSON file.
    3. Find the module name and version number in the file.

    An example of the JSON file for the RediSearch module is:

    module_info-1

  5. To upgrade the module for the database, run:

    rladmin upgrade module db_name <database_name> module_name <module_name> version <new_module_version_number> module_args <module arguments>

Examples

Here are some examples of module upgrades:

  • To upgrade the version of RediSearch to 1.6.7:

    rladmin upgrade module db_name MyAwesomeDB module_name ft version 10607 module_args "PARTITIONS AUTO"
  • To upgrade RedisBloom to version 2.2.1:

    rladmin upgrade module db_name MyDB module_name bf version 20201 module_args ""
  • To upgrade RedisJSON to 1.0.4:

    rladmin upgrade module db_name MyDB module_name ReJSON version 10004 module_args ""