Skip to main content

Terminology

This page is the authority for reader-facing product terms in the v0.6 documentation. Configuration keys, API fields, metric names, and code identifiers retain their exact spelling even when they differ from prose terms.

Quick Lookup​

NeedTerm
configured downstream ingress identitylistener
primary UDP/QUIC and HTTP/3 ingressnative QUIC listener
compatibility TCP/TLS ingress for HTTP/1.1 and HTTP/2bootstrap listener
named routing targetupstream
single origin endpoint inside an upstreambackend
request match conditionsroute
request policy gate before backend executionadmission
contract-style request limitingquota
runtime self-protection under pressureoverload
privileged admin HTTP surfaceControl API
operator-facing history of admin actionsaudit
atomically swapped active runtime versionruntime generation
publishing a candidate runtime generationactivation
legacy direct-apply operationreload
restoring a retained runtime generationrollback
stopping new admission while work completesdrain

Use these definitions and preferred phrases consistently across product-reference pages.

TermMeaning
ListenerA configured downstream ingress identity. It owns an address, port, protocol settings, and certificate set and provides the settings from which ingress sockets are created.
Native QUIC listenerThe primary UDP/QUIC ingress for downstream HTTP/3 traffic. Use this term instead of “QUIC path” when referring to the concrete listener.
Bootstrap listenerThe automatically paired TCP/TLS compatibility ingress for downstream HTTP/1.1 and HTTP/2. It uses the configured listener identity and is not a separately configured listener.
UpstreamA named routing target consisting of route rules, optional TLS policy, load-balancing policy, and one or more backends.
BackendA single origin endpoint inside an upstream.
RouteThe match conditions that decide which upstream handles a request.
AdmissionThe shared request-policy gate that evaluates route-level rejection, scoped rate limits, quota, brownout, overload, and permit checks before backend execution.
AuthRequest-path authentication and authorization decisions, including local auth and external auth integration.
QuotaContract-style request limiting based on explicit selectors and windows. Quota is separate from overload control.
OverloadRuntime protection behavior that sheds or delays work to keep the system stable under pressure.
BrownoutA specific overload mode in which non-core or lower-priority traffic is shed to preserve core traffic.
Control APIThe privileged operator-facing admin HTTP surface.
Control planeThe broader operator-facing management layer around the Control API, runtime views, watchdog, metrics endpoint, and related admin services.
AuditThe operator-facing record of control API actions and runtime-management events.
Runtime generationAn immutable version of normalized runtime state. One generation is active, while eligible older generations may be retained for history and rollback.
ActivationPreparing and atomically publishing a compatible candidate runtime generation. The staged Control API operation is POST /admin/runtime/activate.
ReloadThe legacy shortcut exposed by POST /admin/runtime/reload, which validates and directly applies a compatible candidate without the separate staged workflow. Do not use reload as a generic synonym for activation, certificate reload, restart, or drain.
RollbackRestoring an eligible retained runtime generation through POST /admin/runtime/rollback. Rollback changes the active generation; it is not a process restart.
Metrics endpointThe Prometheus exposition endpoint.
DrainThe process of stopping new admissions while allowing existing work to complete or time out.
Certificate reloadReloading listener certificate material for new handshakes through POST /admin/runtime/reload-certs. This is not activation or full config reload.

Preferred Usage​

Use these phrases consistently unless a page is quoting a metric name, config key, or code identifier.

PreferAvoid when possibleReason
listenerproxy listener, socket listenerlistener is the canonical runtime term.
native QUIC listenerQUIC path when the concrete listener is meantdistinguishes the UDP/HTTP/3 ingress from the shared request path.
bootstrap listenerbootstrap TLS listener, TCP bootstrap listenerTLS and TCP are properties of the compatibility listener, not part of its preferred name.
routerouting rule for the main nounroute is shorter and already defined.
upstreamupstream pool as the default termupstream is the canonical routing target; mention its backends when needed.
backendorigin server unless external comparison requires itbackend matches config, metrics, and runtime views.
admissionadmission control everywhereuse admission as the general subsystem name; use admission control only when the longer phrase materially helps.
authmixed authentication / authorization wording for shared request-path decisionsauth is the shortest shared label for the request-path decision layer.
quotarate limiting when the feature is specifically quotaquota has different semantics from scoped rate limiting.
overloadrate limiting or quota when the meaning is runtime protectionkeep contract failure and runtime protection separate.
brownoutvague phrases like degraded mode when the specific overload mode is meantbrownout is a distinct runtime behavior.
Control APIadmin API as the primary product termControl API is the canonical product surface.
control planecontrol-plane services for the general system every timeuse control plane for the broader management layer; use Control API for the HTTP admin surface.
auditaudit log as the only termaudit covers the event stream and operator history more cleanly.
runtime generationgeneration alone on first mentionspell out the full phrase on first mention for clarity.
activationreload for the staged generation workflowactivation is the preferred atomic generation change; reload names the legacy shortcut.
rollbackrevert when referring to the Control API operationrollback names the retained-generation operation.
drainshutdown when work is still being allowed to finishdrain is a lifecycle phase; shutdown is the final process outcome.

Search Aliases​

These aliases are common search terms, but they are not the preferred product wording:

Search termCanonical term
admin APIControl API
origin serverbackend
routing ruleroute
QUIC path, when referring to ingressnative QUIC listener
bootstrap TLS listenerbootstrap listener
rate limiting, when the meaning is contract exhaustionquota
degraded mode, when the meaning is selective overload sheddingbrownout
config version swapruntime generation
config applyactivation
revert generationrollback

Writing Style​

Use these style rules across product-reference pages:

  • Prefer short, direct sentences.
  • Use the canonical term on first mention, then keep using the same term.
  • Separate request-path policy concepts from runtime protection concepts.
  • Use Control API for the admin HTTP surface and control plane for the broader operator layer.
  • Use upstream for the named routing target and backend for individual endpoints inside it.
  • Use native QUIC listener and bootstrap listener for the two concrete ingress listeners.
  • Use activation, reload, rollback, and drain only for the distinct lifecycle operations defined above.
  • Avoid mixing code names, config keys, and reader-facing terms in ordinary prose unless needed for precision.