Component
core/datastore/valkey
A Valkey 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, on Compose for local development, on Amazon ElastiCache and on Google Cloud Memorystore for Valkey. Exports its host and port to consumers via the uses topology. On Kubernetes there are two realizations and the Manifest chooses between them. `valkey` synthesizes the cache as a workload and fetches nothing, so it is the one to reach for where the build must complete with no chart repository reachable. `valkey-chart` renders the community-maintained Valkey Helm chart, which hardens the container further, so reach for it where a chart repository is reachable at build time. Reach for terraform/valkey-elasticache, or cloudformation/valkey-elasticache in a CloudFormation stack, where the cache is an ElastiCache service in the operator's AWS account; each halts naming each value ElastiCache cannot apply. Reach for terraform/valkey-memorystore where it is a Memorystore instance in the operator's Google Cloud project, whose VPC network has a service connection policy for Memorystore; it runs without authentication. `infra.client_tls`, off by default, serves TLS alone and publishes `protocol` `valkey-tls`: on Kubernetes with the certificate attached to `server_certificate`, on ElastiCache with one AWS issues, on Memorystore with one from the instance's own authority, which consumers trust through `server_ca`. The Compose realization refuses it by name.
Provenance
- Empreinte du contenu
- sha256:627bb5b54ca1ad5133cd336470135b3603a2965b15f62119068aabe4a705bb07
- Publié
- 2026-11-10T10:11:19Z
- 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:4867028e2f070a500d3f8f8e0b017f93b3c203b85738a9e55052969d350431c9
Référence à cette version
oci://hub.aggrega.ai/component/core/datastore/valkey:1.0.0Paramètres du développeur
Valeurs que le développeur définit dans l’Aggregate.
| Nom | Type | Valeur par défaut | Obligatoire | Description |
|---|---|---|---|---|
| maxmemory | string | — | non | Maximum memory the cache may use before eviction (the maxmemory directive, e.g. 256mb). Omit for no cap. ElastiCache fixes it by the node type, so its realizations halt on it; Memorystore takes it as a configuration, except on the SHARED_CORE_NANO node type. |
| maxmemory_policy | string | — | non | Eviction policy applied when maxmemory is reached (the maxmemory-policy directive, e.g. allkeys-lru, volatile-ttl, noeviction). Omit to use the default. |
| databases | integer (min 1) | — | non | Number of logical databases (the databases directive). Omit to use the default (16). |
| appendonly | boolean | false | non | 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 Valkey, so its realizations halt on it set true; Memorystore keeps the data with AOF persistence. |
| persistence | object | — | non | — |
Dimensionnement de l’opérateur
Dimensionnement de l’infrastructure que l’opérateur ajuste pour chaque environnement.
| Nom | Type | Valeur par défaut | Obligatoire | Description |
|---|---|---|---|---|
| port | integer (min 1024, max 65535) | 6379 | non | Server listen port. Most operators should omit this and let the Recipe assign the default (6379). Memorystore serves 6379 alone, so terraform/valkey-memorystore halts on any other value. |
| client_tls | boolean | false | non | 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 `valkey-tls`. Served by the `valkey` and `valkey-chart` Kubernetes realizations; 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 Memorystore it turns on the service's in-transit encryption with the instance's own certificate authority, which each consumer takes in its `server_ca` slot. |
| engine_version | string | 8.1-alpine | non | Valkey container image tag. Selects the image tag on container targets; the chart-backed realization pins its own image tag. The ElastiCache realizations read the major and minor version the value begins with (8.1 from 8.1-alpine) as the engine version, and halt on one ElastiCache does not offer, naming those it does. terraform/valkey-memorystore reads it the same way and takes 7.2, 8.0, 9.0 and 9.1, so the default halts there and the Release sets one of them. |
| source_version | string | — | non | Version of the Helm chart the chart-backed realization pulls. Read only by that realization; the workload-synthesis and Compose realizations pull no source artifact and ignore it, and the ElastiCache and Memorystore realizations ignore it too, the terraform ElastiCache one pinning the module it vendors at a version it writes out, the Memorystore one vendoring a module kept beside it and the CloudFormation one pulling nothing. Changing it away from the Recipe's default does not guarantee value-mapping compatibility with the new chart. |
| compute | object | — | non | — |
| storage | object | — | non | — |
| overrides | object (open) | — | non | Provider-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.
| Nom | Type | Valeur par défaut | Obligatoire | Description |
|---|---|---|---|---|
| host | string | — | oui | 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 or Memorystore a pointer string Terraform or CloudFormation resolves to the primary 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 | — | oui | TCP port the cache accepts connections on. It follows the port an operator set in the Release, or the one port the service serves on Memorystore, so a consumer reads it rather than assuming 6379. |
| protocol | string | — | non | Wire protocol the published address speaks — `valkey`, naming the server on the other end, while `infra.client_tls` is off, and `valkey-tls` while it is on, when the address accepts TLS connections alone. A consumer reaches either with a Redis-protocol client, over TLS for `valkey-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. |
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.
Aucun socket uses déclaré.
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.
| Emplacement | Sélecteur | Obligatoire | Injection | Sensible | Description |
|---|---|---|---|---|---|
| password | feature.aggrega.ai/kind=secret | non | env | oui | Optional cache authentication credential. When attached, enables Valkey 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. Memorystore for Valkey takes no password a Release supplies, so terraform/valkey-memorystore halts on any attachment here. |
| server_certificate | feature.aggrega.ai/kind=secret | non | file | oui | 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 realizations while client_tls is true; a build halts on it attached while client_tls is false. ElastiCache presents a certificate AWS issues, and Memorystore one from the instance's own authority, so their realizations halt on any attachment here. |
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
Cette entité n’utilise rien du catalogue.
Utilisé par
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « queue »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « queue »
utilise le socket « backend »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « queue »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « queue »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « queue »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « state_store »
utilise le socket « checkpointer_db »
utilise le socket « checkpointer_db »
utilise le socket « backend »
utilise le socket « backend »
utilise le socket « backend »
utilise le socket « storage »
utilise le socket « metadata_store »
utilise le socket « target_datastore »
utilise le socket « cache_store »
utilise le socket « cache »
utilise le socket « cache »
utilise le socket « cache_store »
utilise le socket « upstream »
utilise le socket « cache »
utilise le socket « cache_store »
utilise le socket « cache »
utilise le socket « state_store »
utilise le socket « state_store »
utilise le socket « forward_target »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « chunk_cache »
utilise le socket « scrape_target »
utilise le socket « store »
utilise le socket « backend »
s’applique à
s’applique à
s’applique à
s’applique à
s’applique à
s’applique à
s’applique à
implémente
implémente
implémente
implémente
implémente
implémente