Commit 36ed96b
docs(keploy-cloud): cloud replay flag reference + k8s-proxy-auth & self-hosted troubleshooting (#884)
* docs(keploy-cloud): add cloud replay command flag reference
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>
* docs(cloud-replay): document k8s-proxy-auth mode + self-hosted troubleshooting
- 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>
* docs(cloud-replay): fix CI (prettier + Vale) and review nits
- 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>
* docs(cloud-replay): add flag/env examples for k8s-proxy-auth replay
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>
* docs(cloud-replay): note --k8s-proxy-url auto-enables k8s-proxy-auth
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>
* chore: adding the changes
Signed-off-by: Aditya Sharma <aditya282003@gmail.com>
---------
Signed-off-by: Aditya Sharma <aditya282003@gmail.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>1 parent a55cc60 commit 36ed96b
3 files changed
Lines changed: 353 additions & 0 deletions
File tree
- vale_styles/config/vocabularies/Base
- versioned_docs/version-4.0.0/keploy-cloud
- versioned_sidebars
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
221 | 221 | | |
222 | 222 | | |
223 | 223 | | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
0 commit comments