Skip to content
Open
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
478b879
DOC-5680 RS: Removed manual module upload steps from OS upgrade prereqs
rrelledge Sep 2, 2025
cc5069d
DOC-5680 Added manage_cluster_modules to REST API permissions
rrelledge Sep 3, 2025
d1dcaa3
DOC-5680 Added user-defined modules REST API requests reference
rrelledge Sep 4, 2025
1429ae7
DOC-5680 Copy edits for user-defined modules REST API requests reference
rrelledge Sep 4, 2025
cecb428
DOC-5680 Added RS 8 updates for installing modules on a cluster
rrelledge Sep 4, 2025
e1e9789
DOC-5680 Removed module install step from RS 8 version of recover DB
rrelledge Sep 4, 2025
4712f0e
DOC-5680 Removed previously deprecated module requests from RS 8 REST…
rrelledge Sep 4, 2025
00bbe97
Merge branch 'release-rs-gilboa' into DOC-5680
rrelledge Sep 5, 2025
f070866
DOC-5680 Removed min_redis_pack_version and platforms from module RES…
rrelledge Sep 5, 2025
0e05a13
DOC-5680 Removed min_redis_pack_version and architecture from module_…
rrelledge Sep 5, 2025
1230eaa
DOC-5680 Added module object link in user-defined REST API requests r…
rrelledge Sep 5, 2025
614b991
DOC-5680 Mentioned Redis 8 automatically enables some modules/capabil…
rrelledge Sep 5, 2025
086352a
Merge branch 'release-rs-gilboa' into DOC-5680
rrelledge Sep 8, 2025
de65637
DOC-5680 RS: More Redis 8 updates for auto-enabled modules
rrelledge Sep 8, 2025
6a94464
Merge branch 'release-rs-gilboa' into DOC-5680
rrelledge Sep 8, 2025
b88af88
Merge branch 'release-rs-gilboa' into DOC-5680
rrelledge Sep 24, 2025
ae1b20b
Merge branch 'release-rs-gilboa' into DOC-5680
rrelledge Sep 26, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions content/embeds/rs-8-enabled-modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
| Database type | Automatically enabled capabilities |
|---------------|------------------------------------|
| RAM-only | [Search and query]({{<relref "/operate/oss_and_stack/stack-with-enterprise/search">}})<br />[JSON]({{<relref "/operate/oss_and_stack/stack-with-enterprise/json">}})<br />[Time series]({{<relref "/operate/oss_and_stack/stack-with-enterprise/timeseries">}})<br />[Probabilistic]({{<relref "/operate/oss_and_stack/stack-with-enterprise/bloom">}}) |
| Flash-enabled ([Auto Tiering]({{<relref "/operate/rs/databases/auto-tiering">}})) | [JSON]({{<relref "/operate/oss_and_stack/stack-with-enterprise/json">}})<br />[Probabilistic]({{<relref "/operate/oss_and_stack/stack-with-enterprise/bloom">}}) |
| [Active-Active]({{<relref "/operate/rs/databases/active-active">}}) | [Search and query]({{<relref "/operate/oss_and_stack/stack-with-enterprise/search/search-active-active">}})<br />[JSON]({{<relref "/operate/oss_and_stack/stack-with-enterprise/json">}}) |
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,15 @@ linkTitle: Install and upgrade modules
weight: 4
---

Several modules, which provide Redis Stack features, come packaged with [Redis Enterprise Software]({{< relref "/operate/rs" >}}). As of version 7.8.2, Redis Enterprise Software includes three feature sets, compatible with different Redis database versions. However, if you want to use additional modules or upgrade a module to a more recent version, you need to:
Several modules that provide additional Redis capabilities, such as search and query, JSON, time series, and probabilistic data structures, come packaged with [Redis Enterprise Software]({{< relref "/operate/rs" >}}). As of version 8.0, Redis Enterprise Software includes four feature sets, compatible with different Redis database versions.

However, if you want to use additional modules or upgrade a module to a more recent version, you need to:

1. [Install a module package]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster" >}}) on the cluster.
1. [Enable a module]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database" >}}) for a new database or [upgrade a module]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module" >}}) in an existing database.

## Automatically enabled capabilities in Redis 8

Databases created with or upgraded to Redis version 8 or later automatically enable the capabilities (modules) bundled with Redis Enterprise Software as follows:

{{<embed-md "rs-8-enabled-modules.md">}}
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,12 @@ linkTitle: Install on a cluster
weight: 10
---

[Redis Enterprise Software]({{< relref "/operate/rs" >}}) comes packaged with several modules. As of version 7.8.2, Redis Enterprise Software includes three 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.
[Redis Enterprise Software]({{< relref "/operate/rs" >}}) comes packaged with several modules that provide additional Redis capabilities such as [search and query]({{<relref "/operate/oss_and_stack/stack-with-enterprise/search">}}), [JSON]({{<relref "/operate/oss_and_stack/stack-with-enterprise/json">}}), [time series]({{<relref "/operate/oss_and_stack/stack-with-enterprise/timeseries">}}), and [probabilistic data structures]({{<relref "/operate/oss_and_stack/stack-with-enterprise/bloom">}}). 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.

{{<warning>}}
- Some module versions are not supported or recommended for use with Redis Enterprise.

- We recommend consulting [Redis support](https://redis.io/support/) before you upgrade a module on the cluster, especially if the cluster is used in production.
Some module versions are not supported or recommended for use with Redis Enterprise Software.
{{</warning>}}

## Get packaged modules
Expand All @@ -28,17 +26,61 @@ To install or upgrade a module on a [Redis Enterprise Software]({{< relref "/ope

- For custom-packaged modules, download a [custom-packaged module](https://redislabs.com/community/redis-modules-hub/) from the developer.

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

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]({{< relref "/operate/rs/references/rest-api/requests/modules/user-defined#post-user-defined-module" >}}). Replace the values in the following example with your own.

```sh
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"
}
```

1. For each node in the cluster, [upload the custom module artifact]({{< relref "/operate/rs/references/rest-api/requests/modules/user-defined#post-local-user-defined-artifacts" >}}):

```sh
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) {#add-a-module-to-a-cluster}

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

Use one of the following methods to add a module to a Redis Enterprise cluster:
{{< multitabs id="install-modules"
tab1="Cluster Manager UI"
tab2="REST API" >}}

- REST API [`POST` request to the `/v2/modules`]({{< relref "/operate/rs/references/rest-api/requests/modules#post-module-v2" >}}) endpoint
To add a module to the cluster using the Cluster Manager UI:

- Redis Enterprise Cluster Manager UI
1. Go to **Cluster > Modules**.

- For RedisGears, follow these [installation instructions]({{< relref "/operate/oss_and_stack/stack-with-enterprise/gears-v1/installing-redisgears" >}})
1. Select **Upload module**.

### REST API method
1. Use the file browser to add the packaged module.

-tab-sep-

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

Expand All @@ -47,23 +89,21 @@ To add a module to the cluster using the REST API:
1. Add the module to the cluster with a [`POST` request to the `/v2/modules`]({{< relref "/operate/rs/references/rest-api/requests/modules#post-module-v2" >}}) endpoint:

```sh
POST https://[host][:port]/v2/modules
POST https://<host>:<port>/v2/modules
"module=@/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.

1. If the module installation succeeds, the `POST` request returns a [JSON object]({{< relref "/operate/rs/references/rest-api/objects/module" >}}) that represents the new module. If it fails, it may return a JSON object with an `error_code` and `description` with more details.

### Cluster Manager UI method
{{< /multitabs >}}

To add a module to the cluster using the Cluster Manager UI:
For RedisGears, follow these [installation instructions]({{< relref "/operate/oss_and_stack/stack-with-enterprise/gears-v1/installing-redisgears" >}}) instead.

1. Go to **Cluster > Modules**.

1. Select **Upload module**.

1. Use the file browser to add the packaged module.
{{<warning>}}
We recommend consulting [Redis support](https://redis.io/support/) before you upgrade a module on the cluster, especially if the cluster is used in production.
{{</warning>}}

## Next steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,22 @@ weight: 30

Modules add additional functionality to Redis databases for specific use cases. You can enable modules when you create a database.

## Prerequisites
## Automatically enabled capabilities in Redis 8

- [Installed the module on the cluster]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster" >}})
- [Upgraded the module]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module" >}}) to the latest version
Databases created with or upgraded to Redis version 8 or later automatically enable the capabilities (modules) bundled with Redis Enterprise Software as follows:

{{<embed-md "rs-8-enabled-modules.md">}}

## Create a database with a module

{{<note>}}
You can only add modules to a database when you first create it. You cannot add modules to an existing database.
{{</note>}}

### Prerequisites

- [Installed the module on the cluster]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster" >}})
- [Upgraded the module]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module" >}}) to the latest version

### Create a database and enable capabilities

In the Redis Enterprise Cluster Manager UI, follow these steps to add modules to a database:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To use JSON in an Active-Active database, you must enable JSON during database c

Active-Active Redis Cloud databases add JSON by default. See [Create an Active-Active database]({{< relref "/operate/rc/databases/create-database/create-active-active-database#select-capabilities" >}}) in the Redis Cloud documentation for details.

In Redis Enterprise Software, JSON is not enabled by default for Active-Active databases. To create an Active-Active JSON database in Redis Enterprise Software:
In Redis Enterprise Software, Active-Active databases created with or upgraded to Redis version 8 or later automatically enable JSON. For earlier Redis versions, you can enable JSON during database creation:

1. See [Create an Active-Active geo-replicated database]({{< relref "/operate/rs/databases/active-active/create" >}}) in the Redis Enterprise Software documentation for prerequisites and detailed steps.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You can run search operations on any instance of an Active-Active database.

## How it works

1. Create an Active-Active database with RediSearch 2.x enabled.
1. Create an Active-Active database with RediSearch 2.x enabled. Active-Active databases created with or upgraded to Redis version 8 or later automatically enable search and query.
1. [Create the index]({{< relref "commands/ft.create" >}}) on each instance of the database.
1. If you are using [synonyms]({{< relref "/develop/ai/search-and-query/advanced-concepts/synonyms" >}}), you need to add them to each replica.
1. The index is maintained by each instance outside of the database keyspace, so only updates to the hashes in the databases are synchronized.
Expand Down
13 changes: 6 additions & 7 deletions content/operate/rs/databases/active-active/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,14 +134,13 @@ for this database. Minimum RAM is 10%. Maximum RAM is 50%.

- **Memory eviction** - The default [eviction policy]({{<relref "/operate/rs/databases/memory-performance/eviction-policy">}}) for Active-Active databases is `noeviction`. Redis Enterprise versions 6.0.20 and later support all eviction policies for Active-Active databases, unless [Auto Tiering]({{<relref "/operate/rs/databases/auto-tiering">}}) is enabled.

- [**Capabilities**]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}}) (previously **Modules**) - When you create a new in-memory database, you can enable multiple Redis Stack capabilities in the database. For Auto Tiering databases, you can enable capabilities that support Auto Tiering. See [Redis Enterprise and Redis Stack feature compatibility
- [**Capabilities**]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}}) (previously **Modules**) - When you create a new in-memory database, you can enable additional capabilities in the database. You cannot enable them after database creation.

Active-Active databases created with or upgraded to Redis version 8 or later automatically enable [search and query]({{<relref "/operate/oss_and_stack/stack-with-enterprise/search/search-active-active">}}) and [JSON]({{<relref "/operate/oss_and_stack/stack-with-enterprise/json">}}), which allows you to index, query, and perform full-text searches of nested JSON documents.

For Auto Tiering databases, you can enable capabilities that support Auto Tiering. See [Redis Enterprise and Redis Stack feature compatibility
]({{< relref "/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities" >}}) for compatibility details.

{{<note>}}
To use Redis Stack capabilities, enable them when you create a new database.
You cannot enable them after database creation.
{{</note>}}


To add capabilities to the database:

1. In the **Capabilities** section, select one or more capabilities.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To use JSON in an Active-Active database, you must enable JSON during database c

Active-Active Redis Cloud databases add JSON by default. See [Create an Active-Active subscription]({{< relref "/operate/rc/databases/create-database/create-active-active-database#select-capabilities" >}}) in the Redis Cloud documentation for details.

In Redis Enterprise Software, JSON is not enabled by default for Active-Active databases. See [Create an Active-Active JSON database]({{< relref "/operate/oss_and_stack/stack-with-enterprise/json/active-active#create-an-active-active-json-database" >}}) in the Redis Stack and Redis Enterprise documentation for instructions.
In Redis Enterprise Software, Active-Active databases created with or upgraded to Redis version 8 or later automatically enable JSON. For earlier Redis versions, see [Create an Active-Active JSON database]({{< relref "/operate/oss_and_stack/stack-with-enterprise/json/active-active#create-an-active-active-json-database" >}}) in the Redis Stack and Redis Enterprise documentation for instructions.

{{<embed-md "json-active-active-command-differences.md">}}

Expand Down
6 changes: 3 additions & 3 deletions content/operate/rs/databases/active-active/planning.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ See [Synchronizing cluster node clocks]({{< relref "/operate/rs/clusters/configu
## Redis modules {#redis-modules}

Several Redis modules are compatible with Active-Active databases. Find the list of [compatible Redis modules]({{< relref "/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities" >}}).
{{< note >}}
Starting with v6.2.18, you can index, query, and perform full-text searches of nested JSON documents in Active-Active databases by combining RedisJSON and RediSearch.
{{< /note >}}

Active-Active databases created with or upgraded to Redis version 8 or later automatically enable [search and query]({{<relref "/operate/oss_and_stack/stack-with-enterprise/search/search-active-active">}}) and [JSON]({{<relref "/operate/oss_and_stack/stack-with-enterprise/json">}}), which allows you to index, query, and perform full-text searches of nested JSON documents.


## Limitations

Expand Down
4 changes: 4 additions & 0 deletions content/operate/rs/databases/configure/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@ after the database is created.

When you create a new in-memory database, you can enable multiple Redis Stack [**Capabilities**]({{<relref "/operate/oss_and_stack/stack-with-enterprise">}}).

Databases created with or upgraded to Redis version 8 or later automatically enable the capabilities (modules) bundled with Redis Enterprise Software as follows:

{{<embed-md "rs-8-enabled-modules.md">}}

For Auto Tiering databases, you can enable capabilities that support Auto Tiering. See [Redis Enterprise and Redis Stack feature compatibility
]({{< relref "/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities" >}}) for compatibility details.

Expand Down
4 changes: 4 additions & 0 deletions content/operate/rs/databases/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@ To quickly create a database and skip additional configuration options during in

- Capabilities (previously modules) to enable

Databases created with Redis version 8 or later automatically enable the capabilities (modules) bundled with Redis Enterprise Software as follows:

{{<embed-md "rs-8-enabled-modules.md">}}

1. Optionally select **Full options** to configure [additional settings]({{< relref "/operate/rs/databases/configure#config-settings" >}}).

1. Select **Create**.
Expand Down
Loading