Repository navigation
docs: recording and mocking Redis needs Keploy Enterprise - #939
Draft
slayerjain wants to merge 1 commit into
Draft
slayerjain wants to merge 1 commit into
slayerjain wants to merge 1 commit into
Conversation
slayerjain
force-pushed
the
train/docs/redis-enterprise-only
branch
from
October 23, 2026 02:49
ca456a0 to
ed6ef93
Compare
This was referenced Oct 23, 2026
slayerjain
force-pushed
the
train/docs/redis-enterprise-only
branch
from
October 23, 2026 11:24
45db116 to
cdc7def
Compare
The open-source keploy no longer records or mocks Redis. It detects a Redis connection by its first command, passes the connection through to the real Redis server in keploy record and keploy test, and logs once per Redis address that the Redis calls are skipped, with the Keploy Enterprise link. It does not serve Redis Mocks already in a Test-Set. The docs still presented Redis mocking as available in every keploy. - dependencies/redis.md: a note on what the open-source keploy does with Redis and with servers that speak Redis's protocol (Valkey, KeyDB, Dragonfly); which keploy is Keploy Enterprise (the one the install script installs by default, without --oss); when the warnings come; why Redis must be running at replay with the data the tests expect; a Redis reached through an HTTP CONNECT proxy; and which connections it does not detect. The "How it works" section is scoped to Keploy Enterprise on Linux, Docker and WSL. - dependencies/index.md and content/llms-full-root.txt (served as the root of llms-full.txt): Redis mocking is Keploy Enterprise only, and a free account is enough for it. - quickstart/go-gin-redis.md and quickstart/flask-redis.md: a similar note near the top of each section, naming the test this changes for that app. go-gin-redis's mock example showed kind: Generic, which Keploy Enterprise does not write; it is now an excerpt in the Redis kind. - running-keploy/mock-your-tests.md: with the open-source keploy, Redis must be running during keploy mock replay, as keploy mock --help says. - The two Redis quickstarts carried an Enterprise-only badge; they now carry the same badge as the other quickstarts, in line with their notes that a free account is enough. - keploy-cloud/installation.md: a note that the keploy the install script installs by default (without --oss) is Keploy Enterprise, which records and mocks Redis with a free account. Each Redis note says that a free account is enough to record and replay Redis with Keploy Enterprise, as the install pages already say for keploy itself. "Keploy Enterprise" links /docs/keploy-cloud/cloud-installation/, the page the open-source keploy's Redis warning links (keploy's models.RedisEnterpriseURL), so the warning and the docs name one page. The install-script links go to /docs/server/installation/. version-3.0.0 is left alone: docusaurus.config.js does not build it. 1.0.0 and 2.0.0 are archived, unmaintained versions that describe the keploy of their time. Signed-off-by: slayerjain <shubhamkjain@outlook.com>
slayerjain
force-pushed
the
train/docs/redis-enterprise-only
branch
from
October 23, 2026 14:21
cdc7def to
55ad1de
Compare
12 of 25 tasks
This branch has not been deployed
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.
What has changed?
The open-source keploy no longer records or mocks Redis. It passes Redis calls through to the real Redis server in
keploy recordandkeploy test, records no Redis mocks, and logs one warning per Redis address that links to Keploy Enterprise. The docs still presented Redis mocking as available in every keploy. This PR makes Redis support truthful with small edits; no page is rewritten.What changes for readers
dependencies/redis.md: a note at the top of the page.keploythe default install script installs, and a free account is enough to record and replay with it.install.sh --oss, the GitHub releases, theghcr.io/keploy/keployimage, or a build from source.Redismocks with a warning each time it loads the test set, and leavesGenericRedis mocks out of the replay with a warning once per run.keploy test, with the data the tests expect.CONNECTproxy must be reachable without the proxy.Generic: inline commands, unknown module commands, and commands only a Redis-compatible server has, such as Tile38'sNEARBY.quickstart/go-gin-redis.md(both sections) andquickstart/flask-redis.md: a similar note near the top, which says a free account is enough. Each one names the test that changes for that app with the open-source keploy:ProductTier tiers="Enterprise" offerings="Self-Hosted, Dedicated"). They now carry the same badge as the other quickstarts (tiers="Free, Teams, Scale, Enterprise", no offerings), in line with their notes.go-gin-redis.md: itsmocks.ymlexample showedkind: Generic(PING/SET/GET), which contradicts the note. It is now a SET/GET excerpt in the shape Keploy Enterprise records:kind: RediswithRequestBin/ResponseBin.dependencies/index.md(Supported Dependencies) andcontent/llms-full-root.txt(served as the root ofllms-full.txt): Redis mocking is Keploy Enterprise only, a free account is enough for it, and the open-source keploy passes Redis through.running-keploy/mock-your-tests.md: a note beside the replay bullet, and the quick start's replay comment, say that with the open-sourcekeployRedis must be running duringkeploy mock replay, askeploy mock --helpsays, and that Keploy Enterprise records and mocks Redis with a free account.keploy-cloud/installation.md(Get Started on the Enterprise Plan): a note, "Redis works with a free account", above the page's plan section. It says that thekeploythe install script installs by default (without--oss) is Keploy Enterprise, which records and mocks Redis on Linux and in Docker or WSL with a free account./docs/keploy-cloud/cloud-installation/, the page the open-source keploy's Redis warning links, so the warning and the docs point to one page. The install-script links go to/docs/server/installation/.Left alone, on purpose
version-3.0.0:docusaurus.config.jsonlyIncludeVersionsdoes not build it.1.0.0and2.0.0: archived and unmaintained. They describe the keploy of their time.docs/directory has no Redis content.samples-javaspring-mysql-rediscommits 23kind: Redismocks, but its README has no keploy steps, so there is nothing to change there.Why: Redis recording and mocking moved to Keploy Enterprise. An open-source user who follows the old pages would expect Redis to be mocked at replay, stop Redis, and see their tests fail with no explanation.
When to merge: the site deploys
mainat once. Merge this only after the open-source keploy release with the Redis skip has shipped. Until then, these pages describe behaviour that no released open-source keploy has yet.This PR Resolves NA
Type of change
How Has This Been Tested?
prettier2.8.8--checkon every changed.mdfile, asprettify_code.ymlruns it: clean, after each change.yarn install --frozen-lockfile && yarn buildwithonBrokenLinks: throw: "[SUCCESS] Generated static files".npm run verify-schema(490 pages) andnpm run verify-linkedin-tagpass.dependencies/redis,dependencies/index,quickstart/flask-redis,quickstart/samples-redis(go-gin-redis's slug) andllms-full.txt./docs/keploy-cloud/cloud-installation/,/docs/server/installation/and/docs/dependencies/redis/.kind: Redismocks;GenericRedis mocks;install.sh --ossexists and is the same script askeploy.sh.Not run locally, so CI covers it:
verify-lastmod, which needs the real git history.CONNECTsentences, the Mock Your Tests note, the note on Get Started on the Enterprise Plan, the free-account sentences and the quickstart badges). CI'sdeploy-previewbuilds them; they were checked with prettier and by three independent reviews.Checklist:
Changes since opening
content/llms-full-root.txt) links/docs/keploy-cloud/cloud-installation/, the page the open-source keploy's Redis warning links. The install-script links stay on/docs/server/installation/.running-keploy/mock-your-tests.md) no longer says without a caveat that every dependency can be offline duringkeploy mock replay: with the open-sourcekeploy, Redis must be running.keploy-cloud/installation.md) gets a note, "Redis works with a free account": the default install (without--oss) is Keploy Enterprise, which records and mocks Redis with a free account.