Add flag for specifically disabling automatic registration/deregistration

Author: Auri Munoz

extensions/smallrye-stork/deployment/src/main/java/io/quarkus/stork/deployment/SmallRyeStorkProcessor.java

@@ -2,6 +2,8 @@
 
 import static java.util.Arrays.asList;
 
+import org.eclipse.microprofile.config.Config;
+import org.eclipse.microprofile.config.ConfigProvider;
 import org.jboss.jandex.DotName;
 import org.jboss.logging.Logger;
 
@@ -17,6 +19,7 @@
 import io.quarkus.deployment.annotations.ExecutionTime;
 import io.quarkus.deployment.annotations.Produce;
 import io.quarkus.deployment.annotations.Record;
+import io.quarkus.deployment.builditem.CombinedIndexBuildItem;
 import io.quarkus.deployment.builditem.RunTimeConfigurationDefaultBuildItem;
 import io.quarkus.deployment.builditem.RuntimeConfigSetupCompleteBuildItem;
 import io.quarkus.deployment.builditem.ShutdownContextBuildItem;
@@ -106,11 +109,21 @@ void initializeStork(SmallRyeStorkRecorder storkRecorder, ShutdownContextBuildIt
     @Record(ExecutionTime.RUNTIME_INIT)
     void checkStorkConsulRegistrar(BuildProducer<StorkRegistrationBuildItem> registration,
             BuildProducer<RunTimeConfigurationDefaultBuildItem> config,
-            StorkRegistrarConfigRecorder registrarConfigRecorder, StorkConfiguration configuration) {
+            StorkRegistrarConfigRecorder registrarConfigRecorder, StorkConfiguration configuration, Capabilities capabilities,
+            CombinedIndexBuildItem index) {
+        String smallryeHealthCheckDefaultUrl = "";
         if (QuarkusClassLoader.isClassPresentAtRuntime(CONSUL_SERVICE_REGISTRAR_PROVIDER)) {
-            registrarConfigRecorder.setupServiceRegistrarConfig(configuration, CONSUL_SERVICE_REGISTRAR_TYPE);
+            if (capabilities.isPresent(Capability.SMALLRYE_HEALTH)) {
+                Config quarkusConfig = ConfigProvider.getConfig();
+                smallryeHealthCheckDefaultUrl = quarkusConfig.getConfigValue("quarkus.management.root-path").getValue() + "/"
+                        + quarkusConfig.getConfigValue("quarkus.smallrye-health.root-path").getValue() + "/"
+                        + quarkusConfig.getConfigValue("quarkus.smallrye-health.liveness-path").getValue();
+            }
+            registrarConfigRecorder.setupServiceRegistrarConfig(configuration, CONSUL_SERVICE_REGISTRAR_TYPE,
+                    smallryeHealthCheckDefaultUrl);
         } else if (QuarkusClassLoader.isClassPresentAtRuntime(EUREKA_SERVICE_REGISTRAR_PROVIDER)) {
-            registrarConfigRecorder.setupServiceRegistrarConfig(configuration, EUREKA_SERVICE_REGISTRAR_TYPE);
+            registrarConfigRecorder.setupServiceRegistrarConfig(configuration, EUREKA_SERVICE_REGISTRAR_TYPE,
+                    smallryeHealthCheckDefaultUrl);
         }
         registration.produce(new StorkRegistrationBuildItem());
 

extensions/smallrye-stork/deployment/src/main/java/io/quarkus/stork/deployment/StorkRegistrationBuildItem.java

@@ -4,16 +4,4 @@
 
 public final class StorkRegistrationBuildItem extends SimpleBuildItem {
 
-    //    public static final String UNSET_VALUE = "<<unset>>";
-    //
-    //    private final List<ServiceConfig> serviceConfigs;
-
-    //    public StorkRegistrationBuildItem(List<ServiceConfig> serviceConfigs) {
-    //        this.serviceConfigs = serviceConfigs;
-    //    }
-
-    //    public List<ServiceConfig> getServiceConfigs() {
-    //        return this.serviceConfigs;
-    //    }
-
 }

extensions/smallrye-stork/runtime/src/main/java/io/quarkus/stork/SmallRyeStorkRegistrationRecorder.java

@@ -20,6 +20,13 @@ public void registerServiceInstance(StorkConfiguration configuration) {
         Config quarkusConfig = ConfigProvider.getConfig();
         for (ServiceConfig serviceConfig : serviceConfigs) {
             String serviceName = serviceConfig.serviceName();
+            if (configuration.serviceConfiguration().get(serviceName).serviceRegistrar().isPresent()) {
+                StorkServiceRegistrarConfiguration storkServiceRegistrarConfiguration = configuration.serviceConfiguration()
+                        .get(serviceName).serviceRegistrar().get();
+                if (!storkServiceRegistrarConfiguration.enabled()) {
+                    continue;
+                }
+            }
             Map<String, String> parameters = serviceConfig.serviceRegistrar().parameters();
             String host = parameters.containsKey("ip-address") ? parameters.get("ip-address")
                     : quarkusConfig.getValue("quarkus.http.host", String.class);
@@ -47,6 +54,13 @@ private void deregisterServiceInstance(StorkConfiguration configuration) {
         List<ServiceConfig> serviceConfigs = StorkConfigUtil.toStorkServiceConfig(configuration);
         for (ServiceConfig serviceConfig : serviceConfigs) {
             String serviceName = serviceConfig.serviceName();
+            if (configuration.serviceConfiguration().get(serviceName).serviceRegistrar().isPresent()) {
+                StorkServiceRegistrarConfiguration storkServiceRegistrarConfiguration = configuration.serviceConfiguration()
+                        .get(serviceName).serviceRegistrar().get();
+                if (!storkServiceRegistrarConfiguration.enabled()) {
+                    continue;
+                }
+            }
             Stork.getInstance().getService(serviceName).getServiceRegistrar().deregisterServiceInstance(serviceName).await()
                     .indefinitely();
         }

extensions/smallrye-stork/runtime/src/main/java/io/quarkus/stork/StorkConfigUtil.java

@@ -6,6 +6,7 @@
 import java.net.UnknownHostException;
 import java.util.ArrayList;
 import java.util.Enumeration;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -47,15 +48,22 @@ public static List<ServiceConfig> toStorkServiceConfig(StorkConfiguration storkC
         return storkServicesConfigs;
     }
 
-    public static ServiceConfiguration buildDefaultRegistrarConfiguration(String serviceRegistrarType) {
-        return buildServiceConfigurationWithRegistrar(serviceRegistrarType, Map.of());
+    public static ServiceConfiguration buildDefaultRegistrarConfiguration(String serviceRegistrarType, String healthCheckUrl) {
+        Map<String, String> parameters = new HashMap<>();
+        if (healthCheckUrl != null && !healthCheckUrl.isBlank()) {
+            parameters.put("health-check-url", healthCheckUrl);
+        }
+        return buildServiceConfigurationWithRegistrar(serviceRegistrarType, parameters);
     }
 
     public static ServiceConfiguration addRegistrarTypeIfAbsent(String serviceRegistrarType,
-            ServiceConfiguration serviceConfiguration) {
+            ServiceConfiguration serviceConfiguration, String healthCheckUrl) {
         Map<String, String> parameters = serviceConfiguration.serviceRegistrar()
                 .map(StorkServiceRegistrarConfiguration::parameters)
-                .orElse(Map.of());
+                .orElse(new HashMap<>());
+        if (healthCheckUrl != null && !healthCheckUrl.isBlank()) {
+            parameters.put("health-check-url", healthCheckUrl);
+        }
         return buildServiceConfigurationWithRegistrar(serviceRegistrarType, parameters);
     }
 
@@ -81,6 +89,11 @@ public Optional<StorkServiceRegistrarConfiguration> serviceRegistrar() {
     private static StorkServiceRegistrarConfiguration buildServiceRegistrarConfiguration(String type,
             Map<String, String> parameters) {
         return new StorkServiceRegistrarConfiguration() {
+            @Override
+            public boolean enabled() {
+                return true;
+            }
+
             @Override
             public Optional<String> type() {
                 return Optional.of(type);

extensions/smallrye-stork/runtime/src/main/java/io/quarkus/stork/StorkRegistrarConfigRecorder.java

@@ -14,7 +14,7 @@ public class StorkRegistrarConfigRecorder {
 
     private static final Logger LOGGER = Logger.getLogger(StorkRegistrarConfigRecorder.class.getName());
 
-    public void setupServiceRegistrarConfig(StorkConfiguration config, String serviceRegistrarType) {
+    public void setupServiceRegistrarConfig(StorkConfiguration config, String serviceRegistrarType, String healthCheckUrl) {
         Config quarkusConfig = ConfigProvider.getConfig();
         List<ServiceConfig> serviceConfigs = StorkConfigUtil.toStorkServiceConfig(config);
         List<ServiceConfig> registrationConfigs = serviceConfigs.stream()
@@ -23,21 +23,23 @@ public void setupServiceRegistrarConfig(StorkConfiguration config, String servic
                 .orElse("auri-application");
         if (registrationConfigs.isEmpty()) {
             config.serviceConfiguration().put(serviceName,
-                    StorkConfigUtil.buildDefaultRegistrarConfiguration(serviceRegistrarType));
+                    StorkConfigUtil.buildDefaultRegistrarConfiguration(serviceRegistrarType, healthCheckUrl));
         } else if (registrationConfigs.size() == 1) {
             config.serviceConfiguration().computeIfPresent(serviceName,
-                    (k, v) -> StorkConfigUtil.addRegistrarTypeIfAbsent(serviceRegistrarType, v));
+                    (k, serviceConfiguration) -> StorkConfigUtil.addRegistrarTypeIfAbsent(serviceRegistrarType,
+                            serviceConfiguration, healthCheckUrl));
         } else {
-            failOnMissingRegistrarTypes(registrationConfigs, serviceName);
+            failOnMissingRegistrarTypes(registrationConfigs);
         }
     }
 
-    private static void failOnMissingRegistrarTypes(List<ServiceConfig> registrationConfigs, String serviceName) {
+    private static void failOnMissingRegistrarTypes(List<ServiceConfig> registrationConfigs) {
         List<String> servicesWithMissingType = new ArrayList<>();
         for (ServiceConfig registrationConfig : registrationConfigs) {
             if (registrationConfig.serviceRegistrar().type().isBlank()) {
                 servicesWithMissingType.add(registrationConfig.serviceName());
-                LOGGER.info("Missing 'type' for service '" + serviceName + "'. This may lead to a runtime error.");
+                LOGGER.info("Missing 'type' for service '" + registrationConfig.serviceName()
+                        + "'. This may lead to a runtime error.");
             }
 
         }

extensions/smallrye-stork/runtime/src/main/java/io/quarkus/stork/StorkServiceRegistrarConfiguration.java

@@ -4,11 +4,18 @@
 import java.util.Optional;
 
 import io.quarkus.runtime.annotations.ConfigGroup;
+import io.smallrye.config.WithDefault;
 import io.smallrye.config.WithParentName;
 
 @ConfigGroup
 public interface StorkServiceRegistrarConfiguration {
 
+    /**
+     * Whether automatic registration and deregistration of service instances is enabled.
+     */
+    @WithDefault("true")
+    boolean enabled();
+
     /**
      * Configures service registrar type, e.g. "consul".
      * A ServiceRegistrarProvider for the type has to be available
@@ -21,7 +28,6 @@ public interface StorkServiceRegistrarConfiguration {
      * Check the documentation of the selected registrar type for available parameters
      *
      */
-    //    @ConfigItem(name = ConfigItem.PARENT)
     @WithParentName
     Map<String, String> parameters();