Files
cozystack/packages/apps/valkey/README.md
T
Myasnikov Daniil b83cc087cc docs: move the repo-only guides onto the website
Seven guides in docs/ were written next to the code and left in the
source tree, where no operator looks. The website carries them now, so
a second copy here only lets the two drift again: the Backup Classes
page had already fallen behind its original.

docs/release.md, docs/deprecating-applications.md and the two SeaweedFS
runbooks in docs/operations stay. A migration, a bats suite, a workflow
or AGENTS.md reads each of them by path, which is the test for keeping
a document in this repository.

Assisted-by: LLM
Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>
2026-10-21 17:50:46 +05:00

58 lines
4.3 KiB
Markdown

# 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
> `storageClass` is annotated as immutable in the chart schema — see [storageClass immutability](https://cozystack.io/docs/v1/operations/storage-class-immutability/) for 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`.
```yaml
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 [Resource management](https://cozystack.io/docs/v1/guides/resource-management/) for the full size matrix and the legacy-to-instance-type mapping.