Yan Bondarenko
cdcb2710cd
Two sentences of the boilerplate shared by the app READMEs were wrong. "When left empty, the preset is applied" described an all-or-nothing rule, but cozy-lib.resources.defaultingSanitize merges per key: every resource that resources leaves unset comes from the preset. And the legacy flat names were called aliases of their "1:1 instance-type equivalents", which reads as the c1 series; nano through small match t1, and medium matches c1.small rather than c1.medium, the trap docs/operations/resource-presets.md already warns about. Signed-off-by: Yan Bondarenko <202671653+yankawai@users.noreply.github.com>
4.3 KiB
Managed Valkey Service
Valkey is a highly versatile and blazing-fast in-memory data store and cache that can significantly boost the performance of your applications. It is the BSD-3-Clause licensed, Linux Foundation-governed fork of Redis 7.2 and a drop-in replacement for it. Managed Valkey Service offers a hassle-free solution for deploying and managing Valkey clusters, ensuring that your data is always available and responsive.
Deployment Details
Service runs Valkey on the freshworks-oss redis-operator, which manages Sentinel-based HA and selects the Valkey engine natively via spec.engine: Valkey — so the official valkey/valkey image is used directly, with no Redis-compatibility shim.
- Docs: https://valkey.io/docs/
- Valkey: https://github.com/valkey-io/valkey
- Operator: https://github.com/freshworks-oss/redis-operator
storageClassis annotated as immutable in the chart schema — seedocs/storage-immutability.mdfor the contract and which consumers enforce it.
Parameters
Common parameters
| Name | Description | Type | Value |
|---|---|---|---|
replicas |
Number of Valkey replicas. | int |
2 |
resources |
Explicit CPU and memory configuration for each Valkey replica. When omitted, the preset defined in resourcesPreset is applied. |
object |
{} |
resources.cpu |
CPU available to each replica. | quantity |
"" |
resources.memory |
Memory (RAM) available to each replica. | quantity |
"" |
resourcesPreset |
Default sizing preset used when resources is omitted. |
string |
t1.nano |
size |
Persistent Volume Claim size available for application data. | quantity |
1Gi |
storageClass |
StorageClass used to store the data. | string |
"" |
external |
Enable external access from outside the cluster. | bool |
false |
version |
Valkey major version to deploy | string |
v8 |
Application-specific parameters
| Name | Description | Type | Value |
|---|---|---|---|
authEnabled |
Enable password generation. | bool |
true |
Parameter examples and reference
resources and resourcesPreset
resources sets explicit CPU and memory configurations for each replica.
Every resource it leaves unset is taken from the preset defined in resourcesPreset.
resources:
cpu: 4000m
memory: 4Gi
resourcesPreset sets named CPU and memory configurations for each replica.
This setting is ignored if the corresponding resources value is set.
Presets follow a cloud-style <series>.<size> naming convention. Five series cover the full CPU-to-memory ratio range (t1 1:0.5, c1 1:1, s1 1:2, u1 1:4, m1 1:8) and each series ships eight sizes (nano through 4xlarge). The legacy flat names (nano, micro, small, medium, large, xlarge, 2xlarge) remain accepted as deprecated aliases and keep their original sizes, which do not follow one series: nano through small equal the t1 sizes of the same name, while medium equals c1.small rather than c1.medium.
See docs/operations/resource-presets.md for the full size matrix and the legacy-to-instance-type mapping.