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.
Proveniência
- Digest do conteúdo
- sha256:952bd390d6f5706f2a7a36572b61ec9a0a34a1c1010ab95921cb4ef564f1e962
- Publicado
- 2026-11-10T10:12:21Z
- Identidade de assinatura
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Assinatura
- Oficialapplication/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
Referência nesta versão
oci://hub.aggrega.ai/component/core/gateway/tyk:1.0.0Parâmetros do programador
Valores que o programador define no Aggregate.
Nenhum parâmetro do programador declarado.
Dimensionamento do operador
Dimensionamento da infraestrutura que o operador ajusta por ambiente.
| Nome | Tipo | Predefinição | Obrigatório | Descrição |
|---|---|---|---|---|
| port | integer (min 1024, max 65535) | 8080 | não | Data-plane port consumers connect to. Most operators should omit this and let the Recipe assign the default (8080). |
| engine_version | string | v5.14.0 | não | Gateway 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_version | string | — | não | Source artifact version (Helm chart). Overrides the Recipe's default source version. Changing from default does not guarantee value mapping compatibility. |
| compute | object | — | não | — |
| overrides | object (open) | — | não | Provider-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. |
Contrato de saída
Valores que este componente publica para os consumidores através da topologia uses.
| Nome | Tipo | Predefinição | Obrigatório | Descrição |
|---|---|---|---|---|
| host | string | — | sim | In-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. |
| port | integer | — | sim | TCP 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. |
| protocol | string | — | não | How the published address is spoken to — `http`, so a consumer composes an address on that scheme. |
Sockets uses
Os sockets de dependência através dos quais este componente se liga. O destino de cada ligação estabelecida através de um socket tem de satisfazer o respetivo seletor de etiquetas, e cada ligação pode transportar um acoplamento nos slots que o socket declara. Cada ligação que o Aggregate ou a Release estabelece através do socket tem de preencher os slots obrigatórios.
cache
- Seletor
- component.aggrega.ai/category=datastore
- Injeção
- env
Slots que cada ligação através deste socket pode preencher
| Slot | Seletor | Obrigatório | Injeção | Sensível | Descrição |
|---|---|---|---|---|---|
| credential | feature.aggrega.ai/kind=secret | não | env | sim | Optional 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_ca | feature.aggrega.ai/kind=secret | não | file | sim | Optional 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. |
Slots de acoplamento
Pontos de vinculação com nome nos quais uma Feature se acopla a este componente. O seletor de um slot restringe qual a Feature que o pode preencher, e a respetiva lista inject indica como o material da Feature pode ser entregue. Um slot obrigatório tem de estar vinculado em cada instância, por um acoplamento na instância ou num âmbito acima dela, e um slot sensível é declarado para tratar material secreto. Uma Feature também se pode acoplar com um nome que nenhum slot declara.
Nenhum slot de acoplamento declarado.
Lista de autorizações de autoinjeção
env
Relações
Arestas tipadas de e para outras entidades publicadas. Uma referência sem destino publicado é apresentada como uma aresta quebrada em vez de uma ligação.
Usa
- usausa o socket «cache»
component.aggrega.ai/category=datastore
Slots de acoplamento: credential, server_ca
core/datastore/chroma v1.0.0 →core/datastore/cognee v1.0.0 →core/datastore/documentdb v1.0.0 →core/datastore/elasticsearch v1.0.0 →core/datastore/etcd v1.0.0 →core/datastore/ferretdb v1.0.0 →core/datastore/mariadb v1.0.0 →core/datastore/mariadb-operator v1.0.0 →core/datastore/memcached v1.0.0 →core/datastore/milvus v1.0.0 →core/datastore/mysql v1.0.0 →core/datastore/mysql-innodb-cluster v1.0.0 →core/datastore/mysql-operator v1.0.0 →core/datastore/opensearch v1.0.0 →core/datastore/pgvector v1.0.0 →core/datastore/postgres v1.0.0 →core/datastore/qdrant v1.0.0 →core/datastore/redis v1.0.0 →core/datastore/timescaledb v1.0.0 →core/datastore/valkey v1.0.0 →core/datastore/weaviate v1.0.0 →
Usado por
usa o socket «upstream»
usa o socket «forward_target»
usa o socket «scrape_target»
usa o socket «store»
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
aplica-se a
implementa
implementa