Expand description
YAML-based proxy configuration.
All product-specific behavior is driven by config, not code. Same binary, different YAML = different product proxy.
Structs§
- Alias
Config - Path alias (rewrite before routing).
- Auth
Config - Auth configuration.
- Authz
Config - External authorization via the Envoy ext_authz gRPC contract
(
envoy.service.auth.v3.Authorization/Check). Interops with OPA and any ext_authz server. - Cors
Config - CORS configuration.
- Forward
Auth Config - Forward auth config.
- Health
Config - Health-probe endpoint configuration.
- JwtConfig
- JWT validation config.
- JwtLimit
Config - Claims that carry a key’s limit inside the JWT itself. A tier-name claim maps
to a
profilesentry (numbers stay tunable in config); direct numeric claims set the limit explicitly. - Limit
Profile Config - A named limit tier: a sustained rate plus an instantaneous burst capacity.
- Limit
Service Config - External limit-resolution service. The response names a tier or gives explicit numbers; results are cached and refreshed asynchronously, never on the request path.
- Listen
Config - Listen address configuration.
- Logging
Config - Logging configuration.
- Maintenance
Config - Maintenance mode config.
- Metrics
Class Config - Metrics endpoint classification.
- Metrics
Config - Prometheus metrics endpoint configuration.
- Oidc
Discovery Config - OIDC discovery config.
- Open
ApiConfig - OpenAPI generation config.
- Proxy
Config - Top-level proxy configuration (loaded from YAML).
- Rate
Rule Config - One rate-limit rule: a path pattern, how to key it, and an optional static
profile. The rule’s phase (before or after auth) is derived from its key
alone: a
jwt_claimkey needs validated claims so it runs after auth;ipandheaderkeys run before auth so anonymous floods are shed before any signature verification. (jwt_limitstherefore only takes effect onjwt_claimrules, the only ones running with claims available.) - Route
Policy Config - Route policy entry.
- Service
Config - Service identity.
- Shield
Config - Shield (rate limiting) configuration.
- Signing
KeyConfig - Signing key config for JWKS endpoint.
- Streaming
Config - Server-streaming response behavior.
- Sync
Config - Asynchronous cross-instance reconciliation via a shared store.
- Upstream
Config - Upstream gRPC service configuration.
Enums§
- Descriptor
Source - Descriptor loading source.
- KeySource
Config - How a rule derives its limit key. All sources fall back to the client IP when
their value is absent, so a limit can’t be bypassed by omitting a header or
authenticating anonymously. Written as a tagged map, e.g.
key: { type: jwt_claim, claim: sub }; omittingkeydefaults toip.