docs(keploy-cloud): cloud replay flag reference + k8s-proxy-auth & self-hosted troubleshooting#884
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new v4.0.0 Keploy Cloud documentation page that serves as a flag-by-flag reference for keploy cloud replay, and wires it into the versioned sidebar so it appears in the Keploy Cloud navigation.
Changes:
- Added a comprehensive
keploy cloud replaycommand reference page (flags, defaults/requirements, examples, SaaS vs self-hosted notes). - Registered the new page in the v4.0.0 sidebar under “Keploy Cloud”.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| versioned_sidebars/version-4.0.0-sidebars.json | Adds the new Cloud Replay doc page to the v4 sidebar navigation. |
| versioned_docs/version-4.0.0/keploy-cloud/cloud-replay.md | Introduces the Cloud Replay command reference content and examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Aditya-eddy
changed the title
Adds a comprehensive reference page for `keploy cloud replay` documenting every flag — app/cluster selection, self-hosted vs SaaS targeting, the new --proxy-url ingress override, --replay-source / --release-tag, --test-sets selection, branch overlay flags, mapping/strict-failure semantics, replay tuning, uploads/reporting, and CI metadata — with defaults, when-required notes, a SaaS-vs-self-hosted table, and examples. Adds the page to the v4 sidebar under the Keploy Cloud section. Part of keploy/enterprise#2197 (item ii). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Aditya Sharma <aditya282003@gmail.com>
…eshooting - Complete the --proxy-url → --k8s-proxy-url rename (and cloud.proxyUrl → cloud.k8sProxyUrl) to match the CLI. - Add "Authenticating through the k8s-proxy": the --k8s-proxy-auth / KEPLOY_K8S_PROXY_AUTH offline/CI mode — required inputs (proxy URL + KEPLOY_API_KEY), what it does and which api-server calls it skips, KEPLOY_TLS_SKIP_VERIFY / SSL_CERT_FILE for self-signed proxy certs, --cluster behaviour, and read+write vs replay:start permissions. - Add "Troubleshooting self-hosted replay" table (self-signed TLS, empty clusterName 400, missing mock blob, sysctl/PATH, app image pull, eBPF agent image tag, --delay for slow apps, telemetry mock mismatches). - Note the auth axis in the overview, a k8s-proxy-auth quick example, and a report-upload row in the SaaS-vs-self-hosted table. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Aditya Sharma <aditya282003@gmail.com>
- Run prettier --write on cloud-replay.md (fixes the prettier check). - Vale: whitelist legit technical terms (overridable, libpq, cbshim, stdin, sudo) in the Base accept vocab, and de-hyphenate "freshly changed" (Google.LyHyphens). - Address Copilot review: "Two axes" → "Three axes" (a third auth axis was added); drop the non-existent `-v` alias (docs use `--debug`); clarify that only the three overlay branch flags are mutually exclusive and `--branch` is the separate legacy CI-derived name. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Aditya Sharma <aditya282003@gmail.com>
Aditya-eddy
force-pushed
the
docs/cloud-replay-flags
branch
from
7f242eb to
4a23b92
Compare
Add a concrete self-hosted k8s-proxy-auth example (KEPLOY_API_KEY and KEPLOY_TLS_SKIP_VERIFY as env vars; --k8s-proxy-auth/--k8s-proxy-url and the rest as flags), plus an env-var variant that moves the proxy inputs to KEPLOY_K8S_PROXY_AUTH/KEPLOY_K8S_PROXY_URL. Also add an explicit namespace/deployment identity example to the app selection section. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Aditya Sharma <aditya282003@gmail.com>
Aditya-eddy
force-pushed
the
docs/cloud-replay-flags
branch
from
819d73d to
d1d91fd
Compare
Setting --k8s-proxy-url (or KEPLOY_K8S_PROXY_URL) now switches the run into auth-through-proxy mode automatically, so --k8s-proxy-auth is redundant when a proxy URL is set. Reflect this across the doc: - Enabling-it example drops the redundant --k8s-proxy-auth flag; only KEPLOY_API_KEY and KEPLOY_TLS_SKIP_VERIFY stay as env vars. - Table marks --k8s-proxy-auth optional; "only two inputs required". - Self-hosted ingress-targeting section: add a note that the URL turns on auth mode, and drop the stale "only changes the ingress / must be heart-beating" wording (auth mode skips the cluster-list lookup). - Quick examples and the at-a-glance table updated to match. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Aditya Sharma <aditya282003@gmail.com>
amaan-bhati
reviewed
Jul 1, 2026
amaan-bhati
left a comment
amaan-bhati
left a comment
Member
There was a problem hiding this comment.
Solid work - the flag groupings are clear, the troubleshooting table is genuinely useful, and the auth-through-proxy section explains a nuanced flow well.
One thing to fix before merge: the two code examples in the "Enabling it" section invoke the CLI as ./enterprise/keploy-enterprise cloud replay. That is a local dev path that will not exist on anyone else's machine. The quick examples at the top of the same page use keploy cloud replay - the auth examples should match.
# change this:
./enterprise/keploy-enterprise cloud replay \
# to this:
keploy cloud replay \Both blocks need the fix (lines 168 and 184). Everything else looks good.
Signed-off-by: Aditya Sharma <aditya282003@gmail.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.
What
Adds a complete
keploy cloud replaycommand flag reference (item (ii) of the epic in keploy/enterprise#2197) and documents the self-hosted--k8s-proxy-authmode plus a self-hosted troubleshooting guide.Page:
versioned_docs/version-4.0.0/keploy-cloud/cloud-replay.md.Contents
keploy cloud replay, grouped: app/cluster selection, self-hosted ingress targeting, trigger vs local, test-source selection, branch overlay, mapping/failure semantics, replay tuning, uploads/reporting, CI metadata, and general flags.--k8s-proxy-url— self-hosted k8s-proxy ingress override (heartbeat vs explicit; SaaS-ignored-with-warning behaviour;keploy.ymlcloud.k8sProxyUrl).--k8s-proxy-auth) — the offline/air-gapped self-hosted auth mode: required inputs (--k8s-proxy-url+KEPLOY_API_KEY), what it does and which api-server calls it skips,KEPLOY_TLS_SKIP_VERIFY/SSL_CERT_FILEfor self-signed proxy certs,--clusterbehaviour, and read+write vsreplay:startpermissions.clusterName400, missing mock blob,sysctl/PATH, app-image pull, eBPF agent-image tag,--delayfor slow apps, telemetry mock mismatches).Notes
--proxy-url→--k8s-proxy-urlrename (andcloud.proxyUrl→cloud.k8sProxyUrl) to match the CLI.🤖 Generated with Claude Code