本页面为机器翻译。阅读英文原文。

Component

core/gateway/agentgateway

agentgateway, an open-source gateway for model, tool and agent traffic, serving the OpenAI chat-completions API in front of the models wired to it. It terminates client HTTP traffic on its data-plane port, publishes that port's host, port and protocol, and runs from one configuration file. Each model wired to its models socket is served under the connection's alias: a request names the alias as its model at the gateway's one /v1 base URL, and is sent to the endpoint and model name the model publishes, presenting that connection's credential. It publishes that base URL as its endpoint and values.model as its model, so an agent's model socket takes it in place of a model; with nothing wired it serves no model and both are empty. A Release may name its callers in infra.callers, their keys through the caller_keys slot; every model request must then present a declared key as `Authorization: Bearer <key>`. Two realizations run the same image, pinned by digest. On Kubernetes, `agentgateway-chart` renders the project's standalone Helm chart, fetched from the project's registry, and realizes data masking, prompt deny patterns, the period budget, audit logging and the retry policy; the fallback chain, target selection, the semantic cache, response validation and the prompt-injection shield halt the build there, each naming why. Under Docker Compose, `agentgateway` runs it as one service and realizes none of them, nor callers, so an attachment halts the build naming its type. With `values.metrics_enabled` true each Recipe publishes the address of the gateway's metrics, always on, on a port that checks no caller, as `metrics_endpoint`; false, that key is empty.

来源

官方由本目录认定为官方发布者的签名身份签名。
内容摘要
sha256:f5492abed6926aaa7a2eb24792e5d8ce4e330c6bb38abce3fcf062b0ddab7d1d
发布时间
2026-11-10T10:11:36Z
签名身份
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

签名

  • 官方application/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:aa49f49c4376940a1cd50e5e440b56616e25622891d38e12189dbe8eb33246db

此版本的引用

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

开发者参数

开发者在 Aggregate 中设置的值。

名称类型默认值必需描述
modelstring—否The alias of a connection on the models socket that this gateway publishes as its model, the model name a consumer wired to it 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.
metrics_enabledbooleanfalse否Publishes the address of the gateway's own metrics, in the Prometheus format, as `metrics_endpoint`, putting their port on a Service where a realization needs one; while false that key is empty. The metrics port checks no caller, so anything that reaches it can read them.

运维规格

运维人员按环境调整的基础设施规格。

名称类型默认值必需描述
http_portinteger (min 1024, max 65535)4000否Data-plane port consumers connect to.
callersarray (min 1)—否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 request then has to present a declared key — one presenting none, or an unknown one, is refused with HTTP 401 — and the key is removed from the request the gateway forwards. 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 `agentgateway-chart`; the compose realization halts the build on it. Omit it for open routes.
storageobject—否—
source_versionstring—否Version of the standalone Helm chart the chart-backed realization pulls. The realization holds the chart versions its configuration is proven at, and the build halts naming them on any other. The compose realization pulls no chart and ignores it.
computeobject—否—
overridesobject (open)—否Provider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

输出契约

此组件通过 uses 拓扑向使用方发布的值。

名称类型默认值必需描述
hoststring—是DNS name of the Service, or the compose service, fronting the gateway's data plane, the name alone without a namespace. A consumer sends its client traffic here rather than to the model behind the gateway.
portinteger—是TCP port that address accepts model traffic on, infra.http_port.
protocolstring—否How the published address is spoken to — `http`, so a consumer composes an address on that scheme.
endpointstring—否Full base URL of the OpenAI-compatible API the gateway serves, with the host, the port and /v1 composed. 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 base URL under its own alias. Empty while nothing is wired to the models socket.
modelstring—否The alias a consumer wired to the gateway sends as its model name: values.model. The gateway sends the request on asking for the model name the wired model publishes. Empty while nothing is wired to the models socket.
metrics_endpointstring—否The full address Prometheus scrapes this component's metrics at — scheme, host, port and path, `http://<host>:15020/metrics`. Empty while values.metrics_enabled is false.

uses 套接字

此组件用于建立连接的依赖套接字。通过某个套接字接入的每个连接,其目标都必须满足该套接字的标签选择器,且每个连接都可以在该套接字声明的槽位中携带附加项。必需槽位须由 Aggregate 或 Release 通过该套接字接入的每个连接来填充。

models

选择器
component.aggrega.ai/category=ai-model
注入
—

经由此套接字的每个连接可填充的槽位

槽位选择器必需注入敏感描述
credentialfeature.aggrega.ai/kind=secret否env是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 — a Kubernetes secretKeyRef to the Secret the credential publishes on the chart realization, which halts the build when it publishes none, and the value the credential publishes under that name on the inject pipe on compose — and the connection's model entry names $AI_PROXY_<ALIAS>_API_KEY, which agentgateway replaces from its environment, never the value. The key must be a plain token — letters, digits and - . _ ~ + / = — because agentgateway reads the file as YAML after putting the key into it, and other characters can load as a different key or stop the gateway. Unattached, the entry adds no credential.

附加槽位

Feature 附加到此组件时所用的命名绑定点。槽位的选择器限定哪个 Feature 可以填充该槽位,其 inject 列表则指明 Feature 的内容可以如何交付。必需槽位必须在每个实例上完成绑定,可以通过实例上的附加,也可以通过其上层作用域的附加;敏感槽位则声明为用于处理机密内容。Feature 也可以以任何槽位都未声明的名称进行附加。

槽位选择器必需注入敏感描述
caller_keysfeature.aggrega.ai/kind=secret否env是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 the configuration names $CALLER_<NAME>_KEY, never the key. Each key must be a plain token — letters, digits and - . _ ~ + / = — because agentgateway reads the file as YAML after putting the key into it, and other characters can load as a different key or stop the gateway. 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. A request presenting an empty key is refused. A key changed inside the Secret takes effect when the gateway's pod next starts, so the key it replaces is accepted until then.

自注入允许列表

env

关系

与其他已发布实体之间的类型化边。没有已发布目标的引用会呈现为断开的边,而不是链接。

使用

被使用

Component 概念参考 →

Aggrega 目录 — 收录组件、功能、配方以及渲染它们的插件的开放索引。

基于共享的 Aggrega 设计系统构建。

隐私