Set default Docker image for Redis Dev Services

Author: wjglerum

build-parent/pom.xml

@@ -117,6 +117,7 @@
         <narayana-lra.image>quay.io/jbosstm/lra-coordinator:latest</narayana-lra.image>
         <rabbitmq.image>rabbitmq:3.12-management</rabbitmq.image>
         <pulsar.image>apachepulsar/pulsar:3.2.4</pulsar.image>
+        <redis.image>redis:7</redis.image>
 
         <!-- Code Coverage Properties-->
         <jacoco.agent.argLine></jacoco.agent.argLine>

docs/src/main/asciidoc/_attributes.adoc

@@ -25,6 +25,7 @@
 :mongo-image: ${mongo.image}
 :rabbitmq-image: ${rabbitmq.image}
 :pulsar-image: ${pulsar.image}
+:redis-image: ${redis.image}
 :jandex-version: ${jandex.version}
 :jandex-gradle-plugin-version: ${jandex-gradle-plugin.version}
 :kotlin-version: ${kotlin.version}

docs/src/main/asciidoc/redis.adoc

@@ -479,9 +479,9 @@ However, in production, you will run your own Redis (or used a Cloud offering).
 
 Let's start a Redis server on the port 6379 using:
 
-[source, shell]
+[source, shell, subs=attributes+]
 ----
-docker run --ulimit memlock=-1:-1 -it --rm=true --memory-swappiness=0 --name redis_quarkus_test -p 6379:6379 redis:5.0.6
+docker run --ulimit memlock=-1:-1 -it --rm=true --memory-swappiness=0 --name redis_quarkus_test -p 6379:6379 {redis-image}
 ----
 
 Then, open the `src/main/resources/application.properties` file and add:

extensions/redis-client/deployment/src/main/java/io/quarkus/redis/deployment/client/DevServicesConfig.java

@@ -4,6 +4,7 @@
 import java.util.Optional;
 import java.util.OptionalInt;
 
+import io.quarkus.runtime.annotations.ConfigDocDefault;
 import io.quarkus.runtime.annotations.ConfigDocMapKey;
 import io.quarkus.runtime.annotations.ConfigGroup;
 import io.smallrye.config.WithDefault;
@@ -26,6 +27,7 @@ public interface DevServicesConfig {
      * If you want to use Redis Stack modules (bloom, graph, search...), use:
      * {@code redis/redis-stack:latest}.
      */
+    @ConfigDocDefault(value = "`{redis-image}`", escape = false)
     Optional<String> imageName();
 
     /**

extensions/redis-client/deployment/src/main/java/io/quarkus/redis/deployment/client/DevServicesRedisProcessor.java

@@ -1,6 +1,7 @@
 package io.quarkus.redis.deployment.client;
 
 import static io.quarkus.devservices.common.ConfigureUtil.configureSharedServiceLabel;
+import static io.quarkus.devservices.common.ConfigureUtil.getDefaultImageNameFor;
 import static io.quarkus.devservices.common.ContainerLocator.locateContainerWithLabels;
 import static io.quarkus.redis.runtime.client.config.RedisConfig.HOSTS;
 import static io.quarkus.redis.runtime.client.config.RedisConfig.getPropertyName;
@@ -38,7 +39,6 @@
 public class DevServicesRedisProcessor {
     private static final Logger log = Logger.getLogger(DevServicesRedisProcessor.class);
 
-    private static final String REDIS_IMAGE = "docker.io/redis:7";
     private static final int REDIS_EXPOSED_PORT = 6379;
     private static final String REDIS_SCHEME = "redis://";
 
@@ -84,8 +84,10 @@ public void startRedisContainers(LaunchModeBuildItem launchMode,
                                     .serviceName(name)
                                     .serviceConfig(redisConfig)
                                     .startable(() -> new QuarkusPortRedisContainer(
-                                            DockerImageName.parse(redisConfig.imageName().orElse(REDIS_IMAGE))
-                                                    .asCompatibleSubstituteFor(REDIS_IMAGE),
+                                            DockerImageName
+                                                    .parse(redisConfig.imageName()
+                                                            .orElseGet(() -> getDefaultImageNameFor("redis")))
+                                                    .asCompatibleSubstituteFor("redis"),
                                             redisConfig.port(),
                                             composeProjectBuildItem.getDefaultNetworkId(),
                                             useSharedNetwork)
@@ -128,7 +130,7 @@ private DevServicesResultBuildItem discoverRunningService(DevServicesComposeProj
             boolean useSharedNetwork) {
         return redisContainerLocator.locateContainer(devServicesConfig.serviceName(), devServicesConfig.shared(), launchMode)
                 .or(() -> ComposeLocator.locateContainer(composeProjectBuildItem,
-                        List.of(devServicesConfig.imageName().orElse("redis")),
+                        List.of(devServicesConfig.imageName().orElseGet(() -> getDefaultImageNameFor("redis"))),
                         REDIS_EXPOSED_PORT, launchMode, useSharedNetwork))
                 .map(containerAddress -> {
                     String redisUrl = REDIS_SCHEME + containerAddress.getUrl();

extensions/redis-client/deployment/src/main/resources/redis-devservice.properties

@@ -0,0 +1 @@
+default.image=${redis.image}