This directory contains sample configurations for Kong Gateway in the HelpDev platform.
Kong is deployed in DB-less mode using declarative YAML configuration managed via GitOps.
| File | Description |
|---|---|
routes.yaml |
Sample service routes configuration |
plugins.yaml |
Sample service plugins configuration |
kong-aggregated.yaml |
Sample aggregated Kong config (auto-generated) |
values-internal.yaml |
Helm values for internal Kong (ClusterIP) |
values-external.yaml |
Helm values for external Kong (LoadBalancer) |
platform-kong/{account}/{env}/{region}/{kong-instance}/
├── values.yaml # Helm values
└── kustomization.yaml # Kustomize overlay
platform-apis/{account}/{env}/{region}/{kong-instance}/{service}/
├── openapi.yaml # API specification
├── routes.yaml # Kong routes
├── plugins.yaml # Kong plugins
└── metadata.yaml # Auto-generated metadata
| Type | Purpose | Network |
|---|---|---|
| Internal | Service-to-service | ClusterIP |
| External | Public APIs | LoadBalancer + WAF |
Use the "Create Kong API Gateway Instance" template in Backstage.
Add annotations to your service's catalog-info.yaml:
metadata:
annotations:
helpdev.io/kong-instance: ecommerce-external
helpdev.io/kong-type: external
helpdev.io/openapi-path: apis/openapi.yaml
helpdev.io/openapi-auto-publish: "true"The pipeline will automatically:
- Validate OpenAPI spec
- Publish to
platform-apis - Trigger Kong config aggregation
- ArgoCD syncs to Kong