Component
core/datastore/redis
A Redis in-memory key-value cache, speaking the Redis wire protocol. Used as a cache, entries live in memory and are not durably persisted, so the component renders as a stateless workload rather than a stateful one and declares no storage. Realized on Kubernetes (Workload synthesis to native Kubernetes resources), on Compose for local development, on Amazon ElastiCache and on Azure Managed Redis. Exports its host and port to consumers via the uses topology. The terms follow the realization. helm/redis and compose/redis declare the AGPL-3.0 licence; terraform/redis-elasticache declares Apache-2.0, the licence of the module it vendors; cloudformation/redis-elasticache and terraform/redis-azure-managed declare none. The Valkey component speaks the same wire protocol, and its helm Recipes declare BSD-3-Clause. From release 8.0 the container image carries the query engine whose vector search a gateway's semantic cache searches its replies with, and it publishes vector_search while it does; the Valkey image the catalog pins does not. Reach for terraform/redis-elasticache, or cloudformation/redis-elasticache in a CloudFormation stack, for an ElastiCache service in the operator's AWS account, where the Release sets infra.engine_version; and for terraform/redis-azure-managed for an Azure Managed Redis instance in the operator's Azure subscription. None publishes vector_search; each halts naming each value its service cannot apply. `infra.client_tls`, off by default, serves TLS alone and publishes `protocol` `redis-tls`: on Kubernetes with the certificate attached to `server_certificate`, on the managed services with their own. The Compose realization refuses it by name.
Provenance
- Content digest
- sha256:ee858e012e0e683aced331e6b224574642e99a8046f167f31baa97689f20dbd3
- Published
- 2026-11-10T10:11:17Z
- 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:25b4b8d4df77ba58674fdd5eace1470a40f06be0a880cdeaf12c03eaa89b166c
Reference at this version
oci://hub.aggrega.ai/component/core/datastore/redis:1.0.0Developer parameters
Values the developer sets in the Aggregate.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| maxmemory | string | — | no | Maximum memory the cache may use before eviction (the redis maxmemory directive, e.g. 256mb). Omit for no cap. ElastiCache fixes it by the node type, and Azure Managed Redis by its SKU, so their realizations halt on it. |
| maxmemory_policy | string | — | no | Eviction policy applied when maxmemory is reached (the redis maxmemory-policy directive, e.g. allkeys-lru, volatile-ttl, noeviction). Omit to use the redis default; on Azure Managed Redis, omitted, the service's default, volatile-lru, applies, and a policy it does not offer halts. |
| databases | integer (min 1) | — | no | Number of logical databases (the redis databases directive). Omit to use the redis default (16). The ElastiCache realizations set it through a parameter group from Redis OSS 6.0 on, and halt on it below, where ElastiCache lets no parameter group change it. Azure Managed Redis takes no such setting, so its realization halts on it. |
| appendonly | boolean | false | no | Enable append-only file (AOF) persistence. Pair with persistence.enabled for a durable volume; on an ephemeral cache the AOF is not retained across restarts. ElastiCache writes no AOF for Redis OSS, so its realizations halt on it set true. On Azure Managed Redis it turns on the service's AOF persistence, written once per second to a managed disk the service keeps, which needs high availability on. |
| persistence | object | — | no | — |
Operator sizing
Infrastructure sizing the operator tunes per environment.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| port | integer (min 1024, max 65535) | 6379 | no | Server listen port. Most operators should omit this and let the Recipe assign the default (6379). Azure Managed Redis serves port 10000 alone, which its realization publishes, and it halts on any value other than this default. |
| client_tls | boolean | false | no | Serve client connections over TLS alone. Off by default, which serves plaintext and renders exactly as a cache without the setting. On, the server listens for TLS on `port` with no plaintext listener, presents the certificate attached to `server_certificate` (required while this is on), requests no client certificate, and the published `protocol` is `redis-tls`. Served by the `redis` Kubernetes realization; the Compose realization refuses it. On ElastiCache it turns on the service's in-transit encryption, whose certificate AWS issues and clients trust without a `server_ca`. On Azure Managed Redis it keeps the service's TLS-only client connections, and off it serves plaintext, which only an access-key client can use: Microsoft Entra ID authentication needs TLS, so that realization halts with it off unless the Release turns access keys on. |
| engine_version | string | 8.8.2-alpine | no | Redis container image tag, pinned to an exact patch of the image the Redis project's own maintainers publish. Selects the image tag on container targets. It selects a tag and not a repository, so a Release needing a different image — the one the OT-CONTAINER-KIT Redis operator's own chart and examples name, quay.io/opstree/redis — sets infra.overrides.image to the whole image reference instead. The ElastiCache realizations read the version the value begins with as the Redis OSS engine version, 7.1, 7.0, 6.2, 6.0, 5.0.6 or 4.0.10, and halt on any other, this default included, so a Release mapped to them sets it; they halt on infra.overrides.image, since no image runs there. Azure Managed Redis runs the Redis version the service chooses and upgrades itself, so that realization does not read it, and halts on infra.overrides.image as well. |
| compute | object | — | no | — |
| storage | object | — | no | — |
| overrides | object (open) | — | no | Provider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
| image_serves_vector_search | boolean | false | no | Set to true when the image infra.overrides.image names serves the Redis query engine's vector search, FT.CREATE and FT.SEARCH over a vector field, so this instance publishes vector_search. Read only while infra.overrides.image is set. The ElastiCache and Azure Managed Redis realizations run no image and do not read it. |
Output contract
Values this component publishes to consumers over the uses topology.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| host | string | — | yes | Address a consumer opens its cache connection to, together with `port`: the in-cluster DNS name of the Service fronting the cache on Kubernetes, and on ElastiCache and Azure Managed Redis a pointer string Terraform or CloudFormation resolves to the service's endpoint, or the DNS name the Release sets in infra.overrides.host instead, so a consumer on another target receives an address it can resolve. |
| port | integer | — | yes | TCP port the cache accepts connections on. It follows the port an operator set in the Release, so a consumer reads it rather than assuming 6379; on Azure Managed Redis it is 10000, the one port the service serves. |
| protocol | string | — | no | Wire protocol the published address speaks — `redis` while `infra.client_tls` is off, and `redis-tls` while it is on, when the address accepts TLS connections alone. A consumer reaches either with a Redis-protocol client, over TLS for `redis-tls`. A client that reads only `host` and `port` reads this key too to learn that TLS is required: a plaintext client reaching a TLS listener fails its handshake and exchanges no command. |
| vector_search | string | — | no | `true` while this instance serves the Redis query engine's vector search, which a semantic cache needs of its store; empty otherwise. With no infra.overrides.image it is `true` for an infra.engine_version from 8.0.0 on; with one, only while infra.image_serves_vector_search is true. The ElastiCache and Azure Managed Redis realizations publish it empty. |
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.
No uses sockets declared.
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.
| Slot | Selector | Required | Inject | Sensitive | Description |
|---|---|---|---|---|---|
| password | feature.aggrega.ai/kind=secret | no | env | yes | Optional cache authentication credential. When attached, enables Redis password authentication and supplies the password; unattached, the cache runs without authentication. On ElastiCache the password is the AUTH token, which the service accepts only while infra.client_tls is true, drawn by core/random-password, when Terraform applies or the stack is created, with no punctuation and at least 16 characters. Azure Managed Redis authenticates every client, with Microsoft Entra ID or an access key it generates, and takes no password, so its realization halts on any attachment. |
| server_certificate | feature.aggrega.ai/kind=secret | no | file | yes | Optional certificate the cache presents to its clients while infra.client_tls is true: a Secret holding tls.crt, the certificate followed by any intermediate certificates, and tls.key, its private key, the two keys a kubernetes.io/tls Secret holds. The certificate names every address a client dials: the published host, and its namespace-qualified forms where clients in other namespaces connect. Mounted as files, so attach a Feature that names an existing Secret, such as core/referenced-secret. Required by the Kubernetes realization while client_tls is true; a build halts on it attached while client_tls is false. ElastiCache presents a certificate AWS issues, and Azure Managed Redis one of its own, so their realizations halt on any attachment here. |
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
This entity uses nothing in the catalog.
Used by
uses socket «backend»
uses socket «cache»
uses socket «queue»
uses socket «backend»
uses socket «cache»
uses socket «queue»
uses socket «backend»
uses socket «backend»
uses socket «cache»
uses socket «queue»
uses socket «backend»
uses socket «cache»
uses socket «queue»
uses socket «backend»
uses socket «cache»
uses socket «queue»
uses socket «backend»
uses socket «cache»
uses socket «backend»
uses socket «cache»
uses socket «backend»
uses socket «cache»
uses socket «backend»
uses socket «cache»
uses socket «backend»
uses socket «cache»
uses socket «backend»
uses socket «cache»
uses socket «backend»
uses socket «cache»
uses socket «state_store»
uses socket «checkpointer_db»
uses socket «checkpointer_db»
uses socket «backend»
uses socket «backend»
uses socket «backend»
uses socket «storage»
uses socket «metadata_store»
uses socket «target_datastore»
uses socket «cache_store»
uses socket «cache»
uses socket «cache»
uses socket «cache_store»
uses socket «upstream»
uses socket «cache»
uses socket «cache_store»
uses socket «cache»
uses socket «state_store»
uses socket «state_store»
uses socket «forward_target»
uses socket «backend»
uses socket «cache»
uses socket «chunk_cache»
uses socket «scrape_target»
uses socket «store»
uses socket «backend»
applies to
applies to
applies to
applies to
applies to
applies to
applies to
implements
implements
implements
implements
implements