feat: make it possible to not automatically add finalizers

Fixes #415

Author: metacosm

README.md

@@ -1,9 +1,11 @@
-# ![java-operator-sdk](docs/assets/images/logo.png) 
+# ![java-operator-sdk](docs/assets/images/logo.png)
+
 ![Java CI with Maven](https://github.com/java-operator-sdk/java-operator-sdk/workflows/Java%20CI%20with%20Maven/badge.svg)
 [![Discord](https://img.shields.io/discord/723455000604573736.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.com/channels/723455000604573736)
 
-Build Kubernetes Operators in Java without hassle. Inspired by [operator-sdk](https://github.com/operator-framework/operator-sdk).
-                 
+Build Kubernetes Operators in Java without hassle. Inspired
+by [operator-sdk](https://github.com/operator-framework/operator-sdk).
+
 
 Table of Contents
 ==========
@@ -15,17 +17,24 @@ Table of Contents
 1. [Usage](#Usage)
 
 ## Features
+
 * Framework for handling Kubernetes API events
 * Automatic registration of Custom Resource watches
 * Retry action on failure
 * Smart event scheduling (only handle the latest event for the same resource)
 
-Check out this [blog post](https://csviri.medium.com/deep-dive-building-a-kubernetes-operator-sdk-for-java-developers-5008218822cb) 
-about the non-trivial yet common problems needed to be solved for every operator. In case you are interested how to
-handle more complex scenarios take a look on [event sources](https://csviri.medium.com/java-operator-sdk-introduction-to-event-sources-a1aab5af4b7b).
+Check out
+this [blog post](https://csviri.medium.com/deep-dive-building-a-kubernetes-operator-sdk-for-java-developers-5008218822cb)
+about the non-trivial yet common problems needed to be solved for every operator. In case you are
+interested how to handle more complex scenarios take a look
+on [event sources](https://csviri.medium.com/java-operator-sdk-introduction-to-event-sources-a1aab5af4b7b)
+.
 
 ## Why build your own Operator?
-* Infrastructure automation using the power and flexibility of Java. See [blog post](https://blog.container-solutions.com/cloud-native-java-infrastructure-automation-with-kubernetes-operators).
+
+* Infrastructure automation using the power and flexibility of Java.
+  See [blog post](https://blog.container-solutions.com/cloud-native-java-infrastructure-automation-with-kubernetes-operators)
+  .
 * Provisioning of complex applications - avoiding Helm chart hell
 * Integration with Cloud services - e.g. Secret stores
 * Safer deployment of applications - only expose cluster to users by Custom Resources
@@ -40,8 +49,10 @@ handle more complex scenarios take a look on [event sources](https://csviri.medi
 #### Overview of the 1.9.0 changes
 
 - The Spring Boot starters have been moved to their own repositories and are now found at:
-  - https://github.com/java-operator-sdk/operator-framework-spring-boot-starter
-  - https://github.com/java-operator-sdk/operator-framework-spring-boot-starter-test
+    - https://github.com/java-operator-sdk/operator-framework-spring-boot-starter
+    - https://github.com/java-operator-sdk/operator-framework-spring-boot-starter-test
+- It is now possible to configure the controllers to not automatically add finalizers to resources.
+  See the `Controller` annotation documentation for more details.
 
 #### Overview of the 1.8.0 changes
 
@@ -81,18 +92,23 @@ the `Namescaped` interface.
 ## Usage
 
 We have several sample Operators under the [samples](samples) directory:
-* *pure-java*: Minimal Operator implementation which only parses the Custom Resource and prints to stdout.
-Implemented with and without Spring Boot support. The two samples share the common module.
+
+* *pure-java*: Minimal Operator implementation which only parses the Custom Resource and prints to
+  stdout. Implemented with and without Spring Boot support. The two samples share the common module.
 * *spring-boot-plain*: Sample showing integration with Spring Boot.
 
-There are also more samples in the standalone [samples repo](https://github.com/java-operator-sdk/samples):
-* *webserver*: Simple example creating an NGINX webserver from a Custom Resource containing HTML code.
+There are also more samples in the
+standalone [samples repo](https://github.com/java-operator-sdk/samples):
+
+* *webserver*: Simple example creating an NGINX webserver from a Custom Resource containing HTML
+  code.
 * *mysql-schema*: Operator managing schemas in a MySQL database.
 * *tomcat*: Operator with two controllers, managing Tomcat instances and Webapps for these.
 
 Add [dependency](https://search.maven.org/search?q=a:operator-framework) to your project with Maven:
 
 ```xml
+
 <dependency>
   <groupId>io.javaoperatorsdk</groupId>
   <artifactId>operator-framework</artifactId>
@@ -110,52 +126,59 @@ dependencies {
 }
 ```
 
-Once you've added the dependency, define a main method initializing the Operator and registering a controller.
+Once you've added the dependency, define a 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(),
-           DefaultConfigurationService.instance());
-       operator.register(new WebServerController());
-   }
+  public static void main(String[] args) {
+    Operator operator = new Operator(new DefaultKubernetesClient(),
+        DefaultConfigurationService.instance());
+    operator.register(new WebServerController());
+  }
 }
 ```
 
 The Controller implements the business logic and describes all the classes needed to handle the CRD.
 
 ```java
+
 @Controller
 public class WebServerController implements ResourceController<WebServer> {
-   
-    // Return the changed resource, so it gets updated. See javadoc for details.
-    @Override
-    public UpdateControl<CustomService> createOrUpdateResource(CustomService resource, Context<WebServer> context) {
-        // ... your logic ...
-        return UpdateControl.updateStatusSubResource(resource);
-    }
+
+  // Return the changed resource, so it gets updated. See javadoc for details.
+  @Override
+  public UpdateControl<CustomService> createOrUpdateResource(CustomService resource,
+      Context<WebServer> context) {
+    // ... your logic ...
+    return UpdateControl.updateStatusSubResource(resource);
+  }
 }
 ```
 
 A sample custom resource POJO representation
 
 ```java
+
 @Group("sample.javaoperatorsdk")
 @Version("v1")
-public class WebServer extends CustomResource<WebServerSpec, WebServerStatus> implements Namespaced {}
+public class WebServer extends CustomResource<WebServerSpec, WebServerStatus> implements
+    Namespaced {
+
+}
 
 public class WebServerSpec {
 
-    private String html;
+  private String html;
 
-    public String getHtml() {
-        return html;
-    }
+  public String getHtml() {
+    return html;
+  }
 
-    public void setHtml(String html) {
-        this.html = html;
-    }
+  public void setHtml(String html) {
+    this.html = html;
+  }
 }
 ```
 
@@ -174,6 +197,7 @@ To automatically generate CRD manifests from your annotated Custom Resource clas
 to add the following dependencies to your project:
 
 ```xml
+
 <dependency>
   <groupId>io.fabric8</groupId>
   <artifactId>crd-generator-apt</artifactId>
@@ -194,7 +218,8 @@ a `mycrs` plural form will result in 2 files:
 
 ### Quarkus
 
-A [Quarkus](https://quarkus.io) extension is also provided to ease the development of Quarkus-based operators.
+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:quarkus-operator-sdk)
 to your project:
@@ -204,17 +229,23 @@ to your project:
 <dependency>
   <groupId>io.quarkiverse.operatorsdk</groupId>
   <artifactId>quarkus-operator-sdk</artifactId>
-  <version>{see https://search.maven.org/search?q=a:quarkus-operator-sdk for latest version}</version>
+  <version>{see https://search.maven.org/search?q=a:quarkus-operator-sdk for latest version}
+  </version>
 </dependency>
 ```
 
-Create an Application, Quarkus will automatically create and inject a `KubernetesClient` (or `OpenShiftClient`), `Operator`, `ConfigurationService` and `ResourceController` instances that your application can use. Below, you can see the minimal code you need to write to get your operator and controllers up and running: 
+Create an Application, Quarkus will automatically create and inject a `KubernetesClient` (
+or `OpenShiftClient`), `Operator`, `ConfigurationService` and `ResourceController` instances that
+your application can use. Below, you can see the minimal code you need to write to get your operator
+and controllers up and running:
 
 ```java
+
 @QuarkusMain
 public class QuarkusOperator implements QuarkusApplication {
 
-  @Inject Operator operator;
+  @Inject
+  Operator operator;
 
   public static void main(String... args) {
     Quarkus.run(QuarkusOperator.class, args);
@@ -231,49 +262,62 @@ public class QuarkusOperator implements QuarkusApplication {
 
 ### Spring Boot
 
-You can also let Spring Boot wire your application together and automatically register the controllers.
+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:operator-framework-spring-boot-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>operator-framework-spring-boot-starter</artifactId>
- <version>{see https://search.maven.org/search?q=a:operator-framework-spring-boot-starter for latest version}</version>
+  <groupId>io.javaoperatorsdk</groupId>
+  <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>
 ```
 
 Create an Application
+
 ```java
+
 @SpringBootApplication
 public class Application {
-    public static void main(String[] args) {
-        SpringApplication.run(Application.class, args);
-    }
+
+  public static void main(String[] args) {
+    SpringApplication.run(Application.class, args);
+  }
 }
 ```
 
 #### Spring Boot test support
 
-Adding the following dependency would let you mock the operator for the 
-tests where loading the spring container is necessary, 
-but it doesn't need real access to a Kubernetes cluster.
+Adding the following dependency would let you mock the operator for the tests where loading the
+spring container is necessary, but it doesn't need real access to a Kubernetes cluster.
 
 ```xml
+
 <dependency>
- <groupId>io.javaoperatorsdk</groupId>
- <artifactId>operator-framework-spring-boot-starter-test</artifactId>
- <version>{see https://search.maven.org/search?q=a:operator-framework-spring-boot-starter for latest version}</version>
+  <groupId>io.javaoperatorsdk</groupId>
+  <artifactId>operator-framework-spring-boot-starter-test</artifactId>
+  <version>{see https://search.maven.org/search?q=a:operator-framework-spring-boot-starter for
+    latest version}
+  </version>
 </dependency>
 ``` 
 
 Mock the operator:
+
 ```java
+
 @SpringBootTest
 @EnableMockOperator
 public class SpringBootStarterSampleApplicationTest {
 
   @Test
-  void contextLoads() {}
+  void contextLoads() {
+  }
 }
 ```

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

@@ -11,12 +11,14 @@
 
   String NULL = "";
   String WATCH_CURRENT_NAMESPACE = "JOSDK_WATCH_CURRENT";
+  String NO_FINALIZER = "JOSDK_NO_FINALIZER";
 
   String name() default NULL;
 
   /**
-   * Optional finalizer name, if it is not, the crdName will be used as the name of the finalizer
-   * too.
+   * Optional finalizer name, if it is not provided, one will be automatically generated. If the
+   * provided value is the value specified by {@link #NO_FINALIZER}, then no finalizer will be added
+   * to custom resources.
    *
    * @return the finalizer name
    */

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/ResourceController.java

@@ -9,15 +9,21 @@ public interface ResourceController<R extends CustomResource> {
    * The implementation should delete the associated component(s). Note that this is method is
    * called when an object is marked for deletion. After it's executed the custom resource finalizer
    * is automatically removed by the framework; unless the return value is {@link
-   * DeleteControl#NO_FINALIZER_REMOVAL} - note that this is almost never the case. It's important
-   * to have the implementation also idempotent, in the current implementation to cover all edge
-   * cases actually will be executed mostly twice.
+   * DeleteControl#NO_FINALIZER_REMOVAL}, which indicates that the controller has determined that
+   * the resource should not be deleted yet, in which case it is up to the controller to restore the
+   * resource's status so that it's not marked for deletion anymore.
+   *
+   * <p>It's important that this method be idempotent, as it could be called several times,
+   * depending on the conditions and the controller's configuration (for example, if the controller
+   * is configured to not use a finalizer but the resource does have finalizers, it might be be
+   * "offered" again for deletion several times until the finalizers are all removed.
    *
    * @param resource the resource that is marked for deletion
    * @param context the context with which the operation is executed
    * @return {@link DeleteControl#DEFAULT_DELETE} - so the finalizer is automatically removed after
    *     the call. {@link DeleteControl#NO_FINALIZER_REMOVAL} if you don't want to remove the
-   *     finalizer. Note that this is ALMOST NEVER the case.
+   *     finalizer to indicate that the resource should not be deleted after all, in which case the
+   *     controller should restore the resource's state appropriately.
    */
   default DeleteControl deleteResource(R resource, Context<R> context) {
     return DeleteControl.DEFAULT_DELETE;

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfiguration.java

@@ -57,4 +57,8 @@ default RetryConfiguration getRetryConfiguration() {
   ConfigurationService getConfigurationService();
 
   void setConfigurationService(ConfigurationService service);
+
+  default boolean useFinalizer() {
+    return !Controller.NO_FINALIZER.equals(getFinalizer());
+  }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/DefaultEventHandler.java

@@ -48,7 +48,7 @@ public class DefaultEventHandler implements EventHandler {
   public DefaultEventHandler(
       ResourceController controller, ControllerConfiguration configuration, MixedOperation client) {
     this(
-        new EventDispatcher(controller, configuration.getFinalizer(), client),
+        new EventDispatcher(controller, configuration, client),
         configuration.getName(),
         GenericRetry.fromConfiguration(configuration.getRetryConfiguration()),
         configuration.getConfigurationService().concurrentReconciliationThreads());