Set default Docker image for Apicurio Registry Dev Services

Author: wjglerum

bom/application/pom.xml

@@ -194,7 +194,6 @@
         <log4j2-api.version>2.25.2</log4j2-api.version>
         <log4j-jboss-logmanager.version>1.3.1.Final</log4j-jboss-logmanager.version>
         <avro.version>1.12.0</avro.version>
-        <apicurio-registry.version>2.6.13.Final</apicurio-registry.version>
         <apicurio-common-rest-client.version>0.1.18.Final</apicurio-common-rest-client.version> <!-- must be the version Apicurio Registry uses -->
         <testcontainers.version>1.21.3</testcontainers.version> <!-- Make sure to also update docker-java.version to match its needs -->
         <docker-java.version>3.4.2</docker-java.version> <!-- must be the version Testcontainers use: https://central.sonatype.com/artifact/org.testcontainers/testcontainers -->

build-parent/pom.xml

@@ -112,6 +112,9 @@
         <!-- TODO switch to apache/activemq-artemis to match the artemis version-->
         <amqp.docker.image>quay.io/artemiscloud/activemq-artemis-broker:1.0.25</amqp.docker.image>
 
+        <!-- Dev Services Docker Images -->
+        <apicurio-registry.docker.image>quay.io/apicurio/apicurio-registry-mem:${apicurio-registry.version}</apicurio-registry.docker.image>
+
         <!-- Code Coverage Properties-->
         <jacoco.agent.argLine></jacoco.agent.argLine>
 

docs/src/main/asciidoc/_attributes.adoc

@@ -20,6 +20,7 @@
 :kibana-image: ${kibana.image}
 :keycloak-docker-image: ${keycloak.docker.image}
 :amqp-docker-image: ${amqp.docker.image}
+:apicurio-registry-docker-image: ${apicurio-registry.docker.image}
 :jandex-version: ${jandex.version}
 :jandex-gradle-plugin-version: ${jandex-gradle-plugin.version}
 :kotlin-version: ${kotlin.version}

docs/src/main/asciidoc/apicurio-registry-dev-services.adoc

@@ -77,7 +77,7 @@ You can select any 2.x version from https://hub.docker.com/r/apicurio/apicurio-r
 
 [source, properties]
 ----
-quarkus.apicurio-registry.devservices.image-name=apicurio/apicurio-registry-mem:latest-snapshot
+quarkus.apicurio-registry.devservices.image-name={apicurio-registry-docker-image}
 ----
 
 [[Compose]]
@@ -91,7 +91,7 @@ It relies on a `compose-devservices.yml`, such as:
 name: <application name>
 services:
   apicurio:
-    image: apicurio/apicurio-registry-mem:2.4.2.Final
+    image: {apicurio-registry-docker-image}
     ports:
       - "8080"
-----
+----

docs/src/main/asciidoc/kafka-schema-registry-avro.adoc

@@ -333,7 +333,7 @@ services:
       LOG_DIR: "/tmp/logs"
 
   schema-registry:
-    image: apicurio/apicurio-registry-mem:2.6.13.Final
+    image: {apicurio-registry-docker-image}
     ports:
       - 8081:8080
     depends_on:
@@ -567,7 +567,7 @@ public class KafkaAndSchemaRegistryTestResource implements QuarkusTestResourceLi
     @Override
     public Map<String, String> start() {
         kafka.start();
-        registry = new GenericContainer<>("apicurio/apicurio-registry-mem:2.4.2.Final")
+        registry = new GenericContainer<>("{apicurio-registry-docker-image}")
                 .withExposedPorts(8080)
                 .withEnv("QUARKUS_PROFILE", "prod");
         registry.start();

docs/src/main/asciidoc/kafka-schema-registry-json-schema.adoc

@@ -361,7 +361,7 @@ services:
       LOG_DIR: "/tmp/logs"
 
   schema-registry:
-    image: apicurio/apicurio-registry-mem:2.6.13.Final
+    image: {apicurio-registry-docker-image}
     ports:
       - 8081:8080
     depends_on:
@@ -595,7 +595,7 @@ public class KafkaAndSchemaRegistryTestResource implements QuarkusTestResourceLi
     @Override
     public Map<String, String> start() {
         kafka.start();
-        registry = new GenericContainer<>("apicurio/apicurio-registry-mem:2.4.2.Final")
+        registry = new GenericContainer<>("{apicurio-registry-docker-image}")
                 .withExposedPorts(8080)
                 .withEnv("QUARKUS_PROFILE", "prod");
         registry.start();
@@ -634,7 +634,7 @@ For example, with Apicurio Dev Service if you set the image name to use version
 
 [source,properties]
 ----
-quarkus.apicurio-registry.devservices.image-name=quay.io/apicurio/apicurio-registry-mem:2.1.5.Final
+quarkus.apicurio-registry.devservices.image-name=apicurio/apicurio-registry-mem:2.1.5.Final
 ----
 
 You need to make sure that `apicurio-registry-serdes-json-schema-serde` dependency

extensions/schema-registry/devservice/deployment/src/main/apicurio-registry-devservice.properties

@@ -0,0 +1 @@
+default.image=${apicurio-registry.docker.image}

extensions/schema-registry/devservice/deployment/src/main/java/io/quarkus/apicurio/registry/devservice/ApicurioRegistryBuildTimeConfig.java

@@ -4,11 +4,7 @@
 import java.util.Optional;
 import java.util.OptionalInt;
 
-import io.quarkus.runtime.annotations.ConfigDocMapKey;
-import io.quarkus.runtime.annotations.ConfigDocSection;
-import io.quarkus.runtime.annotations.ConfigGroup;
-import io.quarkus.runtime.annotations.ConfigPhase;
-import io.quarkus.runtime.annotations.ConfigRoot;
+import io.quarkus.runtime.annotations.*;
 import io.smallrye.config.ConfigMapping;
 import io.smallrye.config.WithDefault;
 
@@ -47,8 +43,8 @@ interface ApicurioRegistryDevServicesBuildTimeConfig {
          * Note that only Apicurio Registry 2.x images are supported.
          * Specifically, the image repository must end with {@code apicurio/apicurio-registry-mem}.
          */
-        @WithDefault("quay.io/apicurio/apicurio-registry-mem:2.4.2.Final")
-        String imageName();
+        @ConfigDocDefault(value = "`{apicurio-registry-docker-image}`", escape = false)
+        Optional<String> imageName();
 
         /**
          * Indicates if the Apicurio Registry instance managed by Quarkus Dev Services is shared.

extensions/schema-registry/devservice/deployment/src/main/java/io/quarkus/apicurio/registry/devservice/DevServicesApicurioRegistryProcessor.java

@@ -1,5 +1,6 @@
 package io.quarkus.apicurio.registry.devservice;
 
+import static io.quarkus.devservices.common.ConfigureUtil.getDefaultImageNameFor;
 import static io.quarkus.devservices.common.ContainerLocator.locateContainerWithLabels;
 import static io.quarkus.devservices.common.Labels.QUARKUS_DEV_SERVICE;
 
@@ -234,7 +235,7 @@ private static final class ApicurioRegistryDevServiceCfg {
 
         public ApicurioRegistryDevServiceCfg(ApicurioRegistryDevServicesBuildTimeConfig config) {
             this.devServicesEnabled = config.enabled().orElse(true);
-            this.imageName = config.imageName();
+            this.imageName = config.imageName().orElseGet(() -> getDefaultImageNameFor("apicurio-registry"));
             this.fixedExposedPort = config.port().orElse(0);
             this.shared = config.shared();
             this.serviceName = config.serviceName();

integration-tests/kafka-avro-apicurio2/src/main/resources/application.properties

@@ -5,4 +5,4 @@ quarkus.log.category.\"org.apache.zookeeper\".level=WARN
 # enable health check
 quarkus.kafka.health.enabled=true
 
-quarkus.apicurio-registry.devservices.image-name=quay.io/apicurio/apicurio-registry-mem:2.4.2.Final
+quarkus.apicurio-registry.devservices.image-name={apicurio-registry-docker-image}