Valkey reference ¶

Configuration options ¶

The spec.valkey field takes a list of records of two fields, instance and access:

yaml

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

For details, see the manifest reference for your workload type:

Access levels grants the service user access to different Valkey ACL categories. The access levels are as follows:

Access level	Description
`read`	`["-@all", "+@connection", "+@scripting", "+@pubsub", "+@transaction", "+@read"]`
`write`	`["-@all", "+@connection", "+@scripting", "+@pubsub", "+@transaction", "+@write"]`
`readwrite`	`["-@all", "+@connection", "+@scripting", "+@pubsub", "+@transaction", "+@write", "+@read"]`
`admin`	`["-@all", "+@connection", "+@scripting", "+@pubsub", "+@transaction", "+@write", "+@read", "+@admin"]`

When using a Valkey from your workload, each <ValkeyInstanceName> you have configured will result in environment variables at runtime:

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.

If your Valkey instance is managed by Nais Console or you've created a ServiceIntegration manually, you will find essential instance metrics in Nais Console in the "Insights" tab.

Metrics are not available for the SINGLE_NODE tier and GB_1 memory configuration (equivalent to the hobbyist service plan in Aiven).

Additional metrics are available in Prometheus. For example, CPU usage percentage can be queried with:

promql

100 - avg by (cpu) (cpu_usage_idle{service="valkey-<team>-<instance>"})