feat: garbage collected interface

Author: csviri

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/GarbageCollected.java

@@ -0,0 +1,10 @@
+package io.javaoperatorsdk.operator.api.reconciler.dependent;
+
+/**
+ * Marker interface, that can be added in additionally to a {@link Deleter} Dependent Resource. It
+ * is used to model a situation when a resource is makes sure to delete during reconciliation, but
+ * not during cleanup, since that is handled by the Kubernetes garbage collector. See also:
+ * https://github.com/java-operator-sdk/java-operator-sdk/issues/1127
+ */
+public interface GarbageCollected {
+}

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

@@ -37,6 +37,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Deleter;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.EventSourceProvider;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.GarbageCollected;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.managed.DependentResourceConfigurator;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.managed.KubernetesClientAware;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.managed.ManagedDependentResourceException;
@@ -82,7 +83,8 @@ public Controller(Reconciler<P> reconciler,
       specs.forEach(drs -> {
         final var dependent = createAndConfigureFrom(drs, kubernetesClient);
         // check if dependent implements Deleter to record that fact
-        if (!hasDeleterHolder[0] && dependent instanceof Deleter) {
+        if (!hasDeleterHolder[0] && dependent instanceof Deleter
+            && !(dependent instanceof GarbageCollected)) {
           hasDeleterHolder[0] = true;
         }
         dependentsHolder.put(drs.getName(), dependent);
@@ -143,7 +145,7 @@ public DeleteControl execute() {
                   initContextIfNeeded(resource, context);
                   if (hasDeleterDependents) {
                     dependents.values().stream()
-                        .filter(d -> d instanceof Deleter)
+                        .filter(d -> d instanceof Deleter && !(d instanceof GarbageCollected))
                         .map(Deleter.class::cast)
                         .forEach(deleter -> deleter.delete(resource, context));
                   }

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

@@ -7,6 +7,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Deleter;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.GarbageCollected;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.ReconcileResult;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 
@@ -17,6 +18,7 @@ public abstract class AbstractDependentResource<R, P extends HasMetadata>
   protected final boolean creatable = this instanceof Creator;
   protected final boolean updatable = this instanceof Updater;
   protected final boolean deletable = this instanceof Deleter;
+  protected final boolean garbageCollected = this instanceof GarbageCollected;
   protected Creator<R, P> creator;
   protected Updater<R, P> updater;
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/CRUDKubernetesDependentResource.java

@@ -2,6 +2,7 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Deleter;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.GarbageCollected;
 import io.javaoperatorsdk.operator.processing.dependent.Creator;
 import io.javaoperatorsdk.operator.processing.dependent.Updater;
 
@@ -13,7 +14,8 @@
  */
 public abstract class CRUDKubernetesDependentResource<R extends HasMetadata, P extends HasMetadata>
     extends
-    KubernetesDependentResource<R, P> implements Creator<R, P>, Updater<R, P>, Deleter<P> {
+    KubernetesDependentResource<R, P>
+    implements Creator<R, P>, Updater<R, P>, Deleter<P>, GarbageCollected {
 
   public CRUDKubernetesDependentResource(Class<R> resourceType) {
     super(resourceType);

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/CRUKubernetesDependentResource.java

@@ -146,7 +146,7 @@ protected InformerEventSource<R, P> createEventSource(EventSourceContext<P> cont
   }
 
   protected boolean addOwnerReference() {
-    return creatable && !deletable;
+    return creatable && deletable && garbageCollected;
   }
 
   @Override

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResource.java

@@ -5,10 +5,12 @@
 import io.fabric8.kubernetes.api.model.ConfigMap;
 import io.fabric8.kubernetes.api.model.ObjectMeta;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
-import io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUKubernetesDependentResource;
 
 public class ConfigMapDependentResource extends
-    CRUKubernetesDependentResource<ConfigMap, DependentOperationEventFilterCustomResource> {
+    io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResource<ConfigMap, DependentOperationEventFilterCustomResource>
+    implements
+    io.javaoperatorsdk.operator.processing.dependent.Creator<ConfigMap, DependentOperationEventFilterCustomResource>,
+    io.javaoperatorsdk.operator.processing.dependent.Updater<ConfigMap, DependentOperationEventFilterCustomResource> {
 
   public static final String KEY = "key1";
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/dependentoperationeventfiltering/ConfigMapDependentResource.java

@@ -7,7 +7,6 @@
 import io.fabric8.kubernetes.api.model.ObjectMeta;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.ReconcileResult;
-import io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUKubernetesDependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependent;
 
 @KubernetesDependent(labelSelector = "dependent = cm1")

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/orderedmanageddependent/ConfigMapDependentResource1.java

@@ -7,7 +7,6 @@
 import io.fabric8.kubernetes.api.model.ObjectMeta;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.ReconcileResult;
-import io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUKubernetesDependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependent;
 
 @KubernetesDependent(labelSelector = "dependent = cm2")

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/orderedmanageddependent/ConfigMapDependentResource2.java

@@ -10,7 +10,6 @@
 import io.fabric8.kubernetes.api.model.ConfigMapBuilder;
 import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
-import io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUKubernetesDependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependent;
 
 import static io.javaoperatorsdk.operator.sample.Utils.configMapName;

sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/ConfigMapDependentResource.java

@@ -6,7 +6,6 @@
 import io.fabric8.kubernetes.api.model.ConfigMapVolumeSourceBuilder;
 import io.fabric8.kubernetes.api.model.apps.Deployment;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
-import io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUKubernetesDependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependent;
 
 import static io.javaoperatorsdk.operator.ReconcilerUtils.loadYaml;
@@ -16,7 +15,10 @@
 
 // this annotation only activates when using managed dependents and is not otherwise needed
 @KubernetesDependent(labelSelector = WebPageManagedDependentsReconciler.SELECTOR)
-class DeploymentDependentResource extends CRUKubernetesDependentResource<Deployment, WebPage> {
+class DeploymentDependentResource extends
+    io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUDKubernetesDependentResource<Deployment, WebPage>
+    implements io.javaoperatorsdk.operator.processing.dependent.Creator<Deployment, WebPage>,
+    io.javaoperatorsdk.operator.processing.dependent.Updater<Deployment, WebPage> {
 
   public DeploymentDependentResource() {
     super(Deployment.class);

sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/DeploymentDependentResource.java

@@ -5,7 +5,6 @@
 
 import io.fabric8.kubernetes.api.model.Service;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
-import io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUKubernetesDependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependent;
 
 import static io.javaoperatorsdk.operator.ReconcilerUtils.loadYaml;
@@ -15,7 +14,10 @@
 
 // this annotation only activates when using managed dependents and is not otherwise needed
 @KubernetesDependent(labelSelector = WebPageManagedDependentsReconciler.SELECTOR)
-class ServiceDependentResource extends CRUKubernetesDependentResource<Service, WebPage> {
+class ServiceDependentResource extends
+    io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUDKubernetesDependentResource<Service, WebPage>
+    implements io.javaoperatorsdk.operator.processing.dependent.Creator<Service, WebPage>,
+    io.javaoperatorsdk.operator.processing.dependent.Updater<Service, WebPage> {
 
   public ServiceDependentResource() {
     super(Service.class);