Skip to content

DOC-7089: Migrate remaining content/operate/oss_and_stack/stack-with-enterprise/ (install, timeseries, bloom, search, json) to render hooks #4071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andy-stark-redis merged 1 commit into from
Sep 22, 2026
Merged

DOC-7089: Migrate remaining content/operate/oss_and_stack/stack-with-enterprise/ (install, timeseries, bloom, search, json) to render hooks #4071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion content/operate/oss_and_stack/stack-with-enterprise/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ aliases:
- /operate/modules
---

[Redis Software]({{< relref "/operate/rs" >}}) and [Redis Cloud]({{< relref "/operate/rc" >}}) support all [Redis Open Source]({{< relref "/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities" >}}) features. Some of the capabilities Redis Open Source provides include querying, indexing, and full-text search and support for JSON, time series, and probabilistic data structures.
[Redis Software](/content/operate/rs/_index.md) and [Redis Cloud](/content/operate/rc/_index.md) support all [Redis Open Source](/content/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities.md) features. Some of the capabilities Redis Open Source provides include querying, indexing, and full-text search and support for JSON, time series, and probabilistic data structures.
6 changes: 3 additions & 3 deletions content/operate/oss_and_stack/stack-with-enterprise/bloom/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ reach a larger capacity.

## More info

- [Probabilistic data structures quick start]({{< relref "/develop/data-types/probabilistic/bloom-filter" >}})
- [Probabilistic data structure commands]({{< relref "/operate/oss_and_stack/stack-with-enterprise/bloom/commands" >}})
- [Probabilistic data structure configuration]({{< relref "/operate/oss_and_stack/stack-with-enterprise/bloom/config" >}})
- [Probabilistic data structures quick start](/content/develop/data-types/probabilistic/bloom-filter.md)
- [Probabilistic data structure commands](/content/operate/oss_and_stack/stack-with-enterprise/bloom/commands.md)
- [Probabilistic data structure configuration](/content/operate/oss_and_stack/stack-with-enterprise/bloom/config.md)
- [RedisBloom source](https://github.com/RedisBloom/RedisBloom/)
88 changes: 44 additions & 44 deletions content/operate/oss_and_stack/stack-with-enterprise/bloom/commands.md
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions content/operate/oss_and_stack/stack-with-enterprise/bloom/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ weight: 30

## Configure probabilistic data structures in Redis Software

[Redis Software]({{< relref "/operate/rs" >}}) lets you manually change any [RedisBloom configuration setting]({{< relref "/develop/data-types/probabilistic/" >}}configuration/#redisbloom-configuration-parameters).
[Redis Software](/content/operate/rs/_index.md) lets you manually change any [RedisBloom configuration setting](/content/develop/data-types/probabilistic/configuration.md#redisbloom-configuration-parameters).

To change the RedisBloom configuration using the Redis Software Cluster Manager UI:

Expand All @@ -29,8 +29,8 @@ To change the RedisBloom configuration using the Redis Software Cluster Manager

## Configure probabilistic data structures in Redis Cloud

[Redis Cloud]({{< relref "/operate/rc" >}}) does not let you configure RedisBloom manually. However, if you have a Flexible or Annual [subscription]({{< relref "/operate/rc/subscriptions" >}}), you can contact [support](https://redis.com/company/support/) to request a configuration change. You cannot change RedisBloom configuration for Free or Fixed subscriptions.
[Redis Cloud](/content/operate/rc/_index.md) does not let you configure RedisBloom manually. However, if you have a Flexible or Annual [subscription](/content/operate/rc/subscriptions/_index.md), you can contact [support](https://redis.com/company/support/) to request a configuration change. You cannot change RedisBloom configuration for Free or Fixed subscriptions.

## Configuration settings

See [configuration parameters]({{< relref "/develop/data-types/probabilistic/configuration" >}}) in the Develop section for parameter details and compatibility with Redis Software and Redis Cloud.
See [configuration parameters](/content/develop/data-types/probabilistic/configuration.md) in the Develop section for parameter details and compatibility with Redis Software and Redis Cloud.
20 changes: 10 additions & 10 deletions content/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ The following table shows which Redis Open Source features are supported by Redi

| Feature | Redis<br/>Software | Redis<br/>Cloud |
|:-------|:-------------------------|:-----------------------|
| [Redis Search]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search" >}}) | &#x2705; Supported | &#x2705; Supported |
| [JSON]({{< relref "/operate/oss_and_stack/stack-with-enterprise/json" >}}) | &#x2705; Supported | &#x2705; Supported |
| [Time series]({{< relref "/operate/oss_and_stack/stack-with-enterprise/timeseries" >}}) | &#x2705; Supported | &#x2705; Supported |
| [Probabilistic]({{< relref "/operate/oss_and_stack/stack-with-enterprise/bloom" >}}) | &#x2705; Supported | &#x2705; Supported |
| [Gears]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1" >}}) | &#x2705; Supported | &#x274c; Not supported |
| [Triggers and functions]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/" >}}) | &#x26A0;&#xFE0F; Deprecated | &#x26A0;&#xFE0F; Deprecated |
| [Graph]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph" >}}) | &#x26A0;&#xFE0F; Deprecated | &#x26A0;&#xFE0F; Deprecated |
| [Redis Search](/content/operate/oss_and_stack/stack-with-enterprise/search/_index.md) | &#x2705; Supported | &#x2705; Supported |
| [JSON](/content/operate/oss_and_stack/stack-with-enterprise/json/_index.md) | &#x2705; Supported | &#x2705; Supported |
| [Time series](/content/operate/oss_and_stack/stack-with-enterprise/timeseries/_index.md) | &#x2705; Supported | &#x2705; Supported |
| [Probabilistic](/content/operate/oss_and_stack/stack-with-enterprise/bloom/_index.md) | &#x2705; Supported | &#x2705; Supported |
| [Gears](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/_index.md) | &#x2705; Supported | &#x274c; Not supported |
| [Triggers and functions](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/_index.md) | &#x26A0;&#xFE0F; Deprecated | &#x26A0;&#xFE0F; Deprecated |
| [Graph](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/_index.md) | &#x26A0;&#xFE0F; Deprecated | &#x26A0;&#xFE0F; Deprecated |


## Feature compatibility
Expand All @@ -36,7 +36,7 @@ Version numbers indicate when the feature was first supported. If you're using

For details about individual features, see the corresponding documentation.

| Feature name/capability | [Redis Search]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search" >}}) | [JSON]({{< relref "/operate/oss_and_stack/stack-with-enterprise/json" >}}) |
| Feature name/capability | [Redis Search](/content/operate/oss_and_stack/stack-with-enterprise/search/_index.md) | [JSON](/content/operate/oss_and_stack/stack-with-enterprise/json/_index.md) |
|---------------------------|:--------------:|:------------:|
| Active-Active (CRDB)[^5] | Yes (v2.0) | Yes (v2.2) |
| Backup/Restore | Yes (v1.4) | Yes (v1.0) |
Expand All @@ -57,15 +57,15 @@ For details about individual features, see the corresponding documentation.

[^2]: RediSearch version 1.6 supported Replica Of only between databases with the same number of shards. This limitation was fixed in v2.0.

[^3]: You cannot use Redis Search with the [OSS Cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api" >}}). This limitation was fixed in Redis Software version 8.0.
[^3]: You cannot use Redis Search with the [OSS Cluster API](/content/operate/rs/databases/configure/oss-cluster-api.md). This limitation was fixed in Redis Software version 8.0.

[^4]: You currently cannot combine Auto Tiering with Redis Open Source features in Redis Cloud.

[^5]: With the exception of JSON, you currently cannot combine Active-Active with Redis Open Source features in Redis Cloud.

[^6]: Although time series are compatible with Auto Tiering, the entire series either lives in RAM or on flash.

| Feature name/capability | [Time series]({{< relref "/operate/oss_and_stack/stack-with-enterprise/timeseries" >}}) | [Probabilistic]({{< relref "/operate/oss_and_stack/stack-with-enterprise/bloom" >}}) | [Gears]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1" >}}) |
| Feature name/capability | [Time series](/content/operate/oss_and_stack/stack-with-enterprise/timeseries/_index.md) | [Probabilistic](/content/operate/oss_and_stack/stack-with-enterprise/bloom/_index.md) | [Gears](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/_index.md) |
|--------------------------|:--------------:|:------------:|:----------:|
| Active-Active (CRDB)[^5] | No | No | Yes (v1.0) |
| Backup/Restore | Yes (v1.2) | Yes (v2.0) | Yes (v1.0) |
Expand Down
6 changes: 3 additions & 3 deletions content/operate/oss_and_stack/stack-with-enterprise/install/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ linkTitle: Install and upgrade modules
weight: 4
---

Several modules that provide additional Redis capabilities, such as Redis Search, JSON, time series, and probabilistic data structures, come packaged with [Redis Software]({{< relref "/operate/rs" >}}). As of version 8.0, Redis Software includes multiple feature sets, compatible with different Redis database versions.
Several modules that provide additional Redis capabilities, such as Redis Search, JSON, time series, and probabilistic data structures, come packaged with [Redis Software](/content/operate/rs/_index.md). As of version 8.0, Redis Software includes multiple 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.
1. [Install a module package](/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster.md) on the cluster.
1. [Enable a module](/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database.md) for a new database or [upgrade a module](/content/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module.md) in an existing database.

## Automatically enabled capabilities in Redis 8

Expand Down
30 changes: 14 additions & 16 deletions ...nt/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,12 @@ linkTitle: Install on a cluster
weight: 10
---

[Redis Software]({{< relref "/operate/rs" >}}) comes packaged with several modules that provide additional Redis capabilities such as [Redis Search]({{<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 Software includes multiple 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 Software](/content/operate/rs/_index.md) comes packaged with several modules that provide additional Redis capabilities such as [Redis Search](/content/operate/oss_and_stack/stack-with-enterprise/search/_index.md), [JSON](/content/operate/oss_and_stack/stack-with-enterprise/json/_index.md), [time series](/content/operate/oss_and_stack/stack-with-enterprise/timeseries/_index.md), and [probabilistic data structures](/content/operate/oss_and_stack/stack-with-enterprise/bloom/_index.md). As of version 8.0, Redis Software includes multiple 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 Software.
{{</warning>}}
> [!WARNING]
> Some module versions are not supported or recommended for use with Redis Software.

## Module package requirements

Expand All @@ -34,7 +33,7 @@ The module must be packaged as a `.zip` file containing:

## Get packaged modules

To install or upgrade a module on a [Redis Software]({{< relref "/operate/rs" >}}) cluster, you need a module package.
To install or upgrade a module on a [Redis Software](/content/operate/rs/_index.md) cluster, you need a module package.

- For versions of official Redis modules that are not available from the [Redis download center](https://redis.io/downloads/), [contact support](https://redis.io/support/).

Expand All @@ -44,7 +43,7 @@ To install or upgrade a module on a [Redis Software]({{< relref "/operate/rs" >}

## Add user-defined modules during bootstrapping (Redis Software v8.0.6 and later) {#bootstrap-user-defined-module}

As of Redis Software version 8.0.6, you can include `user_defined_modules` in REST API requests to [initiate boostrap operations]({{<relref "/operate/rs/references/rest-api/requests/bootstrap#post-bootstrap">}}) such as `create_cluster`, `join_cluster`, or `recover_cluster`. Each node in the cluster independently downloads and installs the specified modules during its bootstrap process.
As of Redis Software version 8.0.6, you can include `user_defined_modules` in REST API requests to [initiate boostrap operations](/content/operate/rs/references/rest-api/requests/bootstrap/_index.md#post-bootstrap) such as `create_cluster`, `join_cluster`, or `recover_cluster`. Each node in the cluster independently downloads and installs the specified modules during its bootstrap process.

`user_defined_modules` has the following JSON schema:

Expand Down Expand Up @@ -275,7 +274,7 @@ If you see `"module.json missing"` errors:

To add a custom module to a cluster running Redis 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.
1. [Upload the custom module configuration](/content/operate/rs/references/rest-api/requests/modules/user-defined.md#post-user-defined-module). Replace the values in the following example with your own.

```sh
POST https://<host>:<port>/v2/modules/user-defined
Expand All @@ -300,7 +299,7 @@ To add a custom module to a cluster running Redis Software version 8.0.x or late
}
```

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

```sh
POST https://<host>:<port>/v2/local/modules/user-defined/artifacts
Expand Down Expand Up @@ -331,7 +330,7 @@ To add a module to the cluster using the REST API:

1. Copy the module package to a node in the cluster.

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:
1. Add the module to the cluster with a [`POST` request to the `/v2/modules`](/content/operate/rs/references/rest-api/requests/modules/_index.md#post-module-v2) endpoint:

```sh
POST https://<host>:<port>/v2/modules
Expand All @@ -340,17 +339,16 @@ To add a module to the cluster using the REST API:

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.
1. If the module installation succeeds, the `POST` request returns a [JSON object](/content/operate/rs/references/rest-api/objects/module.md) that represents the new module. If it fails, it may return a JSON object with an `error_code` and `description` with more details.

{{< /multitabs >}}

For RedisGears, follow these [installation instructions]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears" >}}) instead.
For RedisGears, follow these [installation instructions](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears.md) instead.

{{<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>}}
> [!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.

## Next steps

- Create a database and [enable the new module]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database" >}}).
- [Upgrade a module]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module" >}}) to the new version.
- Create a database and [enable the new module](/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database.md).
- [Upgrade a module](/content/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module.md) to the new version.
22 changes: 11 additions & 11 deletions ...t/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ You can only add modules to a database when you first create it. You cannot add

### 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
- [Installed the module on the cluster](/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster.md)
- [Upgraded the module](/content/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module.md) to the latest version

### Create a database and enable capabilities

Expand All @@ -38,9 +38,9 @@ In the Redis Software Cluster Manager UI, follow these steps to add modules to a

{{<image filename="images/rs/screenshots/databases/quick-db-capabilities-7-8-2.png" alt="Select which capabilities to add to your database.">}}

{{<note>}}
You cannot use RediSearch 1.x and RediSearch 2.x in the same database.
{{</note>}}
> [!NOTE]
> You cannot use RediSearch 1.x and RediSearch 2.x in the same database.
>

1. To use custom configuration for capabilities:

Expand All @@ -52,16 +52,16 @@ You cannot use RediSearch 1.x and RediSearch 2.x in the same database.

1. Configure additional database settings.

{{<note>}}
Depending on the [features supported by an enabled module]({{< relref "/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities#module-feature-support" >}}), certain database configuration fields may not be available.
{{</note>}}
> [!NOTE]
> Depending on the [features supported by an enabled module](/content/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities.md#module-feature-support), certain database configuration fields may not be available.
>

1. Select **Create**.

## Module configuration options

- [Redis Search configuration options]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search/config" >}})
- [Redis Search configuration options](/content/operate/oss_and_stack/stack-with-enterprise/search/config.md)

- [RedisTimeSeries configuration options]({{< relref "/operate/oss_and_stack/stack-with-enterprise/timeseries/config" >}})
- [RedisTimeSeries configuration options](/content/operate/oss_and_stack/stack-with-enterprise/timeseries/config.md)

- [RedisBloom configuration options]({{< relref "/operate/oss_and_stack/stack-with-enterprise/bloom/config" >}})
- [RedisBloom configuration options](/content/operate/oss_and_stack/stack-with-enterprise/bloom/config.md)
Loading
Loading