Skip to content

Update Kubernetes standalone setup guide to match latest implementation #446

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

Open
kaushalkahapola wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update Kubernetes standalone setup guide to match latest implementation #446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8c7e426
Revise Kubernetes standalone deployment documentation
kaushalkahapola Aug 19, 2026
928015b
Fix formatting in kubernetes-standalone.md metadata
kaushalkahapola Aug 19, 2026
b99a466
Revise LLM provider setup and API endpoints
kaushalkahapola Aug 19, 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
78 changes: 42 additions & 36 deletions ...i-gateway/1.2.0/deployment/deployment-modes/kubernetes/kubernetes-standalone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ helm install ap-gateway oci://ghcr.io/wso2/api-platform/helm-charts/gateway \
--set gateway.controller.upstreamCerts.secretName=upstream-ca-certs
```

## Create and Invoke API
## Create and Invoke an LLM Provider

### Port-forward Gateway Controller Service

Expand All @@ -241,10 +241,10 @@ kubectl port-forward svc/ap-gateway-controller 9090:9090

### Verify gateway controller admin endpoint is running
```bash
curl http://localhost:9094/api/admin/v0.9/health
curl http://localhost:9094/api/admin/v1/health
```

### Deploy an API configuration
### Deploy an LLM provider configuration

The management API uses basic auth with the credentials from your Helm values
(`controller.auth.basic.users`; the chart default is `admin` / `admin`). Export them, changing them if
Expand All @@ -255,55 +255,61 @@ export ADMIN_USERNAME=admin
export ADMIN_PASSWORD=admin
```

The gateway includes first-class support for the OpenAI LLM provider. Replace `<openai-apikey>` with your
OpenAI API key and run the following command to deploy a sample OpenAI LLM provider:

```bash
curl -X POST http://localhost:9090/api/management/v1/rest-apis \
curl -X POST http://localhost:9090/api/management/v1/llm-providers \
-u "$ADMIN_USERNAME:$ADMIN_PASSWORD" \
-H "Content-Type: application/yaml" \
--data-binary @- <<'EOF'
apiVersion: gateway.api-platform.wso2.com/v1
kind: RestApi
kind: LlmProvider
metadata:
name: reading-list-api-v1.0
name: openai-provider
spec:
displayName: Reading-List-API
displayName: OpenAI Provider
version: v1.0
context: /reading-list/$version
template: openai
context: /openai/latest
upstream:
main:
url: https://apis.bijira.dev/samples/reading-list-api-service/v1.0
policies:
- name: set-headers
version: v1
params:
request:
headers:
- name: x-wso2-apip-gateway-version
value: v1.0.0
response:
headers:
- name: x-environment
value: development
operations:
- method: GET
path: /books
- method: POST
path: /books
- method: GET
path: /books/{id}
- method: PUT
path: /books/{id}
- method: DELETE
path: /books/{id}
url: https://api.openai.com/v1
auth:
type: api-key
header: Authorization
value: <openai-apikey>
accessControl:
mode: deny_all
exceptions:
- path: /chat/completions
methods: [POST]
- path: /models
methods: [GET]
- path: /models/{modelId}
methods: [GET]
EOF
```

### Test routing through the gateway
```bash
curl http://localhost:8080/reading-list/v1.0/books
curl -k https://localhost:8443/reading-list/v1.0/books
curl -X POST https://localhost:8443/openai/latest/chat/completions \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-4o-mini",
"messages": [
{
"role": "user",
"content": "Hi"
}
]
}' -k
```

To expose an MCP server instead, follow the same `kubectl port-forward` and admin-credential steps above,
then POST an `Mcp` payload to `/api/management/v1/mcp-proxies` as shown in the
[MCP proxy quick start guide](../../../mcp-proxy/quick-start-guide.md).

## Next Steps

- For operator-managed lifecycle and CRDs, see [Kubernetes Operator deployment mode](./gateway-operator.md).
- For mode comparison and migration context from Kubernetes Gateway 1.3.0, see the [deployment modes overview page](./overview.md).
- For mode comparison and migration context from Kubernetes Gateway 1.3.0, see the [deployment modes overview page](./overview.md).
78 changes: 42 additions & 36 deletions ...ai-gateway/next/deployment/deployment-modes/kubernetes/kubernetes-standalone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ helm install ap-gateway oci://ghcr.io/wso2/api-platform/helm-charts/gateway \
--set gateway.controller.upstreamCerts.secretName=upstream-ca-certs
```

## Create and Invoke API
## Create and Invoke an LLM Provider

### Port-forward Gateway Controller Service

Expand All @@ -241,10 +241,10 @@ kubectl port-forward svc/ap-gateway-controller 9090:9090

### Verify gateway controller admin endpoint is running
```bash
curl http://localhost:9094/api/admin/v0.9/health
curl http://localhost:9094/api/admin/v1/health
```

### Deploy an API configuration
### Deploy an LLM provider configuration

The management API uses basic auth with the credentials from your Helm values
(`controller.auth.basic.users`; the chart default is `admin` / `admin`). Export them, changing them if
Expand All @@ -255,55 +255,61 @@ export ADMIN_USERNAME=admin
export ADMIN_PASSWORD=admin
```

The gateway includes first-class support for the OpenAI LLM provider. Replace `<openai-apikey>` with your
OpenAI API key and run the following command to deploy a sample OpenAI LLM provider:

```bash
curl -X POST http://localhost:9090/api/management/v1/rest-apis \
curl -X POST http://localhost:9090/api/management/v1/llm-providers \
-u "$ADMIN_USERNAME:$ADMIN_PASSWORD" \
-H "Content-Type: application/yaml" \
--data-binary @- <<'EOF'
apiVersion: gateway.api-platform.wso2.com/v1
kind: RestApi
kind: LlmProvider
metadata:
name: reading-list-api-v1.0
name: openai-provider
spec:
displayName: Reading-List-API
displayName: OpenAI Provider
version: v1.0
context: /reading-list/$version
template: openai
context: /openai/latest
upstream:
main:
url: https://apis.bijira.dev/samples/reading-list-api-service/v1.0
policies:
- name: set-headers
version: v1
params:
request:
headers:
- name: x-wso2-apip-gateway-version
value: v1.0.0
response:
headers:
- name: x-environment
value: development
operations:
- method: GET
path: /books
- method: POST
path: /books
- method: GET
path: /books/{id}
- method: PUT
path: /books/{id}
- method: DELETE
path: /books/{id}
url: https://api.openai.com/v1
auth:
type: api-key
header: Authorization
value: <openai-apikey>
accessControl:
mode: deny_all
exceptions:
- path: /chat/completions
methods: [POST]
- path: /models
methods: [GET]
- path: /models/{modelId}
methods: [GET]
EOF
```

### Test routing through the gateway
```bash
curl http://localhost:8080/reading-list/v1.0/books
curl -k https://localhost:8443/reading-list/v1.0/books
curl -X POST https://localhost:8443/openai/latest/chat/completions \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-4o-mini",
"messages": [
{
"role": "user",
"content": "Hi"
}
]
}' -k
```

To expose an MCP server instead, follow the same `kubectl port-forward` and admin-credential steps above,
then POST an `Mcp` payload to `/api/management/v1/mcp-proxies` as shown in the
[MCP proxy quick start guide](../../../mcp-proxy/quick-start-guide.md).

## Next Steps

- For operator-managed lifecycle and CRDs, see [Kubernetes Operator deployment mode](./gateway-operator.md).
- For mode comparison and migration context from Kubernetes Gateway 1.3.0, see the [deployment modes overview page](./overview.md).
- For mode comparison and migration context from Kubernetes Gateway 1.3.0, see the [deployment modes overview page](./overview.md).