Component

core/gateway/envoy-gateway

An Envoy Gateway ingress gateway, programmed through the Gateway API. Its control plane watches the cluster's GatewayClass, Gateway and route resources and configures an Envoy data plane, which terminates client HTTP traffic — and HTTPS too, where the Release names a certificate Secret through tls_secret — and load-balances it to the Services those routes name. This Component installs the control plane and claims the gateway class and the gateway itself. An application reaches it by declaring a route naming the gateway as its parent, and the gateway is named after the component the Aggregate declares. Realized on Kubernetes through a Helm Recipe; it has no standalone local-container form, so no Compose Recipe is provided. It publishes the pod label, port name and path a scraper discovers its proxies' metrics by. It also serves models through Envoy AI Gateway. Wired to the AI gateway controller on its extension socket, it calls that controller as its extension server, and the Release must place it in envoy-gateway-system or the build halts. Each model on its models socket is served under /v1 at the gateway's address to a request naming the connection's alias, with that connection's credential. The gateway publishes that address as its endpoint, qualified with envoy-gateway-system so an agent in any namespace reaches it, and values.model as its model. While a model is wired, every route on the gateway takes the 50Mi per-connection request buffer Envoy AI Gateway configures. It realizes core/period-budget in tokens, core/retry-policy, core/concurrency-limit per model, and core/audit-logging with no cost or verified caller.

Provenance

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:3afd79abd963d7eaaa6fc702d5c2288b28bb3c6485a5a4bbb604d919aa3cfe95
Published
2026-11-10T10:11:47Z
Signing identity
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signature

  • Officialapplication/vnd.dev.sigstore.bundle.v0.3+json

    https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

    sha256:d14ea54a288890aca449abf7e0af2ac73fddc7e25fa4ecbdb660e071f92f71bd

Reference at this version

oci://hub.aggrega.ai/component/core/gateway/envoy-gateway:1.0.0

Developer parameters

Values the developer sets in the Aggregate.

NameTypeDefaultRequiredDescription
gateway_class_namestringenvoy-gatewaynoName of the gateway class this install claims. The gateway declares this class, and the class is cluster-scoped, so two installs sharing a cluster need two different names.
allowed_route_namespacesstring (Same | All)SamenoWhich namespaces may attach a route to the gateway's listeners. `Same` accepts routes from the gateway's own namespace only, which is what the routing API assumes when nothing says otherwise; `All` accepts routes from every namespace. Stated explicitly so the narrower of the two is a choice a reader can see rather than a default they meet later.
modelstring—noThe alias of a connection on the models socket that this gateway publishes as its model, the model name a component wired to the gateway sends. It must be an alias a models connection carries, and the build halts naming this value otherwise; it is required while the models socket holds a connection, and omitted while it holds none.

Operator sizing

Infrastructure sizing the operator tunes per environment.

NameTypeDefaultRequiredDescription
imagestringdocker.io/envoyproxy/gateway:v1.9.1noControl-plane container image the gateway's controller runs. Set this to pull the same release from a mirror or a private registry.
controller_namestringgateway.envoyproxy.io/gatewayclass-controllernoController name the gateway class is claimed under. The control plane is configured to answer for this same name, so the two halves cannot disagree; change it only where a second control plane in the cluster already answers for the default.
portinteger (min 1, max 65535)80noHTTP port the gateway's plain HTTP listener accepts client traffic on. Most operators should omit this and let the Recipe assign the default (80).
tls_secretstring—noName of an existing Secret of type kubernetes.io/tls, in the gateway's own namespace, holding the certificate and private key the gateway presents to clients. Set, the gateway gains a second listener named `https`, on port 443 with protocol HTTPS, which terminates TLS with that certificate beside the plain HTTP listener; a route attaches to it alone by naming that listener, and to both by naming none. Left unset, the gateway carries its plain HTTP listener alone. The Secret is referenced and never created here; it is the operator's, or a certificate controller's, to provide.
install_crdsbooleantruenoWhether this Release installs the custom-resource definitions the gateway and its routes are written against, together with the upgrade-safety policy that guards them. Set false where the cluster manages those definitions separately, and affirm control_plane_present when you do.
control_plane_presentbooleanfalsenoAffirms that the custom-resource definitions this Release does not install are already present in the target cluster. The compiler runs ahead of time and cannot inspect a cluster, so it asks rather than checks. With install_crds set false and this left unaffirmed, the build halts rather than emitting a gateway class and a gateway that nothing would reconcile.
source_versionstring—noSource artifact version (Helm chart). Overrides the Recipe's default source version. Changing from default does not guarantee value mapping compatibility.
computeobject—no—
overridesobject (open)—noProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Output contract

Values this component publishes to consumers over the uses topology.

NameTypeDefaultRequiredDescription
hoststring—noIn-cluster DNS name of the Service Envoy Gateway creates for this gateway's data plane, in the gateway's own namespace, the name alone without a namespace; a consumer in another namespace qualifies it with envoy-gateway-system, where the gateway sits while a model is wired, as endpoint already does. A consumer sends its client traffic here rather than to the service behind the gateway. Empty while nothing is wired to the models socket.
portinteger—yesTCP port that Service accepts the gateway's plain HTTP listener on, infra.port.
protocolstring—noHow the published address is spoken to — `http`, so a consumer composes an address on that scheme.
endpointstring—noFull base URL of the OpenAI-compatible API the gateway serves for the models wired to its models socket, with the host, the port and the /v1 path already composed. The host is qualified with envoy-gateway-system, the namespace the build requires the gateway to sit in whenever a model is wired, so the URL resolves from any namespace. A caller hands it to a client library as its base URL and names values.model as its model; every other wired model is served at the same URL under its own alias as the model name. Empty while nothing is wired to the models socket.
modelstring—noThe alias a consumer wired to the gateway sends as its model name: values.model. The gateway's route sends a request naming it to the model wired under that alias, asking for the model name that model publishes. Empty while nothing is wired to the models socket.
metrics_pod_selectorstring—noKubernetes label selector matching this gateway's Envoy proxy pods, for a scraper that discovers those pods directly rather than scraping one address. Published beside `metrics_pod_port` and `metrics_path`.
metrics_pod_portstring—noName of the container port on those pods that carries the metrics, `metrics`.
metrics_pathstring—noPath the metrics are served at on that port, `/stats/prometheus`.

Uses sockets

The dependency sockets this component connects through. The target of every connection wired through a socket must satisfy its label selector, and each connection may carry an attachment in the slots the socket declares. A required slot is owed by each connection the Aggregate or the Release wires through the socket.

extension

Selector
gateway.aggrega.ai/extension-server=envoy-gateway
Inject
—

This socket declares no attachment slots, so a connection through it carries no attachment.

models

Selector
component.aggrega.ai/category=ai-model
Inject
—

Slots each connection through this socket may fill

SlotSelectorRequiredInjectSensitiveDescription
credentialfeature.aggrega.ai/kind=secretno—yesOptional credential the gateway presents to the model this connection reaches, as a bearer token. When attached, the connection's backend security policy names the Secret the credential publishes, and the AI gateway controller reads the key from that Secret, in the gateway's namespace, under the data key apiKey, which the credential must publish: any other data key halts the build. The key appears in no rendered file. Unattached, the gateway adds no credential.

cache

Selector
datastore.aggrega.ai/engine=kv
Inject
—

Slots each connection through this socket may fill

SlotSelectorRequiredInjectSensitiveDescription
credentialfeature.aggrega.ai/kind=secretno—yesOptional password the gateway's rate-limit service presents to the Redis-protocol store this connection reaches. When attached, the Recipe hands the service a reference to the Secret the credential publishes, under the data key it publishes, and the service reads the password from that Secret in the gateway's namespace, so the password appears in no rendered file; a credential publishing no Secret name and data key halts the build. Unattached, the service connects with no password, which is what the shipped store components expect by default.
server_cafeature.aggrega.ai/kind=secretnofileyesOptional authority the gateway's rate-limit service checks the store's certificate against while the store publishes protocol valkey-tls or redis-tls, where the image does not already trust the authority that signs it. Its Secret holds ca.crt and sits in the gateway's namespace, where the service runs. The Recipe mounts the whole Secret into the service and points the service at the file. The build halts on a server_ca publishing no Secret name, and on one wired to a store served without TLS. Fill it with core/referenced-secret.

Attachment slots

Named binding points at which a Feature attaches to this component. A slot's selector constrains which Feature may fill it and its inject list names how the Feature's material may be delivered. A required slot must be bound on every instance, by an attachment on the instance or at a scope above it, and a sensitive slot is declared to handle secret material. A Feature may also attach under a name no slot declares.

No attachment slots declared.

Self-inject allowlist

No self-inject pipes declared.

Relationships

Typed edges to and from other published entities. A reference with no published target renders as a broken edge rather than a link.

Uses

Used by

Component concept reference →

The Aggrega catalog — an open index of components, features, recipes, and the plugins that render them.

Built with the shared Aggrega design system.

Privacy