Skip to content

docs(k8s-proxy): document Console + browser widget for PAT exchange#853

Open
khareyash05 wants to merge 7 commits intomainfrom
docs/k8s-proxy-pat-token-widget
Open

docs(k8s-proxy): document Console + browser widget for PAT exchange#853
khareyash05 wants to merge 7 commits intomainfrom
docs/k8s-proxy-pat-token-widget

Conversation

@khareyash05
Copy link
Copy Markdown
Member

@khareyash05 khareyash05 commented May 1, 2026

Summary

The Authentication section now lists three ways to swap a PAT for the shared token:

  • Option A — From the Keploy Console: walkthrough with screenshots of the new "Get Shared Token" dialog on the cluster detail page (paired with keploy/enterprise-ui#1404).
  • Option B— From a shell: the original curl path, kept for CI scripts.

Pairs with keploy/api-server#1623 (PAT validate) and keploy/k8s-proxy#360 (/get-shared-token).

Note: this branch was cherry-picked off docs/k8s-proxy-pat-exchange (PR #849). It includes everything in PR #849 plus the Console flow + screenshots + embedded widget. PR #849 can be closed in favor of this one.

Test plan

  • yarn build passes locally.
  • Page renders at /running-keploy/k8s-proxy-api; all three options visible under "2. Exchange the PAT for the shared token".
  • Embedded widget hydrates (input fields render, button is interactive).
  • Three new screenshots load from /img/k8s-proxy-shared-token-{button,dialog,success}.png.

🤖 Generated with Claude Code

khareyash05 and others added 4 commits May 1, 2026 11:42
The Authentication section now lists three ways to swap a PAT for the
shared token:

- Option A: the Keploy Console "Get Shared Token" dialog on the cluster
  detail page (with screenshots).
- Option B: an embedded SharedTokenExchanger widget so readers can fire
  the exchange against their own proxy without leaving the page.
- Option C: the original curl path, kept for CI scripts.

This makes the bootstrap flow feel like a documented product surface
rather than a curl-only one, and lets readers verify the call before
trusting it in CI.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Yash Khare <khareyash05@gmail.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Yash Khare <khareyash05@gmail.com>
Add sharedToken/deploymentType/ingressUrl/cleartext to vale accept list
and remove spaces around em-dashes to satisfy Google.EmDash rule.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Yash Khare <khareyash05@gmail.com>
…sitive

Signed-off-by: Yash Khare <khareyash05@gmail.com>

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Yash Khare <khareyash05@gmail.com>
@khareyash05 khareyash05 force-pushed the docs/k8s-proxy-pat-token-widget branch from e43c4da to 647f752 Compare May 1, 2026 06:12
khareyash05 and others added 3 commits May 1, 2026 11:45
Signed-off-by: Yash Khare <khareyash05@gmail.com>
The widget is no longer referenced from any doc after the inline
"Try it right here" section was removed from k8s-proxy-api.md.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants