Merge pull request #238 from halkyonio/quarkus-support

Extract controller configuration handling and provide Quarkus extension

Author: metacosm

README.md

@@ -63,14 +63,15 @@ Add [dependency](https://search.maven.org/search?q=a:operator-framework) to your
 </dependency>
 ```
 
-Main method initializing the Operator and registering a controller..
+Main method initializing the Operator and registering a controller.
 
 ```java
 public class Runner {
 
    public static void main(String[] args) {
-       Operator operator = new Operator(new DefaultKubernetesClient());
-       operator.registerController(new WebServerController());
+       Operator operator = new Operator(new DefaultKubernetesClient(),
+           DefaultConfigurationService.instance());
+       operator.register(new WebServerController());
    }
 }
 ```
@@ -135,18 +136,62 @@ public class WebServerSpec {
     }
 }
 ```
+          
+#### Quarkus
+
+A [Quarkus](https://quarkus.io) extension is also provided to ease the development of Quarkus-based operators.
+
+Add [this dependency] (https://search.maven.org/search?q=a:operator-framework-quarkus-extension)
+to your project:
+
+```xml
+<dependency>
+ <groupId>io.javaoperatorsdk</groupId>
+ <artifactId>operator-framework-quarkus-extension</artifactId>
+ <version>{see https://search.maven.org/search?q=a:operator-framework-quarkus-extension for latest version}</version>
+</dependency>
+```
+
+Create an Application, Quarkus will automatically create and inject a `KubernetesClient`, `Operator` 
+and `ConfigurationService` instances that your application can use, as shown below:
+
+```java
+@QuarkusMain
+public class QuarkusOperator implements QuarkusApplication {
+
+  @Inject KubernetesClient client;
+
+  @Inject Operator operator;
+
+  @Inject ConfigurationService configuration;
+
+  public static void main(String... args) {
+    Quarkus.run(QuarkusOperator.class, args);
+  }
+
+  @Override
+  public int run(String... args) throws Exception {
+    final var config = configuration.getConfigurationFor(new CustomServiceController(client));
+    System.out.println("CR class: " + config.getCustomResourceClass());
+    System.out.println("Doneable class = " + config.getDoneableClass());
+
+    Quarkus.waitForExit();
+    return 0;
+  }
+}
+```
 
 #### Spring Boot
 
 You can also let Spring Boot wire your application together and automatically register the controllers.
 
-Add [this dependency](https://search.maven.org/search?q=a:spring-boot-operator-framework-starter) to your project:
+Add [this dependency](https://search.maven.org/search?q=a:operator-framework-spring-boot-starter) to your project:
 
 ```xml
 <dependency>
  <groupId>io.javaoperatorsdk</groupId>
- <artifactId>spring-boot-operator-framework-starter</artifactId>
- <version>{see https://search.maven.org/search?q=a:spring-boot-operator-framework-starter for latest version}</version>
+ <artifactId>operator-framework-spring-boot-starter</artifactId>
+ <version>{see https://search.maven.org/search?q=a:operator-framework-spring-boot-starter for latest version}</version>
 </dependency>
 ```
 

operator-framework-core/pom.xml

@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>io.javaoperatorsdk</groupId>
+        <artifactId>java-operator-sdk</artifactId>
+        <version>1.5.1-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+
+    <artifactId>operator-framework-core</artifactId>
+    <name>Operator SDK - Framework - Core</name>
+    <description>Core framework for implementing Kubernetes operators</description>
+    <packaging>jar</packaging>
+
+    <properties>
+        <java.version>11</java.version>
+        <maven.compiler.source>11</maven.compiler.source>
+        <maven.compiler.target>11</maven.compiler.target>
+    </properties>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>${surefire.version}</version>
+            </plugin>
+        </plugins>
+    </build>
+
+
+    <dependencies>
+        <dependency>
+            <groupId>io.fabric8</groupId>
+            <artifactId>openshift-client</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-engine</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-slf4j-impl</artifactId>
+            <version>2.13.3</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <version>3.18.0</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+</project>

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/ControllerUtils.java

@@ -0,0 +1,35 @@
+package io.javaoperatorsdk.operator;
+
+import io.fabric8.kubernetes.client.CustomResource;
+import io.javaoperatorsdk.operator.api.ResourceController;
+import java.util.Locale;
+
+public class ControllerUtils {
+
+  private static final String FINALIZER_NAME_SUFFIX = "/finalizer";
+
+  public static String getDefaultFinalizerName(String crdName) {
+    return crdName + FINALIZER_NAME_SUFFIX;
+  }
+
+  public static boolean hasGivenFinalizer(CustomResource resource, String finalizer) {
+    return resource.getMetadata().getFinalizers() != null
+        && resource.getMetadata().getFinalizers().contains(finalizer);
+  }
+
+  public static String getDefaultNameFor(ResourceController controller) {
+    return getDefaultNameFor(controller.getClass());
+  }
+
+  public static String getDefaultNameFor(Class<? extends ResourceController> controllerClass) {
+    return getDefaultResourceControllerName(controllerClass.getSimpleName());
+  }
+
+  public static String getDefaultResourceControllerName(String rcControllerClassName) {
+    final var lastDot = rcControllerClassName.lastIndexOf('.');
+    if (lastDot > 0) {
+      rcControllerClassName = rcControllerClassName.substring(lastDot);
+    }
+    return rcControllerClassName.toLowerCase(Locale.ROOT);
+  }
+}

operator-framework/src/main/java/io/javaoperatorsdk/operator/EventListUtils.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/EventListUtils.java

@@ -1,8 +1,5 @@
 package io.javaoperatorsdk.operator;
 
-import static io.javaoperatorsdk.operator.ControllerUtils.getCrdName;
-import static io.javaoperatorsdk.operator.ControllerUtils.getCustomResourceClass;
-
 import io.fabric8.kubernetes.api.model.apiextensions.v1beta1.CustomResourceDefinition;
 import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.client.CustomResourceDoneable;
@@ -13,11 +10,13 @@
 import io.fabric8.kubernetes.client.dsl.internal.CustomResourceOperationsImpl;
 import io.fabric8.kubernetes.internal.KubernetesDeserializer;
 import io.javaoperatorsdk.operator.api.ResourceController;
+import io.javaoperatorsdk.operator.api.config.ConfigurationService;
 import io.javaoperatorsdk.operator.processing.CustomResourceCache;
 import io.javaoperatorsdk.operator.processing.DefaultEventHandler;
 import io.javaoperatorsdk.operator.processing.EventDispatcher;
 import io.javaoperatorsdk.operator.processing.event.DefaultEventSourceManager;
 import io.javaoperatorsdk.operator.processing.event.internal.CustomResourceEventSource;
+import io.javaoperatorsdk.operator.processing.retry.GenericRetry;
 import io.javaoperatorsdk.operator.processing.retry.Retry;
 import java.util.Arrays;
 import java.util.HashMap;
@@ -30,11 +29,21 @@ public class Operator {
 
   private static final Logger log = LoggerFactory.getLogger(Operator.class);
   private final KubernetesClient k8sClient;
+  private final ConfigurationService configurationService;
   private Map<Class<? extends CustomResource>, CustomResourceOperationsImpl> customResourceClients =
       new HashMap<>();
 
-  public Operator(KubernetesClient k8sClient) {
+  public Operator(KubernetesClient k8sClient, ConfigurationService configurationService) {
     this.k8sClient = k8sClient;
+    this.configurationService = configurationService;
+  }
+
+  public <R extends CustomResource> void register(ResourceController<R> controller)
+      throws OperatorException {
+    final var configuration = configurationService.getConfigurationFor(controller);
+    final var retry = GenericRetry.fromConfiguration(configuration.getRetryConfiguration());
+    final var targetNamespaces = configuration.getNamespaces().toArray(new String[] {});
+    registerController(controller, configuration.watchAllNamespaces(), retry, targetNamespaces);
   }
 
   public <R extends CustomResource> void registerControllerForAllNamespaces(
@@ -65,16 +74,14 @@ private <R extends CustomResource> void registerController(
       Retry retry,
       String... targetNamespaces)
       throws OperatorException {
-    Class<R> resClass = getCustomResourceClass(controller);
+    final var configuration = configurationService.getConfigurationFor(controller);
+    Class<R> resClass = configuration.getCustomResourceClass();
     CustomResourceDefinitionContext crd = getCustomResourceDefinitionForController(controller);
     KubernetesDeserializer.registerCustomKind(crd.getVersion(), crd.getKind(), resClass);
-    String finalizer = ControllerUtils.getFinalizer(controller);
+    String finalizer = configuration.getFinalizer();
     MixedOperation client =
         k8sClient.customResources(
-            crd,
-            resClass,
-            CustomResourceList.class,
-            ControllerUtils.getCustomResourceDoneableClass(controller));
+            crd, resClass, CustomResourceList.class, configuration.getDoneableClass());
     EventDispatcher eventDispatcher =
         new EventDispatcher(
             controller, finalizer, new EventDispatcher.CustomResourceFacade(client));
@@ -98,7 +105,7 @@ private <R extends CustomResource> void registerController(
             watchAllNamespaces,
             targetNamespaces,
             defaultEventHandler,
-            ControllerUtils.getGenerationEventProcessing(controller),
+            configuration.isGenerationAware(),
             finalizer);
     eventSourceManager.registerCustomResourceEventSource(customResourceEventSource);
 
@@ -133,7 +140,7 @@ private CustomResourceEventSource createCustomResourceEventSource(
 
   private CustomResourceDefinitionContext getCustomResourceDefinitionForController(
       ResourceController controller) {
-    String crdName = getCrdName(controller);
+    final var crdName = configurationService.getConfigurationFor(controller).getCRDName();
     CustomResourceDefinition customResourceDefinition =
         k8sClient.customResourceDefinitions().withName(crdName).get();
     if (customResourceDefinition == null) {

operator-framework/src/main/java/io/javaoperatorsdk/operator/Operator.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java

@@ -8,10 +8,13 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE})
 public @interface Controller {
+
   String NULL = "";
 
   String crdName();
 
+  String name() default NULL;
+
   /**
    * Optional finalizer name, if it is not, the crdName will be used as the name of the finalizer
    * too.
@@ -24,4 +27,8 @@
    * href="https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#status-subresource">here</a>
    */
   boolean generationAwareEventProcessing() default true;
+
+  boolean isClusterScoped() default false;
+
+  String[] namespaces() default {};
 }

operator-framework/src/main/java/io/javaoperatorsdk/operator/OperatorException.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/OperatorException.java

@@ -2,6 +2,7 @@
 
 import io.fabric8.kubernetes.client.CustomResource;
 import io.javaoperatorsdk.operator.processing.event.EventSourceManager;
+import java.util.Locale;
 
 public interface ResourceController<R extends CustomResource> {
 
@@ -37,4 +38,20 @@ public interface ResourceController<R extends CustomResource> {
    * @param eventSourceManager
    */
   default void init(EventSourceManager eventSourceManager) {}
+
+  default String getName() {
+    final var clazz = getClass();
+
+    // if the controller annotation has a name attribute, use it
+    final var annotation = clazz.getAnnotation(Controller.class);
+    if (annotation != null) {
+      final var name = annotation.name();
+      if (!Controller.NULL.equals(name)) {
+        return name;
+      }
+    }
+
+    // otherwise, use the lower-cased class name
+    return clazz.getSimpleName().toLowerCase(Locale.ROOT);
+  }
 }

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/Context.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/Context.java

@@ -0,0 +1,15 @@
+package io.javaoperatorsdk.operator.api.config;
+
+import io.fabric8.kubernetes.client.Config;
+import io.fabric8.kubernetes.client.CustomResource;
+import io.javaoperatorsdk.operator.api.ResourceController;
+
+public interface ConfigurationService {
+
+  <R extends CustomResource> ControllerConfiguration<R> getConfigurationFor(
+      ResourceController<R> controller);
+
+  default Config getClientConfiguration() {
+    return Config.autoConfigure(null);
+  }
+}

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/Controller.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/Controller.java

@@ -0,0 +1,39 @@
+package io.javaoperatorsdk.operator.api.config;
+
+import io.fabric8.kubernetes.client.CustomResource;
+import io.fabric8.kubernetes.client.CustomResourceDoneable;
+import java.util.Collections;
+import java.util.Set;
+
+public interface ControllerConfiguration<R extends CustomResource> {
+
+  String WATCH_ALL_NAMESPACES_MARKER = "ALL_NAMESPACES";
+
+  String getName();
+
+  String getCRDName();
+
+  String getFinalizer();
+
+  boolean isGenerationAware();
+
+  Class<R> getCustomResourceClass();
+
+  Class<? extends CustomResourceDoneable<R>> getDoneableClass();
+
+  default boolean isClusterScoped() {
+    return false;
+  }
+
+  default Set<String> getNamespaces() {
+    return Collections.emptySet();
+  }
+
+  default boolean watchAllNamespaces() {
+    return getNamespaces().contains(WATCH_ALL_NAMESPACES_MARKER);
+  }
+
+  default RetryConfiguration getRetryConfiguration() {
+    return RetryConfiguration.DEFAULT;
+  }
+}

operator-framework/src/main/java/io/javaoperatorsdk/operator/api/DefaultContext.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/DefaultContext.java

@@ -0,0 +1,3 @@
+package io.javaoperatorsdk.operator.api.config;
+
+public class DefaultRetryConfiguration implements RetryConfiguration {}