docs: fix outdated Import Agent/Tool UI steps across AuthBridge demo docs - #794
Conversation
…agent demo The weather-agent UI demo referenced UI fields that no longer match the current Rossoctl Import Agent / Import Tool forms: - Remove the 'Framework: LangGraph' step (dropdown no longer exists; framework is set automatically). - Rename the agent-form checkbox 'Enable AuthBridge sidecar injection' to 'Secure with AuthBridge'. - Rename the SPIRE checkbox to 'Enable SPIRE identity (JWT-SVID via spiffe-helper)' in both the Import Tool and Import Agent steps. - Update the port step: it is now a 'Pod Configuration' section whose defaults already map 8080 -> 8000, so no manual entry is needed. - Rename the 'Outbound Ports to Exclude' field to 'Bypass AuthBridge on these outbound ports' (Step 2 item and Step 4 Ollama section). - Fix 'Deploy From Image' casing to 'Deploy from Image'. The Import Tool form's AuthBridge checkbox is intentionally left as 'Enable AuthBridge sidecar injection' since only the Agent form was renamed. Verified against rossoctl/ui-v2 ImportAgentPage.tsx and ImportToolPage.tsx. Closes #793 Assisted-By: Claude (Anthropic AI) <noreply@anthropic.com> Signed-off-by: Paolo Dettori <dettori@us.ibm.com>
|
Warning Review limit reachedNext included review available in 32 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Apply the same UI-drift corrections already made to weather-agent/demo-ui.md to the two sibling demo docs: - Remove the obsolete 'Framework' selection step (the UI no longer exposes a framework picker; agents are LangGraph). - Rename the agent-form 'Enable AuthBridge sidecar injection' checkbox to 'Secure with AuthBridge' (tool-form label is unchanged). - Update SPIRE checkbox label to 'Enable SPIRE identity (JWT-SVID via spiffe-helper)'. - Rename the 'Port Configuration' section to 'Pod Configuration'. - Rename the agent-form 'Outbound Ports to Exclude' field to 'Bypass AuthBridge on these outbound ports' (tool-form label is unchanged). - Fix 'Deploy From Image' casing to 'Deploy from Image'. - Renumber the affected agent-import steps and cross-references. Assisted-By: Claude (Anthropic AI) <noreply@anthropic.com> Signed-off-by: Paolo Dettori <dettori@us.ibm.com>
huang195
left a comment
There was a problem hiding this comment.
Perfetto — a docs sweep where every claim is checkable, and all of them check out. Approving.
The thing I checked first, because it looked alarming
The base blob for weather-agent/demo-ui.md is ea69794f1 — the pre-#791 version — and #791 merged an hour before this. So the obvious fear is that merging this silently reverts yesterday's keycloak-admin-secret correction. It does not. I ran the actual three-way merge (merge-base 492cefd, this PR's head, current main):
merge exit status: 0 → clean, zero conflicts
grep 'No `keycloak-admin-secret` is required' → 1 → #791 preserved
grep 'Secure with AuthBridge|Bypass AuthBridge' → 3 → #794 applied
GitHub agrees — mergeable: true (the blocked state is only the pending review). The two PRs touch disjoint regions: #791 lives around lines 110-128, this one starts at 126+. No rebase needed.
Every renamed label verified against the UI source
| Doc change | Confirmed at |
|---|---|
Secure with AuthBridge (agents) |
ImportAgentPage.tsx:1164 |
Enable SPIRE identity (JWT-SVID via spiffe-helper) |
ImportAgentPage.tsx:1180, ImportToolPage.tsx:1135 |
Pod Configuration (was Port Configuration) |
ImportAgentPage.tsx:1342, ImportToolPage.tsx:510,1100,1233 |
Bypass AuthBridge on these outbound ports |
ImportAgentPage.tsx:1257 |
Deploy from Image (lowercase "from") |
ImportToolPage.tsx:647,903 |
| Dropping the Framework step | no Framework anywhere in ImportAgentPage.tsx — the field is gone |
The tool-versus-agent asymmetry is correct, which I had pencilled in as an oversight until I looked: ImportToolPage.tsx:1107 still reads Enable AuthBridge sidecar injection, and Secure with AuthBridge exists only on the agent page. Renaming the agent text while leaving the tool text alone is exactly right.
I also swept all three files for leftovers — no Port Configuration, Deploy From Image, spiffe-helper sidecar), Outbound Ports to Exclude, or **Framework** survive. Step numbering is sequential with no gaps in either file, and the renumbered cross-references land on the right items (github-issue "item 12" / "(item 7)", weather "Step 2, item 11").
One nit inline, purely about consistency between two sibling docs.
Summary
Author: pdettori (MEMBER — maintainer)
Areas reviewed: Docs
Agent/IDE config (.claude/.vscode): none
Commits: 2, both signed off
CI status: 20/20 passing
Assisted-By: Claude Code
| Leave it checked. | ||
|
|
||
| 10. Under **Port Configuration**, set **Service Port** to `8080` and **Target Port** to `8000` | ||
| 9. Under **Pod Configuration**, set **Service Port** to `8080` and **Target Port** to `8000` |
There was a problem hiding this comment.
nit — the same step now reads two different ways across sibling docs.
ImportAgentPage.tsx:157 initialises the default service port as { name: 'http', port: 8080, targetPort: 8000, protocol: 'TCP' }. This PR rewrote the equivalent step in weather-agent/demo-ui.md to say exactly that:
The default Pod Configuration already maps service port
8080to target port8000, so no change is needed.
Here it still reads "set Service Port to 8080 and Target Port to 8000" — the same two values the form already ships with. Not wrong, just asking the reader to set something already set, and now inconsistent with the sibling doc this PR improved.
Worth noting the tool step above it (9090 / 9090) genuinely does differ from the default, so that one should stay imperative — this is only about the agent step.
What
The Rossoctl Import Agent / Import Tool UI has drifted from the AuthBridge
demo walkthroughs. This PR brings all three UI demo docs back in sync
with the current UI:
authbridge/demos/weather-agent/demo-ui.mdauthbridge/demos/github-issue/demo-ui.mdauthbridge/demos/weather-agent/demo-ui-advanced.mdOutdated steps corrected
Verified against the UI source (
ImportAgentPage.tsx/ImportToolPage.tsxin
rossoctl/rossoctl):longer exposes a framework picker (framework is fixed to LangGraph).
"Secure with AuthBridge" — this rename applies to the agent form only;
the tool form still reads "Enable AuthBridge sidecar injection", so those
occurrences are intentionally left unchanged.
"Enable SPIRE identity (JWT-SVID via spiffe-helper)".
Service Port/Target Portfield labels are unchanged and still accurate)."Bypass AuthBridge on these outbound ports" — again agent form only;
the tool form still uses "Outbound Ports to Exclude".
cross-references accordingly.
Notes
8080→8000, tool9090→9090),so no behavior changes are implied — these are label/wording fixes.
bullets above.
Closes #793
Assisted-By: Claude Code