Redis v8's default modules aren't loaded

[aradalvand]

To reproduce:

var builder = DistributedApplication.CreateBuilder(args);

// Infra:
var redisServer = builder.AddRedis(InfraConstants.RedisResourceName)
	.WithImageTag("8.0.2")
	.WithDataVolume()
	.WithLifetime(ContainerLifetime.Persistent);

Run redis-cli -p [the-host-port] on the host, try the command FT._LIST, you'll get:

(error) ERR unknown command 'FT._LIST'

Redis v8 comes with built-in modules like search, JSON, etc. — the default docker-entrypoint.sh in the official image makes sure to include the existing set of modules via the --loadmodule flag. Aspire.Hosting.Redis, however, doesn't.

Aspire.Hosting.Redis should either run docker-entrypoint.sh, or include the default set of modules, and ideally also provide a WithModule extension method to enable fine-grained customization.

[sravimohan]

Trying to do the same. My research so far,

Looks like you need to specify the conf file in the command argument to enable modules.

https://redis.io/docs/latest/operate/oss_and_stack/install/install-stack/docker/

https://redis.io/docs/latest/operate/oss_and_stack/management/config/

Trying with Dockerfile using WithDockerfile,

FROM redis:8
COPY redis.conf /etc/redis/redis.conf
CMD [ "redis-server", "/etc/redis/redis.conf" ]

But aspire does not to use the command specified in the Dockerfile and is specifying its own with password.

Trying to override (hack) the arguments to see if I can get it working,

var db = builder.AddRedis("db")
    .WithDockerfile("redis")
    .WithRedisInsight()
    .WithEndpoint("tcp", endpoint =>
    {
        endpoint.Port = 6379;
        endpoint.TargetPort = 6379;
    }).WithArgs(context =>
    {
        if (context.Args[1] is string arg && arg.Contains("redis-server"))
        {
            context.Args[1] = arg.Replace("redis-server", "redis-server /etc/redis/redis.conf");
        }
        return Task.CompletedTask;
    });

But for whatever reason the health checks are failing.

For reference, the below docker compose works,

services:
  redis:
    image: redis:8
    container_name: redis-server
    network_mode: host
    ports:
      - "6379:6379"
    volumes:
      - ./config/redis.conf:/etc/redis/redis.conf
      - ./data:/data
      - ./logs:/var/log/redis
    command: redis-server /etc/redis/redis.conf --appendonly yes
    restart: always

  redisinsight:
    image: redislabs/redisinsight:latest
    container_name: redisinsight
    network_mode: host
    ports:
      - "5540:5540"
    restart: always

[sravimohan]

Got a POC working with custom Docker file and modified AddRedis extenstion method which takes in the config file path.

POC: https://github.com/sravimohan/RedisBuilderExtensionsForV8/tree/7daa07fa9dbaf584b91c503e4958e7f6c963bdb4

Not sure how we make it work without a custom docker file.

[sravimohan]

UPDATE

You can get your modules loaded by appending the loadmodule commandline arguments. This negates the need for a custom dockerfile and a conf file. Although feels a bit hacky, would love to know if there is a better approach. Ideally AddRedis would take optional arguments.

var builder = DistributedApplication.CreateBuilder(args);

var redis = builder
    .AddRedis("db")
    .WithImageTag(tag: "8")
    .WithArgs(context =>
    {
        context.Args[1] = $"{context.Args[1]} --loadmodule /usr/local/lib/redis/modules/redisearch.so --loadmodule /usr/local/lib/redis/modules/rejson.so";
    })
    .WithRedisInsight();

builder.Build().Run();

Another thing to note, AddRedis adds .WithEntrypoint("/bin/sh") ref AddRedis. Hence, we are not able to just add to the argument list instead of string concat. Wonder if /bin/sh is necessary?

[sravimohan]

This might be relevant here,
#3838 (comment)

tagging @eerhardt @Alirexaa @DamianEdwards

[eerhardt]

Wonder if /bin/sh is necessary?

Yes this was necessary in order to password protect the Redis server. #3838 (comment) has the context for what was done in order to use a password.

[sravimohan]

Thank you @eerhardt, The option is to add an optional parameter to add additional Redis arguments to AddRedis, I guess.

[DamianEdwards]

If utilizing features of the Redis container image is primarily based around passing arguments to the entrypoint, then as @sravimohan suggests, perhaps we should have more first-class support in the Redis hosting integration for configuring these features from code so that the arguments are configured appropriately.

[sravimohan]

Recapping ways to configure Redis,

ref: https://redis.io/docs/latest/operate/oss_and_stack/management/config/

1. Conf file: This would be the best option if there is lot of items to configure. In this case, we need to pass the conf file as argument. For example, redis-server /path/to/redis.conf with the conf file volume mounted.

2. Command line arguments: Everything in the conf file can be passed as arguments in the command line,
   For example, redis-server --port 6380 --replicaof 127.0.0.1 6379

Will be great to have options for both these scenarios.

[joshbartley]

For anyone who lands on this issue. The Arg order changed as the password is now Args[2] and this is what works for me.

var cache = builder.AddRedis("cache")
        .WithArgs(context =>
        {
            context.Args.Add($"--loadmodule /usr/local/lib/redis/modules/redisbloom.so --loadmodule /usr/local/lib/redis/modules/redisearch.so --loadmodule /usr/local/lib/redis/modules/rejson.so");
        });