Cette page a été traduite automatiquement. Lire l’original en anglais.

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.

Provenance

OfficielSigné par une identité de signature que ce catalogue reconnaît comme éditeur officiel.
Empreinte du contenu
sha256:201da649bd0f7f8e28f27a6d5363a44245d5b9511a49f376a7e3e35c814a3631
Publié
2026-11-10T10:11:58Z
Identité de signature
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signature

  • Officielapplication/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

Référence à cette version

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

Paramètres du développeur

Valeurs que le développeur définit dans l’Aggregate.

NomTypeValeur par défautObligatoireDescription
modelstring—nonThe 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_enabledbooleanfalsenonMakes 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.

Dimensionnement de l’opérateur

Dimensionnement de l’infrastructure que l’opérateur ajuste pour chaque environnement.

NomTypeValeur par défautObligatoireDescription
proxy_portinteger (min 1024, max 65535)8000nonProxy data-plane port consumers connect to.
admin_portinteger (min 1024, max 65535)8001nonAdmin API port, reachable in-cluster only.
engine_versionstring3.9.3nonKong gateway container image tag. Selects the image tag on container targets; the chart-backed realization pins its own image tag.
source_versionstring—nonVersion 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—non—
overridesobject (open)—nonProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Contrat de sortie

Valeurs que ce composant publie vers les consommateurs via la topologie uses.

NomTypeValeur par défautObligatoireDescription
hoststring—ouiIn-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—ouiTCP 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—nonHow the published address is spoken to — `http`, so a consumer composes an address on that scheme.
endpointstring—nonFull 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—nonThe 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—nonThe 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.

Sockets uses

Les sockets de dépendance par lesquels ce composant se connecte. La cible de chaque connexion câblée via un socket doit satisfaire son sélecteur d’étiquettes, et chaque connexion peut porter une attache dans les emplacements que le socket déclare. Un emplacement obligatoire doit être rempli par chaque connexion que l’Aggregate ou la Release câble via le socket.

backend

Sélecteur
component.aggrega.ai/type=stateful-server
Injection
env

Emplacements que chaque connexion passant par ce socket peut remplir

EmplacementSélecteurObligatoireInjectionSensibleDescription
credentialfeature.aggrega.ai/kind=secretnonenvouiOptional 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

Sélecteur
component.aggrega.ai/category=ai-model
Injection
—

Emplacements que chaque connexion passant par ce socket peut remplir

EmplacementSélecteurObligatoireInjectionSensibleDescription
credentialfeature.aggrega.ai/kind=secretnonenvouiOptional 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.

Emplacements d’attache

Points de liaison nommés auxquels une Feature s’attache à ce composant. Le sélecteur d’un emplacement restreint la Feature qui peut le remplir, et sa liste inject indique comment le matériel de la Feature peut être livré. Un emplacement obligatoire doit être lié sur chaque instance, par une attache sur l’instance ou à une portée supérieure, et un emplacement sensible est déclaré pour traiter du matériel secret. Une Feature peut aussi s’attacher sous un nom qu’aucun emplacement ne déclare.

Aucun emplacement d’attache déclaré.

Liste d’autorisation d’auto-injection

env

Relations

Arêtes typées vers et depuis d’autres entités publiées. Une référence sans cible publiée s’affiche comme une arête rompue plutôt que comme un lien.

Utilise

Utilisé par

Référence du concept Component →

Le catalogue Aggrega — un index ouvert de composants, de fonctionnalités, de recettes et des plugins qui en assurent le rendu.

Conçu avec le système de design partagé d’Aggrega.

Confidentialité