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

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:952bd390d6f5706f2a7a36572b61ec9a0a34a1c1010ab95921cb4ef564f1e962
Published
2026-11-10T10:12:21Z
Signing identity
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signature

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

Reference at this version

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

Developer parameters

Values the developer sets in the Aggregate.

No developer parameters declared.

Operator sizing

Infrastructure sizing the operator tunes per environment.

NameTypeDefaultRequiredDescription
portinteger (min 1024, max 65535)8080noData-plane port consumers connect to. Most operators should omit this and let the Recipe assign the default (8080).
engine_versionstringv5.14.0noGateway 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—noSource artifact version (Helm chart). Overrides the Recipe's default source version. Changing from default does not guarantee value mapping compatibility.
computeobject—no—
overridesobject (open)—noProvider-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.

Output contract

Values this component publishes to consumers over the uses topology.

NameTypeDefaultRequiredDescription
hoststring—yesIn-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—yesTCP 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—noHow the published address is spoken to — `http`, so a consumer composes an address on that scheme.

Uses sockets

The dependency sockets this component connects through. The target of every connection wired through a socket must satisfy its label selector, and each connection may carry an attachment in the slots the socket declares. A required slot is owed by each connection the Aggregate or the Release wires through the socket.

cache

Selector
component.aggrega.ai/category=datastore
Inject
env

Slots each connection through this socket may fill

SlotSelectorRequiredInjectSensitiveDescription
credentialfeature.aggrega.ai/kind=secretnoenvyesOptional 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=secretnofileyesOptional 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.

Attachment slots

Named binding points at which a Feature attaches to this component. A slot's selector constrains which Feature may fill it and its inject list names how the Feature's material may be delivered. A required slot must be bound on every instance, by an attachment on the instance or at a scope above it, and a sensitive slot is declared to handle secret material. A Feature may also attach under a name no slot declares.

No attachment slots declared.

Self-inject allowlist

env

Relationships

Typed edges to and from other published entities. A reference with no published target renders as a broken edge rather than a link.

Uses

Used by

Component concept reference →

The Aggrega catalog — an open index of components, features, recipes, and the plugins that render them.

Built with the shared Aggrega design system.

Privacy