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.
Proveniência
- Digest do conteúdo
- sha256:ccee49dd01d18080a3162e69f7b3ba53209da8d4adcd4a903ba976af0f793e69
- Publicado
- 2026-11-10T10:12:20Z
- Identidade de assinatura
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Assinatura
- Oficialapplication/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
Referência nesta versão
oci://hub.aggrega.ai/component/core/gateway/traefik-hub:1.0.0Parâmetros do programador
Valores que o programador define no Aggregate.
| Nome | Tipo | Predefinição | Obrigatório | Descrição |
|---|---|---|---|---|
| model | string | — | não | The 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_enabled | boolean | false | não | Publishes 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. |
Dimensionamento do operador
Dimensionamento da infraestrutura que o operador ajusta por ambiente.
| Nome | Tipo | Predefinição | Obrigatório | Descrição |
|---|---|---|---|---|
| port | integer (min 1024, max 65535) | 8000 | não | Port 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). |
| image | string | — | sim | Full 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_secret | string | — | não | Name 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. |
| callers | array (min 1) | — | não | The 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_entitled | boolean | false | não | Affirms 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_version | string | — | não | Version 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. |
| compute | object | — | não | — |
| overrides | object (open) | — | não | Provider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
Contrato de saída
Valores que este componente publica para os consumidores através da topologia uses.
| Nome | Tipo | Predefinição | Obrigatório | Descrição |
|---|---|---|---|---|
| host | string | — | sim | In-cluster DNS name of the Service fronting the gateway. A consumer sends its client traffic here rather than to the service behind the gateway. |
| port | integer | — | sim | TCP 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. |
| protocol | string | — | não | How the published address is spoken to — `http`, so a consumer composes an address on that scheme. |
| endpoint | string | — | não | Full 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. |
| model | string | — | não | The 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_endpoint | string | — | não | The 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. |
Sockets uses
Os sockets de dependência através dos quais este componente se liga. O destino de cada ligação estabelecida através de um socket tem de satisfazer o respetivo seletor de etiquetas, e cada ligação pode transportar um acoplamento nos slots que o socket declara. Cada ligação que o Aggregate ou a Release estabelece através do socket tem de preencher os slots obrigatórios.
models
- Seletor
- component.aggrega.ai/category=ai-model
- Injeção
- —
Slots que cada ligação através deste socket pode preencher
| Slot | Seletor | Obrigatório | Injeção | Sensível | Descrição |
|---|---|---|---|---|---|
| credential | feature.aggrega.ai/kind=secret | não | — | sim | Optional 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
- Seletor
- datastore.aggrega.ai/engine=kv
- Injeção
- —
Slots que cada ligação através deste socket pode preencher
| Slot | Seletor | Obrigatório | Injeção | Sensível | Descrição |
|---|---|---|---|---|---|
| credential | feature.aggrega.ai/kind=secret | não | — | sim | Optional 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_ca | feature.aggrega.ai/kind=secret | não | file | sim | Optional 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
- Seletor
- datastore.aggrega.ai/engine=kv
- Injeção
- —
Slots que cada ligação através deste socket pode preencher
| Slot | Seletor | Obrigatório | Injeção | Sensível | Descrição |
|---|---|---|---|---|---|
| credential | feature.aggrega.ai/kind=secret | não | — | sim | Optional 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_ca | feature.aggrega.ai/kind=secret | não | file | sim | Optional 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
- Seletor
- security.aggrega.ai/text-anonymization=analyzer
- Injeção
- —
Este socket não declara slots de acoplamento, pelo que uma ligação através dele não transporta nenhum acoplamento.
Slots de acoplamento
Pontos de vinculação com nome nos quais uma Feature se acopla a este componente. O seletor de um slot restringe qual a Feature que o pode preencher, e a respetiva lista inject indica como o material da Feature pode ser entregue. Um slot obrigatório tem de estar vinculado em cada instância, por um acoplamento na instância ou num âmbito acima dela, e um slot sensível é declarado para tratar material secreto. Uma Feature também se pode acoplar com um nome que nenhum slot declara.
| Slot | Seletor | Obrigatório | Injeção | Sensível | Descrição |
|---|---|---|---|---|---|
| license | feature.aggrega.ai/kind=secret | sim | — | sim | The 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_keys | feature.aggrega.ai/kind=secret | não | — | sim | The 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. |
Lista de autorizações de autoinjeção
Nenhum canal de autoinjeção declarado.
Relações
Arestas tipadas de e para outras entidades publicadas. Uma referência sem destino publicado é apresentada como uma aresta quebrada em vez de uma ligação.
Usa
- usausa o socket «models»
component.aggrega.ai/category=ai-model
Slots de acoplamento: credential
core/ai-model/ai21 v1.0.0 →core/ai-model/anthropic v1.0.0 →core/ai-model/azure-managed v1.0.0 →core/ai-model/azure-openai v1.0.0 →core/ai-model/azure-openai-embedding v1.0.0 →core/ai-model/bedrock v1.0.0 →core/ai-model/bedrock-embedding v1.0.0 →core/ai-model/cohere v1.0.0 →core/ai-model/databricks v1.0.0 →core/ai-model/docker-model-runner v1.0.0 →core/ai-model/gemini v1.0.0 →core/ai-model/huggingface v1.0.0 →core/ai-model/litellm v1.0.0 →core/ai-model/mistral v1.0.0 →core/ai-model/nemoguard-content-safety v1.0.0 →core/ai-model/nvidia-api v1.0.0 →core/ai-model/nvidia-nim v1.0.0 →core/ai-model/nvidia-nim-operator v1.0.0 →core/ai-model/ollama v1.0.0 →core/ai-model/openai v1.0.0 →core/ai-model/openai-compatible v1.0.0 →core/ai-model/openai-embedding v1.0.0 →core/ai-model/replicate v1.0.0 →core/ai-model/sagemaker v1.0.0 →core/ai-model/tei v1.0.0 →core/ai-model/tgi v1.0.0 →core/ai-model/vertex-ai v1.0.0 →core/ai-model/vertex-ai-embedding v1.0.0 →core/ai-model/vllm v1.0.0 → - usausa o socket «cache»
datastore.aggrega.ai/engine=kv
Slots de acoplamento: credential, server_ca
- usausa o socket «cache_store»
datastore.aggrega.ai/engine=kv
Slots de acoplamento: credential, server_ca
- usausa o socket «pii_analyzer»
security.aggrega.ai/text-anonymization=analyzer
Não declara slots de acoplamento.
Usado por
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «model»
usa o socket «target_model»
usa o socket «extraction_model»
usa o socket «embedding_model»
usa o socket «upstream»
usa o socket «forward_target»
usa o socket «scrape_target»
usa o socket «store»
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
implementa