Service: Valkey - EyevinnOSC/community GitHub Wiki
Valkey (serviceId valkey-io-valkey) is a community-driven, high-performance in-memory key-value store that is compatible with Redis clients. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance with up to 10 GiB of storage per instance.
- Act as a cache, session store, counter store, queue or pub/sub broker for your applications.
- Serve as the backing store for other OSC services that need a Redis-compatible database, for example Application Config Service and Automatisch.
- Be reached with any Redis client, such as
redis-cli, over the TCP address and port that the instance exposes.
Create the instance with create-service-instance using serviceId: "valkey-io-valkey" and a config object. The instance name must be alphanumeric and at most 20 characters. Valkey has no dependencies on other OSC services.
{ "name": "mystore", "Password": "{{secrets.valkeypwd}}" }After creation, wait for the instance to reach running state and use describe-service-instance to read the address, port and internal cluster endpoint. Other OSC services in the same workspace can use the internal endpoint.
| Option | Required | Type | Meaning |
|---|---|---|---|
| name | Yes | string | Name of the instance. Alphanumeric, at most 20 characters. |
| Password | No | string, sensitive | Password that clients must supply to authenticate. Store it as a service secret and pass it as {{secrets.NAME}}. If you leave it empty, OSC generates a random password, stores it as a service secret named <name>-password and never returns the plaintext in the create result. |
Creating a secret first: create-service-secret with serviceId: "valkey-io-valkey", a secret name and its value. A {{secrets.NAME}} reference must be the whole field value. Changing a secret later does not restart or reconfigure a running instance.
Use the address and port from describe-service-instance. Without the password a client gets NOAUTH Authentication required. With redis-cli, supply the password through REDISCLI_AUTH:
% export REDISCLI_AUTH=<password>
% redis-cli -h <host> -p <port> INCR mycounter
(integer) 1
- Storage is limited to 10 GiB per instance.
- A password you supply is used unchanged; rotating it means updating the secret and restarting the instance.