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

Component

core/gateway/tyk

Tyk Gateway, a self-hosted API gateway. The gateway terminates client traffic on its data plane and routes it to the services its API definitions name. It keeps its keys, rate-limit counters and session state in a Redis-protocol store wired through its `cache` uses-socket: the store's host and port arrive on the injection context and compose the gateway's storage connection. That store is the gateway's one prerequisite — it needs no management console and no licence key to serve traffic — so the stack a Release stands up is the gateway and a Redis-protocol component and nothing else. The gateway holds no durable state of its own, so it renders as a stateless server. Realized on Kubernetes by a Recipe that points at the chart the gateway's own maintainers publish, and for local development by a Recipe that synthesizes a container from the same published image. It can pin the public key it accepts from an upstream it forwards to, which a Release asks for by attaching core/upstream-key-pinning; that realization's description states what setting one pin costs the upstreams that have none. Exports its data-plane host, port, and protocol to consumers via the uses topology.

Provenance

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

Référence à cette version

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

Paramètres du développeur

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

Aucun paramètre du développeur déclaré.

Dimensionnement de l’opérateur

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

NomTypeValeur par défautObligatoireDescription
portinteger (min 1024, max 65535)8080nonData-plane port consumers connect to. Most operators should omit this and let the Recipe assign the default (8080).
engine_versionstringv5.14.0nonGateway container image tag. It selects a tag and not a repository. Both Recipes read it: the Compose Recipe uses it for the container it synthesizes, and the chart-backed Recipe sets it on the chart's own image field so the render names one exact tag rather than whichever tag the chart happens to default to.
source_versionstring—nonSource artifact version (Helm chart). Overrides the Recipe's default source version. Changing from default does not guarantee value mapping compatibility.
computeobject—non—
overridesobject (open)—nonProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. Both Recipes read api_secret here, the gateway's own API secret; left unset, compose/tyk and helm/tyk use the development literal `tyk-development-secret`, which this catalog publishes, so every Release that leaves it unset shares that secret.

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 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 follows the port an operator set in the Release, so a consumer reads it rather than assuming a default.
protocolstring—nonHow the published address is spoken to — `http`, so a consumer composes an address on that scheme.

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.

cache

Sélecteur
component.aggrega.ai/category=datastore
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 Redis-protocol store this connection reaches. When attached, supplies the store password via the credential subsystem; unattached, the gateway connects with an empty password, which is what the shipped store components expect by default.
server_cafeature.aggrega.ai/kind=secretnonfileouiOptional authority the gateway checks the store's certificate against while the store publishes protocol valkey-tls or redis-tls, where the image does not already trust the authority that signs it. Its Secret holds ca.crt. The Kubernetes realization mounts the whole Secret read-only into the gateway and points it at the file; the Compose realization refuses it, since no credential Feature realized there delivers a Secret as files. The build halts on a server_ca publishing no Secret name, and on one wired to a store served without TLS. Fill it with core/referenced-secret.

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é