Skip to content
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.

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

Redis feature set table #1008

Merged
merged 11 commits into from
Jan 24, 2025
9 changes: 9 additions & 0 deletions content/embeds/redis-feature-sets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
A Redis feature set includes a specific Redis database version along with the advanced capabilities and data structures provided by compatible module versions.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a caveat here: Redis CE doesn't include the advanced capabilities by default. Customers will either have to download and install them separately, or use Redis Stack. This, of course, will go away when CE8 ships, essentially replacing both standalone Redis CE and Redis Stack.

So, really, this just applies to RS, RC, and Redis Stack.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest using something like this to not mention advanced capabilities and data structures to be ready for CE8.


A Redis feature set represents the complete set of features available in a specific configuration, and its version number increments whenever a new feature is introduced.

To use a new feature introduced in a later feature set, you must upgrade to the corresponding feature set version, as outlined in the table below.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct. We can add that in if you like. I don't think users are consuming modules separately often. We see in the field customers running redis-stack in production

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rrelledge , what do you think about this wording?

A Redis feature set represents the complete set of features available in a specific configuration, and its version number increments whenever a new feature is introduced.

To use a new feature introduced in a later feature set, you must upgrade to the corresponding feature set version, as outlined in the table below.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ViktarStarastsenka
I'm fine with changing the feature set description, but I'm not sure about the phrase "specific configuration".

What do you think of something like:
"A Redis feature set represents the complete set of features available for a specific Redis version."

I don't think it's necessary to explain "its version number increments whenever a new feature is introduced".

I changed the last sentence to: "To use a new feature introduced in a later feature set, you must upgrade the corresponding components according to the following table."

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, specific configuration sounds like something different than version.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The suggestion is to locate the feature sets under the “Commands” section since basically commands are introduced or their behavior is changed with the feature sets

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we can easily include a separate, non-command page under the commands section at this time. The commands section uses layouts that work differently from the rest of the site. It did not work at all when I made a cursory attempt in my local env. I don't think it's a simple change, and we definitely want to be careful with the commands section.

cc @dwdougherty since you are more familiar with the commands section than me.


A database is not compatible with module versions from different feature set versions. If you want to use advanced capability features or data structures introduced by a later feature set version, you must upgrade your database to the compatible Redis version and module versions according to the following table.

| Redis feature set version | Distributed in | What's new |
Copy link
Contributor

@ViktarStarastsenka ViktarStarastsenka Dec 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we do not actually need the "Distributed in" column at all - we can reference the feature set version from everywhere (e.g. release notes in RS, Redis Cloud, etc.)
and it will make the table smaller

though I'd suggest creating a separate "Compatible versions" column, where we describe the Redis server version and modules (and just the Redis version with CE8)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ViktarStarastsenka I updated the staged previews of the table with your suggested changes.

I also added the table to the Cloud changelog: https://redis.io/docs/staging/DOC-4673/operate/rc/changelog/
cc @cmilesb , are you okay with this addition?

|-------------------|----------------|------------|
| 7.4 | [Redis Cloud]({{<relref "/operate/rc">}})<br />[Redis Software]({{<relref "/operate/rs">}}) 7.8.x<br />[Redis Stack]({{<relref "/operate/oss_and_stack">}}) 7.4.x<br />[Redis Community Edition]({{<relref "/operate/oss_and_stack">}}) 7.4.x | Hash field expiration; new vector data types; time series insertion filters<br /><br />Compatible versions:<br />[Redis 7.4]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisce/redisce-7.4-release-notes.md">}})<br />[Search 2.10]({{< relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-2.10-release-notes.md" >}})<br />[JSON 2.8]({{<relref "operate/oss_and_stack/stack-with-enterprise/release-notes/redisjson/redisjson-2.8-release-notes.md">}})<br />[Time series 1.12]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.12-release-notes.md">}})<br />[Bloom 2.8]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisbloom/redisbloom-2.8-release-notes.md">}}) |
| 7.2 | [Redis Cloud]({{<relref "/operate/rc">}})<br />[Redis Software]({{<relref "/operate/rs">}}) 7.2.x-7.8.x<br />[Redis Stack]({{<relref "/operate/oss_and_stack">}}) 7.2.x<br />[Redis OSS]({{<relref "/operate/oss_and_stack">}}) 7.2.x | `WAITAOF`; memory and speed optimizations for lists, sets, and sorted sets; RESP3 support; new RDB file format; geo polygon search; performance improvements for sorted search and queries; new JSON commands<br /><br />Compatible versions:<br />[Redis 7.2](https://raw.githubusercontent.com/redis/redis/7.2/00-RELEASENOTES)<br />[Search 2.8]({{< relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-2.8-release-notes.md" >}})<br />[JSON 2.6]({{<relref "operate/oss_and_stack/stack-with-enterprise/release-notes/redisjson/redisjson-2.6-release-notes.md">}})<br />[Time series 1.10]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.10-release-notes.md">}})<br />[Bloom 2.6]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisbloom/redisbloom-2.6-release-notes.md">}})<br />[Gears 2.0](https://github.com/RedisGears/RedisGears/releases) |
| 6.2 | [Redis Cloud]({{<relref "/operate/rc">}})<br />[Redis Software]({{<relref "/operate/rs">}}) 6.2.x-7.8.x<br />[Redis Stack]({{<relref "/operate/oss_and_stack">}}) 6.2.x<br />[Redis OSS]({{<relref "/operate/oss_and_stack">}}) 6.2.x | Wildcard queries for `TEXT` and `TAG`; suffix search; multi-value indexing and queries; improved JSON path parser; new probabilistic data structure t-digest; new pathfinding algorithms for graphs; time series gap filling<br /><br />Compatible versions:<br />[Redis 6.2](https://raw.githubusercontent.com/redis/redis/6.2/00-RELEASENOTES)<br />[Search 2.6]({{< relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-2.6-release-notes.md" >}})<br />[JSON 2.4]({{<relref "operate/oss_and_stack/stack-with-enterprise/release-notes/redisjson/redisjson-2.4-release-notes.md">}})<br />[Time series 1.8]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.8-release-notes.md">}})<br />[Bloom 2.4]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisbloom/redisbloom-2.4-release-notes.md">}})<br />[Graph 2.10]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-2.10-release-notes.md">}}) |
6 changes: 5 additions & 1 deletion content/operate/oss_and_stack/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,8 @@
title: Redis Community Edition and Stack
description: Operate Redis Community Edition and Redis Stack. Redis OSS was renamed Redis Community Edition (CE) with the v7.4 release.
linkTitle: Redis Community Edition and Stack
---
---

## Redis feature sets

{{<embed-md "redis-feature-sets.md">}}
4 changes: 4 additions & 0 deletions content/operate/oss_and_stack/stack-with-enterprise/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,7 @@ aliases:
---

[Redis Enterprise Software]({{< relref "/operate/rs" >}}) and [Redis Cloud]({{< relref "/operate/rc" >}}) support all [Redis Stack]({{< relref "/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities" >}}) features, which extend the core Redis feature set. Some of the capabilities Redis Stack provides include querying, indexing, and full-text search and support for JSON, time series, and probabilistic data structures.

## Redis feature sets

{{<embed-md "redis-feature-sets.md">}}
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,18 @@ categories:
- docs
- operate
- stack
description: Redis Stack and modules release notes
description: Release notes for Redis Community Edition, Redis Stack, and modules
hideListLinks: true
linkTitle: Release notes
weight: 99
---

## Redis feature sets

{{<embed-md "redis-feature-sets.md">}}

## Release notes

See the following release notes for new features, enhancements, and other changes to Redis Stack capabilities.

{{<table-children columnNames="Release notes,Description" columnSources="LinkTitle,Description" enableLinks="LinkTitle" limitTags="visible">}}
11 changes: 9 additions & 2 deletions content/operate/rs/release-notes/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
Title: Release notes
Title: Redis Software release notes
linkTitle: Release notes
alwaysopen: false
categories:
- docs
Expand All @@ -10,6 +11,12 @@ hideListLinks: true
weight: 90
---

Here's what changed recently in Redis Enterprise Software:
## Redis feature sets

{{<embed-md "redis-feature-sets.md">}}

## Release notes

Here's what changed recently in Redis Software:

{{< table-children columnNames="Version&nbsp;(Release&nbsp;date)&nbsp;,Major changes,Redis CE compatibility" columnSources="LinkTitle,Description,compatibleOSSVersion" enableLinks="LinkTitle" >}}
Loading