Component

core/gateway/traefik-hub

Traefik Hub, Traefik's paid gateway: the Traefik proxy run from Traefik Hub's own image, with an API gateway and an AI gateway a licence token unlocks. It serves each model wired to its models socket at /<alias>/v1/chat/completions through Traefik Hub's Chat Completion middleware. The operator supplies the image: Traefik distributes Traefik Hub under its own terms, so the Release names in infra.image one it is entitled to pull, and the catalog names none. Nothing renders until the Release sets `infra.image`. The licence token reaches the gateway by reference to a Secret in the required license slot. A Release may name its callers in infra.callers and their key hashes through the caller_keys slot; every model route then refuses a request with no declared key, and removes the key before forwarding. Through Traefik Hub's AI gateway it realizes core/period-budget, core/prompt-deny-patterns, core/semantic-caching and core/data-masking, each halting the build until infra.ai_gateway_entitled affirms the licence carries it; through Traefik's own failover and retry, core/fallback-chain and core/retry-policy. core/prompt-injection-shield, audit logging, target selection and reply validation halt, naming why. Traefik requires outbound HTTPS to api.traefik.io, where the gateway validates its token. A token lasts a year by default, and the gateway stops once it expires. The compiler validates no token and contacts no vendor, so a clean build cannot say whether the gateway starts, serves or enforces anything. With `values.metrics_enabled` true a ClusterIP Service carries the gateway's metrics port, which checks no caller, and the address is published as `metrics_endpoint`; false, that key is empty.

Provenance

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:ccee49dd01d18080a3162e69f7b3ba53209da8d4adcd4a903ba976af0f793e69
Published
2026-11-10T10:12:20Z
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:ec68a5d07aec08fcb69382bc4b089e25925c128b040218e8fb5dc9d9d2c673aa

Reference at this version

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

Developer parameters

Values the developer sets in the Aggregate.

NameTypeDefaultRequiredDescription
modelstring—noThe alias of a connection on the models socket that this gateway publishes as its model, and whose route its published endpoint addresses. 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.
metrics_enabledbooleanfalsenoPublishes the address of the gateway's own metrics, in the Prometheus format, as `metrics_endpoint`, putting their port on a ClusterIP Service of its own; while false that key is empty. The metrics port checks no caller, so anything that reaches it can read them.

Operator sizing

Infrastructure sizing the operator tunes per environment.

NameTypeDefaultRequiredDescription
portinteger (min 1024, max 65535)8000noPort the gateway listens on for plain HTTP and its Service accepts client traffic on. Most operators should omit this and let the Recipe assign the default (8000).
imagestring—yesFull reference of the Traefik Hub image the gateway runs, tag included, as in ghcr.io/traefik/traefik-hub:v3.21.2, optionally followed by a digest — the image the operator is entitled to pull. There is no default, because access to the image is governed by Traefik's terms rather than by the catalog, and the catalog therefore names none. A build that omits the image, or names one with no tag, halts. Traefik's chart reads the gateway's version from the tag and refuses an image whose repository path does not contain traefik-hub.
image_pull_secretstring—noName of a pre-created image-pull Secret granting access to the registry the image is pulled from. Set this when that registry needs credentials; omit it when the cluster can pull the image without them.
callersarray (min 1)—noThe callers the gateway serves models to, by name, each presenting its own key in the Authorization header as `Bearer <key>`, which is how an OpenAI client presents one. Every model route then refuses a request presenting no declared key, and removes the Authorization header from the request it forwards, so a caller's key never reaches a model. A name takes letters, digits, hyphens and underscores, and is also the data key holding the htpasswd hash of that caller's key in the Secret the caller_keys slot names. A model must be wired to the models socket; the build halts on callers otherwise. Omit it for open routes.
ai_gateway_entitledbooleanfalsenoAffirms that the licence the license slot names carries Traefik Hub's AI gateway, through whose middlewares core/period-budget, core/prompt-deny-patterns, core/semantic-caching and core/data-masking are kept here. The compiler runs ahead of time and never reads the licence, so it asks rather than checks. With any of those four attached and this left unaffirmed, the build halts, because what Traefik Hub does with a valid token whose licence lacks the AI gateway is undocumented. With none attached it changes nothing rendered.
source_versionstring—noVersion of the Helm chart the realization pulls. Changing it away from the Recipe's default does not guarantee value-mapping compatibility with the new chart.
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—yesIn-cluster DNS name of the Service fronting the gateway. A consumer sends its client traffic here rather than to the service behind the gateway.
portinteger—yesTCP port that Service accepts client traffic on. It follows the port an operator set in the Release, so a consumer reads it rather than assuming a default.
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 model values.model names, with the host, the port and that alias's route already composed. A caller hands it to a client library as its base URL. Every other wired model is served at the same host and port under its own alias in the path. 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 route behind the endpoint asks for the model it was written for whatever name a request carries. Empty while nothing is wired to the models socket.
metrics_endpointstring—noThe full address Prometheus scrapes this component's metrics at — scheme, host, port and path, `http://<host>:9100/metrics`, the host being the Service carrying the metrics port. Empty while values.metrics_enabled is false.

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.

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 Chat Completion middleware names the Secret the credential publishes and the data key inside it, and Traefik Hub reads the key from that Secret, so the key appears in no rendered file; a credential publishing no Secret name and data key halts the build. 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 quota middleware presents to the Redis-protocol store this connection reaches. When attached, the quota names the Secret the credential publishes and the data key inside it, and Traefik Hub 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 quota connects with no password.
server_cafeature.aggrega.ai/kind=secretnofileyesOptional authority the gateway's quota middleware checks the store's certificate against while the store publishes protocol valkey-tls or redis-tls, where the gateway does not already trust the authority that signs it. Its Secret holds ca.crt and sits in the gateway's namespace. The Recipe mounts the whole Secret read-only into the gateway and names the file in the quota's store settings. 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.

cache_store

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 semantic cache presents to the store this connection reaches. When attached while core/semantic-caching is attached, the cache names the Secret the credential publishes and the data key inside it, and Traefik Hub 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 cache connects without a password.
server_cafeature.aggrega.ai/kind=secretnofileyesOptional authority the gateway's semantic cache checks the store's certificate against while the store publishes protocol valkey-tls or redis-tls, where the gateway does not already trust the authority that signs it. Its Secret holds ca.crt and sits in the gateway's namespace. While core/semantic-caching is attached, the Recipe mounts the whole Secret read-only into the gateway and names the file in the cache's store settings. 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.

pii_analyzer

Selector
security.aggrega.ai/text-anonymization=analyzer
Inject
—

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

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.

SlotSelectorRequiredInjectSensitiveDescription
licensefeature.aggrega.ai/kind=secretyes—yesThe Traefik Hub licence token, held in a Kubernetes Secret this attachment names under the data key token: the gateway reads it by reference to that Secret, never as a value written into the Release or the rendered output. Required: the build halts when no attachment binds it, and when the attachment publishes a data key other than token.
caller_keysfeature.aggrega.ai/kind=secretno—yesThe Secret holding, for each caller infra.callers declares, the htpasswd hash of the key that caller presents — bcrypt, SHA-1 or MD5, as Traefik Hub's API Key middleware takes it — under a data key named for the caller. The attached credential must publish the Secret's name, as core/referenced-secret-set does, and a credential publishing none halts the build. Each model route's key check names every caller's entry by reference to this Secret, in the gateway's namespace, so no rendered file carries a hash. Required while infra.callers declares a caller, and refused while it declares none. What Traefik Hub does with an entry naming a Secret or a data key that does not exist is not stated in its reference, and the case is neither read nor run: Traefik Hub's source is not published, and the catalog holds no licence token to run it. So it is caught, if at all, only at run time, and in the worst case the routes are as open as with no callers 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