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>