Redis Software release notes 7.8.2-34 (November 2024)

Redis Community Edition 7.4 features. Hash field expiration. Client-side caching support. Metrics stream engine preview. New APIs to check database availability, rebalance shards, fail over shards, and control database traffic. Cluster Manager UI enhancements for node actions, database tags, and database configuration. User manager role. Log rotation based on both size and time. Module management enhancements. Configurable minimum password length. Configurable license expiration alert threshold.

​​Redis Software version 7.8.2 is now available!

Highlights

This version offers:

• Redis Community Edition 7.4 features

• Hash field expiration

• Client-side caching support

• Metrics stream engine preview

• New APIs to check database availability, rebalance shards, fail over shards, and control database traffic

• Cluster Manager UI enhancements for node actions, database tags, and database configuration

• User manager role

• Log rotation based on both size and time

• Module management enhancements

• Configurable minimum password length

• Configurable license expiration alert threshold

New in this release

New features

• Redis Community Edition and Redis Stack 7.4 features are now available when you create or upgrade a database with database version 7.4, including:

  • Hash field expiration

  • New vector data types to reduce ‌memory usage

  • Time series insertion filters

  • See the Redis 7.4 release blog post and Redis Community Edition 7.4 release notes for details.

• Client-side caching support:

  • Client-side caching allows Redis clients to store a subset of data in a local cache and avoid sending repeated read requests to the Redis database.

  • When used to cache frequently accessed data, this technique can improve performance by decreasing network traffic, latency, and load on the database.

  • Supported for Redis databases with Redis versions 7.4 and later.

  • For more information, see the client-side caching introduction and client-side caching compatibility with Redis Software.

• Database availability API:

  • Verifies whether a Redis Software database is available to perform read and write operations and can respond to queries from client applications.

  • Load balancers and automated monitoring tools can use this API to monitor database availability.

  • See Check database availability and the REST API reference for details.

• Metrics stream engine preview:

  • The new metrics stream engine's exporter-based infrastructure provides access to more accurate, real-time data. This enhanced, scalable monitoring system allows you to set up more effective alerts and respond to issues faster.

  • Exposes a new /v2 Prometheus scraping endpoint that you can use to export metrics to external monitoring tools such as Grafana, DataDog, NewRelic, and Dynatrace.

  • Exports raw data instead of aggregated data to improve monitoring at scale and accuracy compared to v1 Prometheus metrics.

  • For an initial list of metrics exported by the new metrics stream engine, see Prometheus metrics v2. While the metrics stream engine is in preview, this document provides only a partial list. More metrics will be added.

  • V1 Prometheus metrics are deprecated. To transition to the new metrics stream engine, either migrate your existing dashboards using Prometheus v1 metrics and equivalent v2 PromQL now, or wait to use new preconfigured dashboards when they become available in a future release.

• Rebalance shard placement REST API request, which distributes the database's shards across nodes based on the database's shard placement policy. See Shard placement policy for more information about shard placement and available policies.

• Shard failover REST API requests, which perform failover on specified primary shards and promotes their replicas to primary shards.

• REST API requests to stop traffic or resume traffic to a database.

Enhancements

• New Cluster Manager UI enhancements:

  • Perform node actions from the Nodes screen to verify nodes, set a node as primary or secondary, remove nodes, and manage node alert settings.

  • Categorize databases with custom tags. When you add new tags to a database, the keys and values already used by existing tags will appear as suggestions.

  • Moved several settings on the database configuration screen:

    • The eviction setting now appears in the Capacity section.

    • High availability and Durability have separate sections.

  • Improved error messages on the sign-in screen for locked out users versus incorrect or expired passwords.

  • Flush an Active-Active database.

• A new User Manager role designed for user administration is available for role-based access control.

  • This management role allows assigned users to create, edit, and delete users using the Cluster Manager UI and REST API.

  • For more details about the privileges granted by the User Manager role, see Cluster Manager UI permissions and REST API permissions.

• When you upgrade a database, the upgrade process also attempts to upgrade database modules by default.

  • rladmin upgrade db will always upgrade the database's modules.

  • If you upgrade a database using the REST API, you can set "latest_with_modules": false in the request body to prevent module upgrades.

• Added support for log rotation based on both size and time.

• Minimum password length, previously hardcoded as 8 characters, is now configurable in the Cluster Manager UI and the REST API.

• The cluster license expiration alert threshold, which determines how far in advance you want to be notified of the license expiration, is configurable in the Cluster Manager UI and the REST API.

• The Cluster Manager UI's time zone can be configured with an update CM settings REST API request.

• Timeouts for raising connection alarms can be configured with an update database configuration REST API request:

  • crdt_sync_connection_alarm_timeout_seconds: if the syncer takes longer than the specified number of seconds to connect to an Active-Active database, raise a connection alarm.

  • replica_sync_connection_alarm_timeout_seconds: if the syncer takes longer than the specified number of seconds to connect to a replica, raise a connection alarm.

• Reserved the following ports:

  Port	Process name	Usage
  3347	cert_exporter	Reports cluster certificate metrics
  3348	process_exporter	Reports process metrics for DMC and Redis processes
  3349	cluster_wd_exporter	Reports cluster watchdog metrics
  3350	db_controller	Internode communication
  9091	node_exporter	Reports host node metrics related to CPU, memory, disk, and more
  9125	statsd_exporter	Reports push metrics related to the DMC and syncer, and some cluster and node metrics

Redis database versions

Redis Software version 7.8.2 includes three Redis database versions: 7.4, 7.2, and 6.2.

The default Redis database version is 7.4.

Redis module feature sets

Redis Software comes packaged with several modules. As of version 7.8.2, Redis Software includes three feature sets, compatible with different Redis database versions.

The following table shows which Redis modules are compatible with each Redis database version included in this release.

1. RedisGraph end-of-life has been announced and will be removed in a future release. See the RedisGraph end-of-life announcement for more details.

Resolved issues

• RS123645: Fixed inconsistent behavior for shard creation when you enable sharding. Now, when creating a database with sharding enabled, you must always provide a shard_key_regex.

• RS130444: Fixed an issue that prevented creating or editing users without an email address in the Cluster Manager UI.

• RS121796: The "multiple endpoint" configuration database default setting should also enable sharding when selected.

• RS128768: Fixed an issue that prevented metric graph timestamp details from displaying in the Cluster Manager UI.

• RS127120: Fixed an issue where crdt_replicas were not properly updated when flushing an Active-Active database.

• RS127054: Fixed an issue where the install script incorrectly reported "Port 53 is occupied" instead of the correct value of the occupied port.

• RS125934: Fixed validation that prevented updating the Active-Active database configuration if existing TLS certificates expired.

• RS125412: Fixed an issue where deleted external IP addresses were still listed as available during node configuration when joining a cluster.

• RS122012: Fixed an issue that sent a cutoff email message for long-running alerts.

• RS121726: Block the remove_shards option for rlutil. You can use Replica Of to decrease the shard count instead.

• RS121076: Added a 5-minute connection timeout when promoting a replica shard to a primary role.

• RS118103: Removed the inaccurate shard BACKUP_PROGRESS column from the rladmin status command's output.

• RS116990: Fixed an issue with flash-enabled databases where FLUSHDB could cause shard crashes in versions 7.0 and 7.2, and cause clients to stop responding in earlier versions.

• RS114923: Fixed an issue where the legacy RDB parser could generate an XGROUP CREATE command with an incorrect ENTRIESREAD value when syncing a source RDB to a database with Redis version 7.0 or later.

• RS114258: Fixed an issue where an Active-Active database instance could lose keys during partial syncing if the destination shard was stale.

• RS133653: Fixed a validation issue where expired client certificates prevented updates to database configuration unrelated to TLS.

• RS126235: Fixed an issue where database updates could time out and enter a change pending state due to outdated shard data.

• RS125128: Improved real-time logging for installation and upgrade for better visibility.

• RS119958: Removed the log file limit that caused the debuginfo script to fail with the error "/bin/tar: Argument list too long" in Auto Tiering clusters and improved RocksDB log file rotation.

• RS137396: Providing an email address is no longer mandatory when creating new ACL users in the Cluster Manager UI.

• RS134238: Improved database sorting performance in the Cluster Manager UI.

• RS129418: Improved log rotation mechanism for Auto Tiering clusters to reduce excessive logs.

• RS137231: Fixed an issue where database shards could become stuck during migration due to outdated node data.

Version changes

• Added validation to verify the LDAP server URI contains a host and port when updating LDAP configuration.

• The value of the oss_sharding API field had no effect in previous versions of Redis Software. However, oss_sharding is now set to take effect as part of future plans. Until further notice, set this field to false to avoid unintended impacts.

Breaking changes

Redis Software version 7.8.2 introduces the following breaking changes:

• When you upgrade a database, the upgrade process also attempts to upgrade database modules by default.

  • The default value of latest_with_modules has changed to true.

  • rladmin upgrade db will always upgrade the database's modules.

  • When you upgrade a database using the REST API, you can set "latest_with_modules": false in the request body to prevent module upgrades.

Redis database version 7.4 breaking changes

When new major versions of Redis Community Edition change existing commands, upgrading your database to a new version can potentially break some functionality. Before you upgrade, read the provided list of breaking changes that affect Redis Software and update any applications that connect to your database to handle these changes.

Confirm your Redis database version (redis_version) using the Cluster Manager UI or run the following INFO command with redis-cli:

$ redis-cli -p <port> INFO
"# Server
redis_version:7.0.8
..."

Security behavior changes

• #13108 Lua: LRU eviction for scripts generated with EVAL.

Other general behavior changes

• #13133 Lua: allocate VM code with jemalloc instead of libc and count it as used memory.

• #12171 ACL LOAD: do not disconnect all clients.

Product lifecycle updates

End-of-life policy extension

The end-of-life policy for Redis Software versions 6.2 and later has been extended to 24 months after the formal release of the subsequent major version. For the updated end-of-life schedule, see the Redis Software product lifecycle.

Supported upgrade paths

Redis Software versions 6.2.4 and 6.2.8 do not support direct upgrades beyond version 7.4.x. Versions 6.2.10, 6.2.12, and 6.2.18 are part of the upgrade path. To upgrade from 6.2.4 or 6.2.8 to versions later than 7.4.x, an intermediate upgrade is required.

The next major Redis Software release will still bundle Redis database version 6.2 and allow database upgrades from Redis database version 6.2 to 7.x.

See the Redis Software product lifecycle for more information about release numbers.

End of triggers and functions preview

The triggers and functions (RedisGears) preview has been discontinued.

• Commands such as TFCALL, TFCALLASYNC, and TFUNCTION will be deprecated and will return error messages.

• Any JavaScript functions stored in Redis will be removed.

• JavaScript-based triggers will be blocked.

• Lua functions and scripts will not be affected.

If your database currently uses triggers and functions, you need to:

1. Adjust your applications to accommodate these changes.

2. Delete all triggers and functions libraries from your existing database:

   1. Run TFUNCTION LIST.

   2. Copy all library names.

   3. Run TFUNCTION DELETE for each library in the list.

   If any triggers and functions libraries remain in the database, the RDB snapshot won't load on a cluster without RedisGears.

3. Migrate your database to a new database without the RedisGears module.

Deprecations

API deprecations

• Deprecated background_op field from BDB REST API object. Use GET /v1/actions/bdb/<bdb_uid> instead.

• Deprecated the following fields for upgrade database REST API requests:

  • keep_redis_version; use redis_version instead

  • current_module; use new_module_args instead

  • new_module; use new_module_args instead

• Deprecated the following module_list fields for create database REST API requests:

  • module_id; use module_name instead

  • semantic_version; use module_args instead

• min_redis_version is only relevant to Redis database versions earlier than 7.4 and is replaced with compatible_redis_version in module REST API responses.

• Deprecated the rladmin upgrade modules command. Use rladmin upgrade db instead.

• Deprecated POST /v1/modules/upgrade/bdb/<uid> REST API request. Use POST /v1/bdbs/<uid>/upgrade to upgrade modules instead.

V1 Prometheus metrics deprecation

V1 Prometheus metrics are deprecated. To transition to the new metrics stream engine, either migrate your existing dashboards using Prometheus v1 metrics and equivalent v2 PromQL now, or wait to use new preconfigured dashboards when they become available in a future release.

Download center modules deprecation

New Redis modules will not be available for download from the Redis download center.

Legacy UI not supported

The legacy UI was deprecated in favor of the new Cluster Manager UI in Redis Software version 7.2.4 and is no longer supported as of Redis Software version 7.8.2.

Redis 6.0 databases not supported

Redis database version 6.0 was deprecated in Redis Software version 7.4.2 and is no longer supported as of Redis Software version 7.8.2.

To prepare for the removal of Redis database version 6.0 before you upgrade to Redis Software version 7.8.2:

• For Redis Software 6.2.* clusters, upgrade Redis 6.0 databases to Redis 6.2. See the Redis 6.2 release notes for the list of changes.

• For Redis Software 7.2.4 and 7.4.2 clusters, upgrade Redis 6.0 databases to Redis 7.2. Before you upgrade your databases, see the list of Redis 7.2 breaking changes and update any applications that connect to your database to handle these changes.

Ubuntu 18.04 not supported

Ubuntu 18.04 was deprecated in Redis Software version 7.2.4 and is no longer supported as of Redis Software version 7.8.2.

Upcoming changes

Default image change for Redis Software containers

Starting with version 7.8, Redis Software containers with the image tag x.y.z-build will be based on RHEL instead of Ubuntu.

This change will only affect you if you use containers outside the official Redis Enterprise for Kubernetes product and use Ubuntu-specific commands.

To use Ubuntu-based images after this change, you can specify the operating system suffix in the image tag. For example, use the image tag 7.4.2-216.focal instead of 7.4.2-216.

Supported platforms

The following table provides a snapshot of supported platforms as of this Redis Software release. See the supported platforms reference for more details about operating system compatibility.

✅ Supported – The platform is supported for this version of Redis Software and Redis Stack modules.

⚠️ Deprecation warning – The platform is still supported for this version of Redis Software, but support will be removed in a future release.

1. The RHEL-compatible distributions CentOS, CentOS Stream, Alma, and Rocky are supported if they have full RHEL compatibility. Oracle Linux running the Red Hat Compatible Kernel (RHCK) is supported, but the Unbreakable Enterprise Kernel (UEK) is not supported.

2. The server version of Ubuntu is recommended for production installations. The desktop version is only recommended for development deployments.

3. See the Redis Enterprise for Kubernetes documentation for details about support per version and Kubernetes distribution.

4. Docker images of Redis Software are certified for development and testing only.

5. Supported only if FIPS was enabled during RHEL installation to ensure FIPS compliance.

Downloads

The following table shows the SHA256 checksums for the available packages:

Known issues

• RS131972: Creating an ACL that contains a line break in the Cluster Manager UI can cause shard migration to fail due to ACL errors.

Known limitations

New Cluster Manager UI limitations

The following legacy UI features are not yet available in the new Cluster Manager UI:

• Purge an Active-Active instance.

  Use crdb-cli crdb purge-instance instead.

• Search and export the log.

RedisGraph prevents upgrade to RHEL 9

You cannot upgrade from a prior RHEL version to RHEL 9 if the Redis Software cluster contains a RedisGraph module, even if unused by any database. The RedisGraph module has reached End-of-Life and is completely unavailable in RHEL 9.

Security

Open source Redis security fixes compatibility

As part of Redis's commitment to security, Redis Software implements the latest security fixes available with open source Redis. Redis Software has already included the fixes for the relevant CVEs.

Some CVEs announced for open source Redis do not affect Redis Software due to different or additional functionality available in Redis Software that is not available in open source Redis.

Redis Software 7.8.2-34 supports open source Redis 7.4, 7.2, and 6.2. Below is the list of open source Redis CVEs fixed by version.

Redis 7.2.x:

• (CVE-2024-31449) An authenticated user may use a specially crafted Lua script to trigger a stack buffer overflow in the bit library, which may potentially lead to remote code execution.

• (CVE-2024-31228) An authenticated user can trigger a denial-of-service by using specially crafted, long string match patterns on supported commands such as KEYS, SCAN, PSUBSCRIBE, FUNCTION LIST, COMMAND LIST, and ACL definitions. Matching of extremely long patterns may result in unbounded recursion, leading to stack overflow and process crashes.

• (CVE-2023-41056) In some cases, Redis may incorrectly handle resizing of memory buffers, which can result in incorrect accounting of buffer sizes and lead to heap overflow and potential remote code execution.

• (CVE-2023-41053) Redis does not correctly identify keys accessed by SORT_RO and, as a result, may grant users executing this command access to keys that are not explicitly authorized by the ACL configuration. (Redis 7.2.1)

Redis 7.0.x:

• (CVE-2024-31449) An authenticated user may use a specially crafted Lua script to trigger a stack buffer overflow in the bit library, which may potentially lead to remote code execution.

• (CVE-2024-31228) An authenticated user can trigger a denial-of-service by using specially crafted, long string match patterns on supported commands such as KEYS, SCAN, PSUBSCRIBE, FUNCTION LIST, COMMAND LIST, and ACL definitions. Matching of extremely long patterns may result in unbounded recursion, leading to stack overflow and process crashes.

• (CVE-2023-41056) In some cases, Redis may incorrectly handle resizing of memory buffers, which can result in incorrect accounting of buffer sizes and lead to heap overflow and potential remote code execution.

• (CVE-2023-41053) Redis does not correctly identify keys accessed by SORT_RO and, as a result, may grant users executing this command access to keys that are not explicitly authorized by the ACL configuration. (Redis 7.0.13)

• (CVE-2023-36824) Extracting key names from a command and a list of arguments may, in some cases, trigger a heap overflow and result in reading random heap memory, heap corruption, and potentially remote code execution. Specifically: using COMMAND GETKEYS* and validation of key names in ACL rules. (Redis 7.0.12)

• (CVE-2023-28856) Authenticated users can use the HINCRBYFLOAT command to create an invalid hash field that will crash Redis on access. (Redis 7.0.11)

• (CVE-2023-28425) Specially crafted MSETNX commands can lead to assertion and denial-of-service. (Redis 7.0.10)

• (CVE-2023-25155) Specially crafted SRANDMEMBER, ZRANDMEMBER, and HRANDFIELD commands can trigger an integer overflow, resulting in a runtime assertion and termination of the Redis server process. (Redis 7.0.9)

• (CVE-2023-22458) Integer overflow in the Redis HRANDFIELD and ZRANDMEMBER commands can lead to denial-of-service. (Redis 7.0.8)

• (CVE-2022-36021) String matching commands (like SCAN or KEYS) with a specially crafted pattern to trigger a denial-of-service attack on Redis can cause it to hang and consume 100% CPU time. (Redis 7.0.9)

• (CVE-2022-35977) Integer overflow in the Redis SETRANGE and SORT/SORT_RO commands can drive Redis to OOM panic. (Redis 7.0.8)

• (CVE-2022-35951) Executing an XAUTOCLAIM command on a stream key in a specific state, with a specially crafted COUNT argument, may cause an integer overflow, a subsequent heap overflow, and potentially lead to remote code execution. The problem affects Redis versions 7.0.0 or newer. (Redis 7.0.5)

• (CVE-2022-31144) A specially crafted XAUTOCLAIM command on a stream key in a specific state may result in heap overflow and potentially remote code execution. The problem affects Redis versions 7.0.0 or newer. (Redis 7.0.4)

• (CVE-2022-24834) A specially crafted Lua script executing in Redis can trigger a heap overflow in the cjson and cmsgpack libraries, and result in heap corruption and potentially remote code execution. The problem exists in all versions of Redis with Lua scripting support, starting from 2.6, and affects only authenticated and authorized users. (Redis 7.0.12)

• (CVE-2022-24736) An attacker attempting to load a specially crafted Lua script can cause NULL pointer dereference which will result in a crash of the redis-server process. This issue affects all versions of Redis. (Redis 7.0.0)

• (CVE-2022-24735) By exploiting weaknesses in the Lua script execution environment, an attacker with access to Redis can inject Lua code that will execute with the (potentially higher) privileges of another Redis user. (Redis 7.0.0)

Redis 6.2.x:

• (CVE-2024-31449) An authenticated user may use a specially crafted Lua script to trigger a stack buffer overflow in the bit library, which may potentially lead to remote code execution.

• (CVE-2024-31228) An authenticated user can trigger a denial-of-service by using specially crafted, long string match patterns on supported commands such as KEYS, SCAN, PSUBSCRIBE, FUNCTION LIST, COMMAND LIST, and ACL definitions. Matching of extremely long patterns may result in unbounded recursion, leading to stack overflow and process crashes.

• (CVE-2023-28856) Authenticated users can use the HINCRBYFLOAT command to create an invalid hash field that will crash Redis on access. (Redis 6.2.12)

• (CVE-2023-25155) Specially crafted SRANDMEMBER, ZRANDMEMBER, and HRANDFIELD commands can trigger an integer overflow, resulting in a runtime assertion and termination of the Redis server process. (Redis 6.2.11)

• (CVE-2023-22458) Integer overflow in the Redis HRANDFIELD and ZRANDMEMBER commands can lead to denial-of-service. (Redis 6.2.9)

• (CVE-2022-36021) String matching commands (like SCAN or KEYS) with a specially crafted pattern to trigger a denial-of-service attack on Redis can cause it to hang and consume 100% CPU time. (Redis 6.2.11)

• (CVE-2022-35977) Integer overflow in the Redis SETRANGE and SORT/SORT_RO commands can drive Redis to OOM panic. (Redis 6.2.9)

• (CVE-2022-24834) A specially crafted Lua script executing in Redis can trigger a heap overflow in the cjson and cmsgpack libraries, and result in heap corruption and potentially remote code execution. The problem exists in all versions of Redis with Lua scripting support, starting from 2.6, and affects only authenticated and authorized users. (Redis 6.2.13)

• (CVE-2022-24736) An attacker attempting to load a specially crafted Lua script can cause NULL pointer dereference which will result in a crash of the redis-server process. This issue affects all versions of Redis. (Redis 6.2.7)

• (CVE-2022-24735) By exploiting weaknesses in the Lua script execution environment, an attacker with access to Redis can inject Lua code that will execute with the (potentially higher) privileges of another Redis user. (Redis 6.2.7)

• (CVE-2021-41099) Integer to heap buffer overflow handling certain string commands and network payloads, when proto-max-bulk-len is manually configured to a non-default, very large value. (Redis 6.2.6)

• (CVE-2021-32762) Integer to heap buffer overflow issue in redis-cli and redis-sentinel parsing large multi-bulk replies on some older and less common platforms. (Redis 6.2.6)

• (CVE-2021-32761) An integer overflow bug in Redis version 2.2 or newer can be exploited using the BITFIELD command to corrupt the heap and potentially result with remote code execution. (Redis 6.2.5)

• (CVE-2021-32687) Integer to heap buffer overflow with intsets, when set-max-intset-entries is manually configured to a non-default, very large value. (Redis 6.2.6)

• (CVE-2021-32675) Denial Of Service when processing RESP request payloads with a large number of elements on many connections. (Redis 6.2.6)

• (CVE-2021-32672) Random heap reading issue with Lua Debugger. (Redis 6.2.6)

• (CVE-2021-32628) Integer to heap buffer overflow handling ziplist-encoded data types, when configuring a large, non-default value for hash-max-ziplist-entries, hash-max-ziplist-value, zset-max-ziplist-entries or zset-max-ziplist-value. (Redis 6.2.6)

• (CVE-2021-32627) Integer to heap buffer overflow issue with streams, when configuring a non-default, large value for proto-max-bulk-len and client-query-buffer-limit. (Redis 6.2.6)

• (CVE-2021-32626) Specially crafted Lua scripts may result with Heap buffer overflow. (Redis 6.2.6)

• (CVE-2021-32625) An integer overflow bug in Redis version 6.0 or newer can be exploited using the STRALGO LCS command to corrupt the heap and potentially result with remote code execution. This is a result of an incomplete fix by CVE-2021-29477. (Redis 6.2.4)

• (CVE-2021-29478) An integer overflow bug in Redis 6.2 could be exploited to corrupt the heap and potentially result with remote code execution. The vulnerability involves changing the default set-max-intset-entries configuration value, creating a large set key that consists of integer values and using the COPY command to duplicate it. The integer overflow bug exists in all versions of Redis starting with 2.6, where it could result with a corrupted RDB or DUMP payload, but not exploited through COPY (which did not exist before 6.2). (Redis 6.2.3)

• (CVE-2021-29477) An integer overflow bug in Redis version 6.0 or newer could be exploited using the STRALGO LCS command to corrupt the heap and potentially result in remote code execution. The integer overflow bug exists in all versions of Redis starting with 6.0. (Redis 6.2.3)