Skip to content

Commit 819d73d

Browse files
Aditya-eddyclaude
andcommitted
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>
1 parent 4a23b92 commit 819d73d

1 file changed

Lines changed: 31 additions & 4 deletions

File tree

versioned_docs/version-4.0.0/keploy-cloud/cloud-replay.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,14 @@ keploy cloud replay --app prod.orders --cluster my-cluster \
8282

8383
The `--app` value `prod.orders` is split on the first `.`: `prod` is the namespace and `orders` is the deployment. Pass `--namespace`/`--deployment` explicitly when your names contain dots or when you want to override the derivation.
8484

85+
```bash
86+
# Shorthand — namespace and deployment are derived from --app
87+
keploy cloud replay --app prod.orders
88+
89+
# Whole identity spelled out — use when a name contains a dot, or to be explicit under --trigger
90+
keploy cloud replay --app prod.orders --namespace prod --deployment orders --cluster my-cluster
91+
```
92+
8593
---
8694

8795
## Self-hosted ingress targeting
@@ -135,11 +143,30 @@ All three are required — the mode needs a proxy URL to reach and a PAT to auth
135143

136144
```bash
137145
export KEPLOY_API_KEY=kep_xxxxxxxx
138-
keploy cloud replay \
146+
export KEPLOY_TLS_SKIP_VERIFY=true
147+
./enterprise/keploy-enterprise cloud replay \
139148
--k8s-proxy-auth \
140-
--k8s-proxy-url https://keploy-proxy.my-cluster.internal \
141-
--app prod.orders \
142-
--cluster my-cluster
149+
--k8s-proxy-url https://localhost:8085 \
150+
--app travelcard.travel-card-api \
151+
--cluster aditya-selfhosted \
152+
--test-sets test-set-fc5c588bc-travel-card-api-fc5c588bc-xgfbn \
153+
--delay 10
154+
```
155+
156+
Here `KEPLOY_API_KEY` (the PAT) and `KEPLOY_TLS_SKIP_VERIFY` (needed when the proxy serves a [self-signed cert](#tls-to-a-self-signed-proxy)) are set as **environment variables**, while `--k8s-proxy-auth`, `--k8s-proxy-url`, and the rest are passed as **flags**. Each input has both a flag and an environment-variable form (see the table above); when both are set, the flag wins.
157+
158+
`--k8s-proxy-auth` and `--k8s-proxy-url` can also be supplied as environment variables — `KEPLOY_K8S_PROXY_AUTH=true` and `KEPLOY_K8S_PROXY_URL` — which is handy in CI where they sit alongside the other secrets and config:
159+
160+
```bash
161+
export KEPLOY_API_KEY=kep_xxxxxxxx
162+
export KEPLOY_TLS_SKIP_VERIFY=true
163+
export KEPLOY_K8S_PROXY_AUTH=true
164+
export KEPLOY_K8S_PROXY_URL=https://localhost:8085
165+
./enterprise/keploy-enterprise cloud replay \
166+
--app travelcard.travel-card-api \
167+
--cluster aditya-selfhosted \
168+
--test-sets test-set-fc5c588bc-travel-card-api-fc5c588bc-xgfbn \
169+
--delay 10
143170
```
144171

145172
### What it does

0 commit comments

Comments
 (0)