Valkey reference¶

Configuration options¶

The spec.valkey field takes a list of records of two fields, instance and access. Instance is the instance name and access is the access mode.

spec:
  valkey:
    - instance: <ValkeyInstanceName>
      access: readwrite | read | write | admin

Environment variables¶

Every <ValkeyInstanceName> will be given a handfull of environment variables for the applications to use:

Key	Value
`VALKEY_URI_<ValkeyInstanceName>`	The URI for the Valkey instance, typically with a `valkey` scheme. Example: `valkeys://valkey-team-sessions-nav-dev.aivencloud.com:26483`
`VALKEY_HOST_<ValkeyInstanceName>`	The host for the Valkey instance. Example: `valkey-team-sessions-nav-dev.aivencloud.com`
`VALKEY_PORT_<ValkeyInstanceName>`	The port for the Valkey instance. Example: `26483`
`VALKEY_USERNAME_<ValkeyInstanceName>`	The username to use when connecting.
`VALKEY_PASSWORD_<ValkeyInstanceName>`	The password to use when connecting.

To make the usage of Valkey backward compatible for libraries not supporting Valkeys, but only Redis, we also supply these environment variables:

Key	Value
`REDIS_URI_<RedisInstanceName>`	The URI for the Redis instance, typically with a `redis` scheme. Example: `rediss://redis-team-sessions-nav-dev.aivencloud.com:26483`
`REDIS_HOST_<RedisInstanceName>`	The host for the Redis instance. Example: `redis-team-sessions-nav-dev.aivencloud.com`
`REDIS_PORT_<RedisInstanceName>`	The port for the Redis instance. Example: `26483`
`REDIS_USERNAME_<RedisInstanceName>`	The username to use when connecting.
`REDIS_PASSWORD_<RedisInstanceName>`	The password to use when connecting.

Advanced configuration¶

For advanced configuration, we recommend creating your Valkey instances explicitly, especially if you intend for multiple applications using the same Valkey instance.

We use Aivens operator, so the Valkey resource is documented in detail in the Aiven documentation.