Skip to content

Add ai gateway installation instructions to doc site #582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
menakaj merged 2 commits into from
Mar 18, 2026
Merged

Add ai gateway installation instructions to doc site #582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
805a7d8
Add ai gateway installation instructions to doc site
menakaj Mar 18, 2026
c484e24
Fix review comments
menakaj Mar 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion website/docs/getting-started/managed-cluster.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -629,7 +629,6 @@ helm install build-workflow-extensions \
--set global.registry.endpoint=${REGISTRY_ENDPOINT} \
--timeout 1800s
```

**Verification:**

You can verify the registry endpoint configured in your OpenChoreo Build Plane by checking the workflow templates:
Expand Down Expand Up @@ -675,6 +674,35 @@ helm install amp-evaluation-extension \

**Note:** This extension is optional. The platform will function without it, but evaluation features may not work.

### Step 10: Install AI Gateway Extension

The AI Gateway Extension registers the AI Gateway with the Agent Manager for managing LLM Providers.

**Important:** This step must be done **last** — it depends on the Agent Manager service being healthy and the Thunder Extension (IDP) being ready for token exchange.

**Set configuration variables:**

| 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/api/v1` |
| `agentManager.idp.tokenUrl` | Thunder Extension token endpoint | `http://amp-thunder-extension-service.amp-thunder.svc.cluster.local:8090/oauth2/token` |

**Installation:**

```bash
# Install AI Gateway Extension
helm install amp-ai-gateway \
oci://${HELM_CHART_REGISTRY}/wso2-amp-ai-gateway-extension \
--version 0.9.0 \
--namespace ${DATA_PLANE_NS} \
--set apiGateway.controlPlane.host="amp-api-gateway-manager.${AMP_NS}.svc.cluster.local:9243" \
--set agentManager.apiUrl="http://amp-api.${AMP_NS}.svc.cluster.local:9000/api/v1" \
--set agentManager.idp.tokenUrl="http://amp-thunder-extension-service.${THUNDER_NS}.svc.cluster.local:8090/oauth2/token" \
--timeout 1800s
```
Comment on lines +677 to +703
Copy link
Contributor

@coderabbitai coderabbitai bot Mar 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

THUNDER_NS variable used but not defined in Phase 2 Configuration Variables.

The installation command at line 701 uses ${THUNDER_NS}, but this variable is only defined in Step 4 (line 464), not in the Configuration Variables section at lines 372-387. Users starting from Phase 2 or copying commands selectively may encounter undefined variable errors.

Consider adding THUNDER_NS to the Configuration Variables section:

✏️ Proposed fix

Add to the Configuration Variables section (around line 386):

 export DATA_PLANE_NS="openchoreo-data-plane"
+export THUNDER_NS="amp-thunder"
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@website/docs/getting-started/managed-cluster.mdx` around lines 677 - 703, Add
the missing THUNDER_NS configuration variable to the Phase 2 "Configuration
Variables" section so the helm install command for the AI Gateway Extension
(helm install amp-ai-gateway / token URL using ${THUNDER_NS}) won't break; add
an entry named THUNDER_NS with a short description like "Thunder Extension
namespace" and the default value used elsewhere (amp-thunder) so the
installation command and agentManager.idp.tokenUrl have a defined variable.



## Verification

Verify all components are installed and running:
Expand Down
1 change: 1 addition & 0 deletions website/docs/getting-started/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ This installs everything you need:
5. **OpenChoreo Installation**: Installs OpenChoreo Control Plane, Data Plane, Build Plane, and Observability Plane
6. **AMP Thunder Extension**: Installs WSO2 AMP Thunder Extension
7. **Agent Management Platform**: Installs core platform (PostgreSQL, API, Console) and extensions (Platform Resources, Observability, Build)
8. **AI Gateway Extension**: Registers and installs WSO2 AI Gateway for LLM Provider management.

## Access Your Platform

Expand Down
48 changes: 48 additions & 0 deletions website/docs/getting-started/self-hosted-cluster.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -641,6 +641,54 @@ helm install amp-evaluation-extension \

**Note:** This extension is optional. The platform will function without it, but evaluation features may not work.

### Step 9: Install AI Gateway Extension

The AI Gateway Extension registers the AI Gateway with the Agent Manager for managing LLM Providers.

**Important:** This step must be done **last** — it depends on the Agent Manager service being healthy and the Thunder Extension (IDP) being ready for token exchange.

**Set configuration variables:**

| 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/api/v1` |
| `agentManager.idp.tokenUrl` | Thunder Extension token endpoint | `http://amp-thunder-extension-service.amp-thunder.svc.cluster.local:8090/oauth2/token` |

**Installation:**

```bash
# Install AI Gateway Extension
helm install amp-ai-gateway \
oci://${HELM_CHART_REGISTRY}/wso2-amp-ai-gateway-extension \
--version 0.9.0 \
--namespace ${DATA_PLANE_NS} \
--set apiGateway.controlPlane.host="amp-api-gateway-manager.${AMP_NS}.svc.cluster.local:9243" \
--set agentManager.apiUrl="http://amp-api.${AMP_NS}.svc.cluster.local:9000/api/v1" \
--set agentManager.idp.tokenUrl="http://amp-thunder-extension-service.${THUNDER_NS}.svc.cluster.local:8090/oauth2/token" \
--timeout 1800s
```

**Wait for the bootstrap job to complete:**

```bash
kubectl wait --for=condition=complete job/amp-gateway-bootstrap \
-n ${DATA_PLANE_NS} --timeout=300s
```

**Verify the AI Gateway is running:**

```bash
# Check the APIGateway CR
kubectl get apigateway default-ai -n ${DATA_PLANE_NS}

# Check the bootstrap job
kubectl get jobs -n ${DATA_PLANE_NS}
```

**Note:** This extension is optional. The platform will function without it, but the AI Gateway will not be available.


## Verification

Verify all components are installed and running:
Expand Down
Loading