photoncloud-monorepo/apigateway/README.md

17 lines
995 B
Markdown

# APIGateway
`apigateway` is UltraCloud's supported external API and proxy surface for auth-aware and credit-aware upstream traffic.
## Supported product shape
APIGateway is supported as stateless replicated instances behind an external L4 or VIP layer; live in-process reload is not part of the product contract.
- Config distribution is restart-based. Render routes, auth providers, and credit providers from Nix or generated cluster state, then replace or restart the process.
- Scale-out is supported by running multiple identical instances behind FiberLB or another L4 or VIP distribution layer.
- The release-facing proof remains `nix run ./nix/test-cluster#cluster -- fresh-matrix`, which validates the shipped single gateway-node composition on `node06`.
## Explicit non-goals
- hot route reload through an admin API or `SIGHUP`
- in-process config gossip or leader election between gateway replicas
- a claim that every HA layout is directly release-proven in the current harness