docs(redis): document Valkey compatibility - #1535
Open
atao2004 wants to merge 2 commits into
Open
Conversation
- Add Valkey compatibility section to docs/documentation/advanced/redis.md - Add a pointer note to README.md's Backend Configuration section Relates to conductor-oss#1403 Signed-off-by: Anna Tao <annatao2004@gmail.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
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.
Pull Request type
NOTE: Please remember to run
./gradlew spotlessApplyto fix any format violations.Changes in this PR
Documents Valkey as a compatible persistence backend for Conductor. Conductor's Redis
backend (Jedis 6.0.0, Redisson 3.22.0) communicates using standard RESP commands only —
no Redis modules (RedisSearch, RedisJSON, etc.) are used — so Valkey works as a drop-in
replacement, including managed offerings like AWS ElastiCache for Valkey and GCP
Memorystore for Valkey. Today this compatibility is undocumented, so users have to
discover and verify it themselves.
This PR is docs-only, scoped down from the original proposal in #1403 per maintainer
feedback ("Readme updates and documentation can be added for Valkey... we need not go
in detail in adding Docker Compose or integration instructions with specific cloud
providers"). No Docker Compose samples, config templates, or CI changes are included.
docs/documentation/advanced/redis.md,stating the RESP-only compatibility, that no new configuration is required beyond
pointing
conductor.redis.hostsat the Valkey endpoint, and that Redisson officiallysupports Valkey 7.2.5 and above.
README.md's Backend Configuration table.No code, configuration, or test changes. No existing Redis documentation, samples, or
behavior is modified.
Alternatives considered
The original issue proposed a Docker Compose sample, standalone/cluster/sentinel config
templates, an AWS ElastiCache walkthrough, a Redis→Valkey migration guide, and a CI job
validating the existing test suite against Valkey. The maintainer asked to keep this to
README/documentation only, so those pieces are deliberately left out of this PR rather
than deferred to a follow-up — see #1403 for that scoping discussion.
Testing
This is a documentation-only change; no code or runtime tests are required. The fork PR
was reviewed and approved, including verification of the Redisson compatibility link and
version claim.
Reviewer comments addressed
Fixes #1403