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

Component

core/gateway/kong-enterprise

Kong Gateway Enterprise, Kong's paid edition of its database-backed API gateway. Like core/gateway/kong it routes client traffic by configuration held in the PostgreSQL backend wired to its backend socket, and serves each model wired to its models socket at /<alias>/v1 through Kong's AI proxy. The image is supplied by the operator: Kong distributes the enterprise image under its own terms, so the Release names in infra.image one it is entitled to pull, version tag included, and the catalog names none. Nothing renders until the Release sets `infra.image`. The licence reaches the gateway by reference to a Secret bound to the required license slot, never as a value. The compiler validates no licence and contacts no vendor, so a Release that builds cleanly says nothing about one. Kong reads the licence as a node starts, and a node with no valid licence behaves as with an expired one: its entity configuration becomes read-only and proxy traffic is served with the configuration already in place. Kong sells its AI plugins as its AI Gateway Enterprise offering, an entitlement no build can see, so an AI Feature halts the build until infra.ai_gateway_entitled affirms it. Realized on Kubernetes by kong-enterprise-chart, over the official Kong Helm chart; there is no compose realization. With `values.metrics_enabled` true the Recipe puts the gateway's Status API port on a ClusterIP Service of its own and publishes /metrics there as `metrics_endpoint`; false, neither. The port is already open on the pod: from another address it answers a GET of /status, /status/ready or /metrics, with no caller check, and refuses every other request, POST /status/ready and any route the image adds among them.

Provenance

OfficielSigné par une identité de signature que ce catalogue reconnaît comme éditeur officiel.
Empreinte du contenu
sha256:dc46a6d0308ddbca412fc5d5d92871c1d32c586360d38bf4a53fdc2b82785603
Publié
2026-11-10T10:11:55Z
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:b41af5830ae0f6a10e388791d7fd7e8e5cba9a9bea92054d08b5779ca550bdc5

Référence à cette version

oci://hub.aggrega.ai/component/core/gateway/kong-enterprise: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 the gateway's own metrics, in the Prometheus format at /metrics on its Status API port, reachable on a ClusterIP Service 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, and any route the enterprise image adds among them. It is already open on the pod, and naming it on a Service adds no audience.

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.
imagestring—ouiFull reference of the Kong Gateway Enterprise image the gateway runs, version tag included, as in kong/kong-gateway:3.16.0.0, 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 Kong's terms rather than by the catalog, and the catalog therefore names none. The tag must begin with the gateway's version, which the chart reads from it; a build that omits the image, or names one whose tag carries no version, halts.
image_pull_secretstring—nonName 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.
ai_gateway_entitledbooleanfalsenonAffirms that the licence the license slot names carries Kong's AI Gateway Enterprise entitlement, under which Kong sells the plugins its AI Features run on. The compiler runs ahead of time and never reads the licence, so it asks rather than checks. With core/semantic-caching, core/period-budget, core/data-masking, core/fallback-chain, core/retry-policy or core/target-selection attached and this left unaffirmed, the build halts, because Kong skips an AI plugin the licence does not entitle silently rather than refusing it.
source_versionstring—nonVersion 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.
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 the 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, helm/kong-enterprise-chart presents 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, as a Kubernetes secretKeyRef, 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.

pii_sanitizer

Sélecteur
security.aggrega.ai/text-anonymization=sanitizer
Injection
—

Ce socket ne déclare aucun emplacement d’attache, donc une connexion qui le traverse ne porte aucune attache.

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.

EmplacementSélecteurObligatoireInjectionSensibleDescription
licensefeature.aggrega.ai/kind=secretoui—ouiThe Kong Gateway Enterprise licence, held in a Kubernetes Secret this attachment names: 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.

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é