docs(redis): document Valkey 8.x/9.x support for Redis state store and pub/sub#5224
Merged
Merged
Conversation
…d pub/sub Signed-off-by: Nelson Parente <nelson_parente@live.com.pt>
Contributor
Author
Expert review — OSS-863 Valkey docsThe RediSearch/RedisJSON limitation callout is accurate (stock Fixes being applied this session (pushed to this branch):
Process note: this docs PR targets |
…sub version table - supported-bindings/redis.md: add "Supported servers and versions" table (Redis 6.x/7.x, Valkey 8.x/9.x); remove outdated "does not support Redis >= 7" note - supported-locks/redis-lock.md: add "Supported servers and versions" table mirroring same style (no query-API caveat — lock does not use RediSearch) - setup-redis-pubsub.md: reconcile prose and table — drop the unclaimed "5.x" from the prose description so it matches the table (6.x, 7.x for Redis; 8.x, 9.x for Valkey). Both the table and the prose now reference only conformance-tested versions. No configuration-store Valkey documentation added (coverage was removed from the code PR as a no-op). Signed-off-by: Nelson Parente <nelson_parente@live.com.pt>
Contributor
There was a problem hiding this comment.
Pull request overview
Documents Valkey 8.x/9.x compatibility for Dapr Redis-backed components by adding explicit “Supported servers and versions” sections, and clarifying the Query API limitation when using stock Valkey images (missing required modules).
Changes:
- Add “Supported servers and versions” tables for Redis (6.x/7.x) and Valkey (8.x/9.x) across multiple Redis component docs.
- Add a Valkey warning callout in the Redis state store doc explaining Query API limitations with stock
valkey/valkeyimages. - Update Redis pub/sub “Create a Redis instance” wording to include Redis 7.x and Valkey 8.x/9.x.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| daprdocs/content/en/reference/components-reference/supported-state-stores/setup-redis.md | Adds supported server/version table and Valkey Query API warning callout. |
| daprdocs/content/en/reference/components-reference/supported-pubsub/setup-redis-pubsub.md | Adds supported server/version table and updates “Create a Redis instance” wording. |
| daprdocs/content/en/reference/components-reference/supported-locks/redis-lock.md | Adds supported server/version table for Redis lock component. |
| daprdocs/content/en/reference/components-reference/supported-bindings/redis.md | Adds supported server/version table for Redis binding component and removes outdated Redis >=7 note. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Supported servers and versions | ||
|
|
||
| The Redis state store component works against any RESP-compatible server. Confirmed supported versions: |
Comment on lines
+150
to
+151
| | Redis | 6.x, 7.x | v6 supports the Query API with the RediSearch module | | ||
| | [Valkey](https://valkey.io) | 8.x, 9.x | Stock `valkey/valkey` images do not ship RediSearch; the Query API is not available | |
| | [Valkey](https://valkey.io) | 8.x, 9.x | Stock `valkey/valkey` images do not ship RediSearch; the Query API is not available | | ||
|
|
||
| {{% alert title="Valkey and the Query API" color="warning" %}} | ||
| Stock Valkey images (`valkey/valkey:8.x`, `valkey/valkey:9.x`) do not bundle the RediSearch module. The [Query API]({{% ref "state_api.md#query-state" %}}) and the `queryIndexes` metadata field require RediSearch and will not work against a plain Valkey instance. All other state-store operations (CRUD, TTL, transactions, actor state) work normally. |
|
|
||
| ## Supported servers and versions | ||
|
|
||
| The Redis pub/sub component works against any RESP-compatible server. Confirmed supported versions: |
|
|
||
| ## Supported servers and versions | ||
|
|
||
| The Redis lock component works against any RESP-compatible server. Confirmed supported versions: |
| ## Create a Redis instance | ||
| ## Supported servers and versions | ||
|
|
||
| The Redis binding component works against any RESP-compatible server. Confirmed supported versions: |
Comment on lines
+167
to
+168
| ## Supported servers and versions | ||
|
|
…quirements (Copilot review) Signed-off-by: Nelson Parente <nelson_parente@live.com.pt>
Comment on lines
+151
to
+155
| | [Valkey](https://valkey.io) | 8.x, 9.x | Stock `valkey/valkey` images do not ship RediSearch or RedisJSON; the Query API is not available | | ||
|
|
||
| {{% alert title="Valkey and the Query API" color="warning" %}} | ||
| Stock Valkey images (`valkey/valkey:8.x`, `valkey/valkey:9.x`) do not bundle the RediSearch or RedisJSON modules. The [Query API]({{% ref "state_api.md#query-state" %}}) and the `queryIndexes` metadata field require both RediSearch and RedisJSON and will not work against a plain Valkey instance. All other state-store operations (CRUD, TTL, transactions, actor state) work normally. | ||
| {{% /alert %}} |
| ## Create a Redis instance | ||
|
|
||
| Dapr can use any Redis instance - containerized, running on your local dev machine, or a managed cloud service, provided the version of Redis is 5.x or 6.x. | ||
| Dapr can use any Redis instance - containerized, running on your local dev machine, or a managed cloud service. Confirmed supported versions are Redis 6.x and 7.x, and [Valkey](https://valkey.io) 8.x and 9.x as a drop-in replacement. |
…ing (Copilot review) Signed-off-by: Nelson Parente <nelson_parente@live.com.pt>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents that the Dapr Redis-backed components work against Valkey 8.x and 9.x.
Closes Linear OSS-863.
What this PR changes
supported-state-stores/setup-redis.md— adds a "Supported servers and versions" section with a table listing Redis 6.x/7.x and Valkey 8.x/9.x, plus a warning callout explaining that stock Valkey images do not ship the RediSearch/RedisJSON modules and therefore the Query API is not available against plain Valkey.supported-pubsub/setup-redis-pubsub.md— adds a "Supported servers and versions" section with the same table, and updates the "Create a Redis instance" paragraph from "5.x or 6.x" to include 7.x and Valkey 8.x/9.x.supported-locks/redis-lock.md— adds a "Supported servers and versions" table for the Redis lock component.supported-bindings/redis.md— adds a "Supported servers and versions" table for the Redis binding component and removes the outdated Redis >= 7 note.RediSearch / Query API limitation
Stock
valkey/valkeyimages do not include the RediSearch and RedisJSON modules. The state store Query API (queryIndexes,queryoperation) requires both modules and will not work against a plain Valkey instance. This is documented explicitly via a warning callout. All other operations — CRUD, TTL, transactions, pub/sub, bindings, lock, configuration — work normally.Testing
Conformance tests for all Redis-backed components (state, pubsub, bindings, lock, configuration) pass against both
valkey/valkey:8.0.2andvalkey/valkey:9.0.0locally. See the companion components-contrib PR for full test output.Pending CI:
Related
Components-contrib PR: dapr/components-contrib#4414 — adds the Valkey entries to the conformance test matrix.