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

Component

core/gateway/kong

Kong, a database-backed API gateway. It routes client traffic by configuration held in the PostgreSQL backend wired to its `backend` socket; a migrations step provisions the schema before the gateway serves. The database is the system of record, so Kong renders as a stateless server. It publishes its proxy host, port and protocol. It also serves models: each one wired to its models socket gets a route through Kong'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. 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. A core/prompt-deny-patterns attachment puts Kong's AI Prompt Guard on every one of those routes, where it stays once the attachment is removed. On Kubernetes the Manifest chooses between two realizations. `kong` synthesizes a workload with its bootstrap steps ahead of it and fetches nothing, for a build with no chart repository reachable. `kong-chart` renders the official Kong Helm chart, which also migrates the schema on either side of an upgrade, for a gateway upgraded in place. With `values.metrics_enabled` true each Recipe publishes Kong's metrics, /metrics on its Status API port, as `metrics_endpoint`; false, that key is empty. From another address that port answers a GET of /status, /status/ready or /metrics, with no caller check, and refuses every other request, POST /status/ready among them. On Kubernetes it is already open on the pod and the value names it on a Service; on Docker Compose the value newly opens it to every peer on the network.

来源

官方由本目录认定为官方发布者的签名身份签名。
内容摘要
sha256:201da649bd0f7f8e28f27a6d5363a44245d5b9511a49f376a7e3e35c814a3631
发布时间
2026-11-10T10:11:58Z
签名身份
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:9191738ab434bbd7188696956cebe55890663c993e802d2edeed0235025f0644

此版本的引用

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

开发者参数

开发者在 Aggregate 中设置的值。

名称类型默认值必需描述
modelstring—否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_enabledbooleanfalse否Makes Kong's own metrics, in the Prometheus format at /metrics on its Status API port, reachable and publishes their address as `metrics_endpoint`; while false that key is empty. From another address the port answers a GET of /metrics, /status/ready or /status (memory, connections and database reachability), with no caller check, and refuses every other request, POST /status/ready, which with status=draining would take the gateway out of readiness, among them. On Kubernetes the port is already open on the pod, and naming it on a Service adds no audience; on Docker Compose the value newly opens it to every peer on the network.

运维规格

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

名称类型默认值必需描述
proxy_portinteger (min 1024, max 65535)8000否Proxy data-plane port consumers connect to.
admin_portinteger (min 1024, max 65535)8001否Admin API port, reachable in-cluster only.
engine_versionstring3.9.3否Kong gateway container image tag. Selects the image tag on container targets; the chart-backed realization pins its own image tag.
source_versionstring—否Version 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—否—
overridesobject (open)—否Provider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

输出契约

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

名称类型默认值必需描述
hoststring—是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—是TCP port that Service accepts proxied traffic on. It carries the proxy port an operator set, never the Admin API port, which stays in-cluster.
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 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—否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_endpointstring—否The full address Prometheus scrapes this component's metrics at — scheme, host, port and path, `http://<host>:<status port>/metrics`, the host being the Service a realization puts the Status API port on. Empty while values.metrics_enabled is false.

uses 套接字

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

backend

选择器
component.aggrega.ai/type=stateful-server
注入
env

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

槽位选择器必需注入敏感描述
credentialfeature.aggrega.ai/kind=secret否env是Optional password the gateway presents to the backend this connection reaches, shared with that backend. When attached, supplies the backend password via the credential subsystem. Unattached, compose/kong, helm/kong and helm/kong-chart present the development literal `apppass`, which this catalog publishes, so every Release that leaves the slot unattached shares that password.

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 on helm, the value the credential publishes under that name on the inject pipe on compose — and the connection's route reads the token through Kong's environment vault, naming the variable rather than the value. Unattached, the route adds no credential.

附加槽位

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

未声明附加槽位。

自注入允许列表

env

关系

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

使用

被使用

Component 概念参考 →

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

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

隐私