Update installation docs with ai-gateway installation steps#580
Merged
Update installation docs with ai-gateway installation steps#580
Conversation
Contributor
📝 WalkthroughWalkthroughAdds AI Gateway Extension installation sections to both managed and self-hosted cluster installation guides, documenting configuration variables, helm installation commands, bootstrap wait and verification steps, and noting the extension is optional and should run after Agent Manager and IDP readiness. Changes
Sequence Diagram(s)sequenceDiagram
participant Operator
participant Helm
participant Kubernetes
participant AgentManager
participant IDP
participant AI_Gateway
Operator->>Helm: helm install ai-gateway-extension (values)
Helm->>Kubernetes: create Deployment / Job / CRs
Kubernetes->>AgentManager: expose APIGateway registration request
AgentManager->>IDP: validate token / IDP readiness
IDP-->>AgentManager: token validation OK
AgentManager-->>Kubernetes: accept registration (status update)
Kubernetes->>AI_Gateway: bootstrap job runs
AI_Gateway-->>Kubernetes: create APIGateway CR status
Kubernetes-->>Operator: kubectl get apigateway / jobs (verification)
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/install/managed-cluster.md`:
- Line 586: Update the docs to use the correct Helm values key name: replace all
occurrences of apiGateway.controlplane.host with apiGateway.controlPlane.host
(note the capital "P") so the table entry and the helm --set override use the
exact key the chart expects; search for apiGateway.controlplane.host in the file
and update both the table row and the example helm command to
apiGateway.controlPlane.host to ensure Helm applies the override.
In `@docs/install/self-hosted-cluster.md`:
- Line 529: The documentation uses the wrong-cased config key
apiGateway.controlplane.host which doesn't match the Helm values key
apiGateway.controlPlane.host; update all occurrences (table entry and any
example helm --set commands) to use apiGateway.controlPlane.host so Helm
recognizes the override and the intended value is applied.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: b0ba0239-ebfe-4c98-bd95-e4960cf84fe3
📒 Files selected for processing (2)
docs/install/managed-cluster.mddocs/install/self-hosted-cluster.md
a5anka
approved these changes
Mar 18, 2026
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/install/managed-cluster.md (1)
592-602: Add separate default and customized Helm install examples.This section currently shows only one customized command with multiple
--setoverrides. Please add a default install command and keep the customized command as an alternative path (not sequential).Based on learnings: when showing Helm installation commands with customization options in
docs/install/, present two separate examples (default and customized), as alternative commands.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/install/managed-cluster.md` around lines 592 - 602, Add a separate default Helm install example for the AI Gateway Extension in the "AI Gateway Extension" block: keep the existing customized command (the helm install amp-ai-gateway command with multiple --set overrides) but present it as an alternative (e.g., labeled "Customized install (optional)") and add a new simple default command above or beside it (e.g., helm install amp-ai-gateway oci://${HELM_CHART_REGISTRY}/wso2-amp-ai-gateway-extension --version 0.0.0-dev --namespace ${DATA_PLANE_NS} --timeout 1800s) so readers see both a plain default install and the existing customized version rather than one sequential flow.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/install/managed-cluster.md`:
- Line 587: The documented example for the agentManager.apiUrl is missing the
chart's API base path (/api/v1) causing bootstrap calls to wrong endpoints;
update the value for agentManager.apiUrl (both occurrences referenced) to
include the trailing /api/v1 so it matches the chart default and bootstrap
expectations, and ensure any explanatory text or examples reference the full
base path used by the chart.
- Line 588: The listed token endpoint value for agentManager.idp.tokenUrl uses
the wrong service hostname (thunder-service...), so update both occurrences to
the chart-default hostname amp-thunder-extension-service (e.g., change
http://thunder-service.amp-thunder.svc.cluster.local:8090/oauth2/token to
http://amp-thunder-extension-service.amp-thunder.svc.cluster.local:8090/oauth2/token)
so the bootstrap token exchange targets the correct DNS; ensure both spots
referencing agentManager.idp.tokenUrl are updated to the
amp-thunder-extension-service hostname.
---
Nitpick comments:
In `@docs/install/managed-cluster.md`:
- Around line 592-602: Add a separate default Helm install example for the AI
Gateway Extension in the "AI Gateway Extension" block: keep the existing
customized command (the helm install amp-ai-gateway command with multiple --set
overrides) but present it as an alternative (e.g., labeled "Customized install
(optional)") and add a new simple default command above or beside it (e.g., helm
install amp-ai-gateway
oci://${HELM_CHART_REGISTRY}/wso2-amp-ai-gateway-extension --version 0.0.0-dev
--namespace ${DATA_PLANE_NS} --timeout 1800s) so readers see both a plain
default install and the existing customized version rather than one sequential
flow.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: b2388c5d-21ef-4f0f-b73d-75bb92429d38
📒 Files selected for processing (2)
docs/install/managed-cluster.mddocs/install/self-hosted-cluster.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/install/self-hosted-cluster.md
| | Variable | Description | Default | | ||
| |----------|-------------|---------| | ||
| | `apiGateway.controlPlane.host` | Agent Manager service URL | `amp-api-gateway-manager.wso2-amp.svc.cluster.local:9243` | | ||
| | `agentManager.apiUrl` | Agent Manager API URL (reachable from bootstrap job) | `http://amp-api.wso2-amp.svc.cluster.local:9000` | |
Contributor
There was a problem hiding this comment.
Align agentManager.apiUrl with the chart’s API base path.
Line 587 and Line 599 omit /api/v1, while the chart default uses ...:9000/api/v1. If bootstrap logic expects this base path, calls will hit wrong endpoints.
🐛 Proposed fix
-| `agentManager.apiUrl` | Agent Manager API URL (reachable from bootstrap job) | `http://amp-api.wso2-amp.svc.cluster.local:9000` |
+| `agentManager.apiUrl` | Agent Manager API URL (reachable from bootstrap job) | `http://amp-api.wso2-amp.svc.cluster.local:9000/api/v1` |
...
- --set agentManager.apiUrl="http://amp-api.${AMP_NS}.svc.cluster.local:9000" \
+ --set agentManager.apiUrl="http://amp-api.${AMP_NS}.svc.cluster.local:9000/api/v1" \Also applies to: 599-599
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/install/managed-cluster.md` at line 587, The documented example for the
agentManager.apiUrl is missing the chart's API base path (/api/v1) causing
bootstrap calls to wrong endpoints; update the value for agentManager.apiUrl
(both occurrences referenced) to include the trailing /api/v1 so it matches the
chart default and bootstrap expectations, and ensure any explanatory text or
examples reference the full base path used by the chart.
| |----------|-------------|---------| | ||
| | `apiGateway.controlPlane.host` | Agent Manager service URL | `amp-api-gateway-manager.wso2-amp.svc.cluster.local:9243` | | ||
| | `agentManager.apiUrl` | Agent Manager API URL (reachable from bootstrap job) | `http://amp-api.wso2-amp.svc.cluster.local:9000` | | ||
| | `agentManager.idp.tokenUrl` | Thunder Extension token endpoint | `http://thunder-service.amp-thunder.svc.cluster.local:8090/oauth2/token` | |
Contributor
There was a problem hiding this comment.
Fix Thunder service hostname in agentManager.idp.tokenUrl.
Line 588 and Line 600 use thunder-service..., but the chart default expects amp-thunder-extension-service.... This will point the bootstrap flow to a non-matching service DNS and can break token exchange.
🐛 Proposed fix
-| `agentManager.idp.tokenUrl` | Thunder Extension token endpoint | `http://thunder-service.amp-thunder.svc.cluster.local:8090/oauth2/token` |
+| `agentManager.idp.tokenUrl` | Thunder Extension token endpoint | `http://amp-thunder-extension-service.amp-thunder.svc.cluster.local:8090/oauth2/token` |
...
- --set agentManager.idp.tokenUrl="http://thunder-service.${THUNDER_NS}.svc.cluster.local:8090/oauth2/token" \
+ --set agentManager.idp.tokenUrl="http://amp-thunder-extension-service.${THUNDER_NS}.svc.cluster.local:8090/oauth2/token" \Also applies to: 600-600
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/install/managed-cluster.md` at line 588, The listed token endpoint value
for agentManager.idp.tokenUrl uses the wrong service hostname
(thunder-service...), so update both occurrences to the chart-default hostname
amp-thunder-extension-service (e.g., change
http://thunder-service.amp-thunder.svc.cluster.local:8090/oauth2/token to
http://amp-thunder-extension-service.amp-thunder.svc.cluster.local:8090/oauth2/token)
so the bootstrap token exchange targets the correct DNS; ensure both spots
referencing agentManager.idp.tokenUrl are updated to the
amp-thunder-extension-service hostname.
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
2 participants
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.
Purpose
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning
Summary by CodeRabbit