Esta página se tradujo automáticamente. Leer el original en inglés.

Component

core/gateway/apisix

Apache APISIX, an API gateway. APISIX terminates client HTTP traffic on its proxy port and publishes that port's host, port and protocol. While nothing is wired to its models socket it routes by configuration held in the etcd store wired to its `etcd` socket, written through an Admin API reachable in-cluster only and authenticated by the key attached to `admin_key`; both are then required. It holds no state of its own. It also serves models: each one wired to its models socket gets a chat route, and a completion route unless a period budget or a prompt guard is attached, through APISIX's AI proxy, at /<alias>/v1 under the connection's alias, sent to the endpoint and model name the model publishes and presenting that connection's credential. Those routes are rendered into a file the gateway reads, so with a model wired it reads no etcd and runs no Admin API, and an `etcd` connection or an `admin_key` attachment halts the build. It publishes values.model's route as its endpoint and that alias as its model, so an agent's model socket takes it in place of a model; with nothing wired both are empty. On Kubernetes the Manifest chooses between two realizations. `apisix` synthesizes a workload with a hand-written configuration file and fetches nothing; it serves no model and halts on a models connection. `apisix-chart` renders the project's own Helm chart, which assembles that configuration from named settings; it serves the models, their callers and the controls attached to them. With `values.metrics_enabled` true, both serve the gateway's own metrics, asking no credential, and publish their address as `metrics_endpoint`; false, that key is empty.

Procedencia

OficialFirmado por una identidad de firma que este catálogo reconoce como editor oficial.
Digest del contenido
sha256:4e088801181b19ecf4aab1e053711760de321bffb6b36bbf1961b9e1a0cc5274
Publicado
2026-11-10T10:11:40Z
Identidad de firma
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Firma

  • 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:9fb756fd0aeb866439da0421ca2c6162d4d0efee2944cf34a1abca4cfdb605a3

Referencia en esta versión

oci://hub.aggrega.ai/component/core/gateway/apisix:1.0.0

Parámetros del desarrollador

Valores que el desarrollador establece en el Aggregate.

NombreTipoPredeterminadoObligatorioDescripción
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_enabledbooleanfalsenoTurns on the gateway's own metrics, in the Prometheus format, and publishes their address as `metrics_endpoint`; while false that key is empty. The port they are served on checks no caller, so anything that reaches it can read them.

Dimensionamiento del operador

Dimensionamiento de la infraestructura que el operador ajusta para cada entorno.

NombreTipoPredeterminadoObligatorioDescripción
http_portinteger (min 1024, max 65535)9080noProxy data-plane port consumers connect to.
admin_portinteger (min 1024, max 65535)9180noAdmin API port, reachable in-cluster only. Read only while nothing is wired to the models socket; with a model wired the gateway runs no Admin API.
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 with HTTP 401, removes the key from the request it forwards, and sends the caller's name to the model in an X-Consumer-Username header. A name takes letters, digits, hyphens and underscores, and is also the data key holding that caller's key in the Secret the caller_keys slot names. Read by `apisix-chart` while a model is wired; with nothing wired, or with `apisix`, the build halts on it. Omit it for open routes.
engine_versionstring3.17.0-debiannoApache APISIX container image tag. Selects the image tag on container targets; the chart-backed realization pins its own image tag.
source_versionstring—noVersion of the Helm chart the chart-backed realization pulls. Read only by that realization; the workload-synthesis realization pulls no source artifact and ignores it. 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.

Contrato de salida

Valores que este componente publica para los consumidores a través de la topología uses.

NombreTipoPredeterminadoObligatorioDescripción
hoststring—síIn-cluster DNS name of the Service fronting the proxy data plane. A consumer sends its client traffic here rather than to the service behind the gateway.
portinteger—síTCP port that Service accepts proxied traffic on. It carries the data-plane port an operator set, never the Admin API port, which stays in-cluster.
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>:9091/apisix/prometheus/metrics`. Empty while values.metrics_enabled is false.

Sockets uses

Los sockets de dependencia a través de los cuales se conecta este componente. El destino de cada conexión cableada a través de un socket debe satisfacer su selector de etiquetas, y cada conexión puede llevar un acoplamiento en los slots que declara el socket. Cada conexión que el Aggregate o la Release cablea a través del socket debe llenar los slots obligatorios.

etcd

Selector
component.aggrega.ai/type=stateful-server
Inyección
env

Este socket no declara slots de acoplamiento, por lo que una conexión a través de él no lleva ningún acoplamiento.

models

Selector
component.aggrega.ai/category=ai-model
Inyección
—

Slots que cada conexión a través de este socket puede llenar

SlotSelectorObligatorioInyecciónSensibleDescripción
credentialfeature.aggrega.ai/kind=secretnoenvsíOptional credential the gateway presents to the model this connection reaches, as a bearer token. When attached, the Recipe delivers it as AI_PROXY_<ALIAS>_API_KEY, the connection's alias in capitals with every character other than a letter or a digit as an underscore, by a Kubernetes secretKeyRef, composes the bearer token AI_PROXY_<ALIAS>_AUTHORIZATION from it, and the connection's routes read that token through APISIX's $env:// reference, naming the variable rather than the value. Unattached, the route adds no credential.

cache_store

Selector
datastore.aggrega.ai/engine=kv
Inyección
—

Slots que cada conexión a través de este socket puede llenar

SlotSelectorObligatorioInyecciónSensibleDescripción
credentialfeature.aggrega.ai/kind=secretnoenvsíOptional password the gateway's semantic cache presents to the store this connection reaches. When attached while core/semantic-caching is attached, the Recipe delivers it as CACHE_STORE_PASSWORD by a Kubernetes secretKeyRef, and the cache reads it through APISIX's $env:// reference, naming the variable rather than the value; attach a credential holding the password the store itself requires, which must publish the name of a Secret and the data key holding it there. Unattached, the cache connects without a password, which suits a store with none.

Slots de acoplamiento

Puntos de enlace con nombre en los que una Feature se acopla a este componente. El selector de un slot restringe qué Feature puede llenarlo y su lista inject indica cómo puede entregarse el material de la Feature. Un slot obligatorio debe estar enlazado en cada instancia, mediante un acoplamiento en la instancia o en un ámbito superior, y un slot sensible se declara para manejar material secreto. Una Feature también puede acoplarse con un nombre que ningún slot declara.

SlotSelectorObligatorioInyecciónSensibleDescripción
admin_keyfeature.aggrega.ai/kind=secretnoenvsíThe key authenticating the gateway's Admin API, which a caller presents in the X-API-KEY header. The attached credential must publish the name of a Secret and the data key holding the key there; each Recipe delivers the key from that Secret to the gateway as an environment variable, and a credential publishing no such locator halts the build. Required while nothing is wired to the models socket, with no default: with no credential attached then, the build halts. While a model is wired the gateway runs no Admin API, and an attachment here halts the build. The key must not be empty, which stops the gateway at start-up, and must not be a value APISIX reads as a number or as true or false, such as an all-digit key, because APISIX then never matches it against the key a request presents.
caller_keysfeature.aggrega.ai/kind=secretnoenvsíThe Secret holding the key each caller infra.callers declares presents to the gateway, one data key per caller, the data key being the caller's name. The attached credential must publish the Secret's name, as core/referenced-secret-set does, and a credential publishing none halts the build. The chart Recipe delivers each key as CALLER_<NAME>_KEY, the caller's name in capitals with every character other than a letter or a digit as an underscore, by a Kubernetes secretKeyRef, and composes CALLER_<NAME>_AUTHORIZATION, the whole Authorization header a caller presents, from it; the caller's consumer in the routes file reads that header through APISIX's $env:// reference. Required while infra.callers declares a caller, and refused while it declares none. A caller with no data key of its name in the Secret leaves the gateway unable to start, since Kubernetes starts no container whose secretKeyRef names a missing key; that is caught at start, not by the build.

Lista de permitidos de autoinyección

env

Relaciones

Aristas tipadas hacia y desde otras entidades publicadas. Una referencia sin un destino publicado se muestra como una arista rota en lugar de como un enlace.

Usa

Usado por

Referencia del concepto Component →

El catálogo de Aggrega — un índice abierto de componentes, funcionalidades, recetas y los plugins que los renderizan.

Creado con el sistema de diseño compartido de Aggrega.

Privacidad