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.
  • We recommend that you test module upgrade commands in a test environment before you upgrade modules in a production environment. The module upgrade arguments are not validated during the upgrade process and incorrect arguments can cause unexpected downtime.
  • Upgrading a cluster with a single node does not load the new modules that are bundled with the new cluster version.
  • Before you upgrade a database with RediSearch Module to Redis 5.0, you must upgrade the RediSearch Module to version 1.4.2 or above.

Getting the Packaged Modules

Adding a Module to Redis Enterprise Software Cluster

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.

To upgrade a module that is installed on a cluster:

  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 db <database_name> and module module_name <module_name> version <new_module_version_number> module_args "<module arguments>"
    • If you want to remove the existing module arguments, enter "" without arguments.
    • If you want to use the existing module arguments, enter "keep_args"
    • If you want to update multiple modules, use the and module parameter for each module.

Examples

Here are some examples of module upgrades:

  • To upgrade the version of RediSearch to 1.6.7 and specify arguments:

    rladmin upgrade db <database_name> and module db_name MyAwesomeDB module_name ft version 10607 module_args "PARTITIONS AUTO"

  • To upgrade RedisBloom to version 2.2.1 and remove arguments:

    rladmin upgrade db <database_name> and module db_name MyDB module_name bf version 20201 module_args ""

  • To upgrade RedisJSON to 1.0.4 and keep existing arguments and RedisBloom to version 2.2.1 and remove arguments:

    rladmin upgrade module db_name MyDB module_name ReJSON version 10004 module_args "keep_args" and module db_name MyDB module_name bf version 20201 module_args ""