[Task]: Add API Platform Gateway- Production Deployment Guide

[Thushani-Jayasekera]

Please select the area the issue is related to

Area/Management (Management API or Management Portal UI)

Please select the aspect the issue is related to

Aspect/Other (Anything else which does not match above categories)

Description

$subject

[Thushani-Jayasekera]

https://docs.google.com/document/d/1T3EKqt9SWnOFgXAtR7Oe1WWnmoGZ7gAmZGIqIajIUxg/edit?tab=t.0

[Thushani-Jayasekera]

Locally tested setup:

╔══════════════════════════════════════════════════════════════════════════════════╗
║                    KIND DATAPLANE CLUSTER  (Kubernetes v1.35.0)                 ║
║                                                                                  ║
║  ┌─────────────────────┐  ┌─────────────────────┐  ┌─────────────────────────┐  ║
║  │  dataplane-         │  │  dataplane-worker   │  │  dataplane-worker2      │  ║
║  │  control-plane      │  │  172.26.0.3         │  │  172.26.0.4             │  ║
║  │  172.26.0.2         │  │                     │  │                         │  ║
║  │  (control-plane)    │  │  containerd 2.2.0   │  │  containerd 2.2.0       │  ║
║  └─────────────────────┘  └─────────────────────┘  └─────────────────────────┘  ║
║                                                                                  ║
╠══════════════════════════════════════ NAMESPACE: ap-gateway ═════════════════════╣
║                                                                                  ║
║  ┌─────────────────────────────────────────────────────────────────────────────┐ ║
║  │  INGRESS / EXTERNAL TRAFFIC                                                 │ ║
║  │                                                                             │ ║
║  │   Internet ──► LoadBalancer: my-gateway-gateway-runtime (PENDING ext-IP)   │ ║
║  │                  HTTP  :8080 → NodePort 31320                               │ ║
║  │                  HTTPS :8443 → NodePort 31608                               │ ║
║  │                  Admin :9003 → NodePort 32696                               │ ║
║  └──────────────────────────────┬──────────────────────────────────────────────┘ ║
║                                 │                                                ║
║  ┌──────────────────────────────▼──────────────────────────────────────────────┐ ║
║  │  DEPLOYMENT: my-gateway-gateway-runtime          Replicas: 2/2 (HPA: 2–5)  │ ║
║  │  Image: ghcr.io/wso2/api-platform/gateway-runtime:1.1.0                    │ ║
║  │                                                                             │ ║
║  │  ┌─────────────────────────────────┐  ┌──────────────────────────────────┐ │ ║
║  │  │ Pod: ...-2dm2w                  │  │ Pod: ...-gpkgc                   │ │ ║
║  │  │ Node: dataplane-worker2         │  │ Node: dataplane-worker           │ │ ║
║  │  │ IP:   10.244.2.22               │  │ IP:   10.244.1.18                │ │ ║
║  │  └─────────────────────────────────┘  └──────────────────────────────────┘ │ ║
║  └──────────────────────────────┬──────────────────────────────────────────────┘ ║
║                                 │ xDS config (18000/18001)                       ║
║  ┌──────────────────────────────▼──────────────────────────────────────────────┐ ║
║  │  DEPLOYMENT: my-gateway-controller               Replicas: 2/2 (HPA: 2–5)  │ ║
║  │  Image: ghcr.io/wso2/api-platform/gateway-controller:1.1.0                 │ ║
║  │  Service (ClusterIP 10.96.119.186):                                         │ ║
║  │    REST API :9090 │ xDS :18000 │ Policy xDS :18001 │ :9091 │ :9092         │ ║
║  │                                                                             │ ║
║  │  ┌─────────────────────────────────┐  ┌──────────────────────────────────┐ │ ║
║  │  │ Pod: ...-fjbtt                  │  │ Pod: ...-hcttg                   │ │ ║
║  │  │ Node: dataplane-worker2         │  │ Node: dataplane-worker           │ │ ║
║  │  │ IP:   10.244.2.21               │  │ IP:   10.244.1.19                │ │ ║
║  │  └─────────────────────────────────┘  └──────────────────────────────────┘ │ ║
║  └──────────────────────────────┬──────────────────────────────────────────────┘ ║
║                                 │ :5432                                          ║
║  ┌──────────────────────────────▼──────────────────────────────────────────────┐ ║
║  │  STATEFULSET: gateway-postgres-postgresql        Replicas: 1/1              │ ║
║  │  Image: bitnami/postgresql:latest                                           │ ║
║  │  Service (ClusterIP 10.96.54.193):  :5432                                   │ ║
║  │  Service (Headless):                :5432                                   │ ║
║  │                                                                             │ ║
║  │  ┌─────────────────────────────────┐                                       │ ║
║  │  │ Pod: gateway-postgres-...-0     │    PVC: 8Gi RWO (standard)            │ ║
║  │  │ Node: dataplane-worker          │    Bound to persistent volume          │ ║
║  │  │ IP:   10.244.1.3                │                                       │ ║
║  │  └─────────────────────────────────┘                                       │ ║
║  └─────────────────────────────────────────────────────────────────────────────┘ ║
║                                                                                  ║
║  SECRETS: gateway-tls (TLS cert) │ gateway-cp-token │ gateway-encryption-keys   ║
║           gateway-postgres-password                                              ║
║  CONFIGMAPS: my-gateway-config │ my-gateway-llm-pricing                         ║
╚══════════════════════════════════════════════════════════════════════════════════╝

Summary table:

  ┌─────────────────────────────┬─────────────┬──────────┬──────────────────┬───────────────┐
  │          Component          │    Type     │ Replicas │   Node Spread    │      HPA      │
  ├─────────────────────────────┼─────────────┼──────────┼──────────────────┼───────────────┤
  │ my-gateway-gateway-runtime  │ Deployment  │ 2/2      │ worker + worker2 │ 2–5 (CPU 80%) │
  ├─────────────────────────────┼─────────────┼──────────┼──────────────────┼───────────────┤
  │ my-gateway-controller       │ Deployment  │ 2/2      │ worker + worker2 │ 2–5 (CPU 80%) │
  ├─────────────────────────────┼─────────────┼──────────┼──────────────────┼───────────────┤
  │ gateway-postgres-postgresql │ StatefulSet │ 1/1      │ worker only      │ none          │
  └─────────────────────────────┴─────────────┴──────────┴──────────────────┴───────────────┘

[Thushani-Jayasekera]

Docs PR - wso2/docs-api-platform#243