feat: also support cleanup, provide context to dependent resources

metacosm · metacosm · commit dbab033c3622 · 2022-01-07T17:49:40.000+01:00
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/Builder.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/Builder.java
@@ -1,8 +1,9 @@
 package io.javaoperatorsdk.operator.api.config.dependent;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
 
 @FunctionalInterface
 public interface Builder<R, P extends HasMetadata> {
-  R buildFor(P primary);
+  R buildFor(P primary, Context context);
 }
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/Cleaner.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/Cleaner.java
@@ -0,0 +1,9 @@
+package io.javaoperatorsdk.operator.api.config.dependent;
+
+import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
+
+public interface Cleaner<R, P extends HasMetadata> {
+
+  void delete(R fetched, P primary, Context context);
+}
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DependentResource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DependentResource.java
@@ -1,34 +1,43 @@
 package io.javaoperatorsdk.operator.api.config.dependent;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
 
 public abstract class DependentResource<R, P extends HasMetadata>
-    implements Builder<R, P>, Updater<R, P>, Persister<R, P> {
+    implements Builder<R, P>, Updater<R, P>, Persister<R, P>, Cleaner<R, P> {
 
   private final Builder<R, P> builder;
   private final Updater<R, P> updater;
+  private final Cleaner<R, P> cleaner;
   private final Class<R> resourceType;
 
-  public DependentResource(Class<R> resourceType, Builder<R, P> builder, Updater<R, P> updater) {
+  public DependentResource(Class<R> resourceType, Builder<R, P> builder, Updater<R, P> updater,
+      Cleaner<R, P> cleaner) {
     this.builder = builder;
     this.updater = updater;
     this.resourceType = resourceType;
+    this.cleaner = cleaner;
   }
 
   public String descriptionFor(R resource) {
     return resource.toString();
   }
 
   @Override
-  public R buildFor(P primary) {
-    return builder.buildFor(primary);
+  public R buildFor(P primary, Context context) {
+    return builder.buildFor(primary, context);
   }
 
   @Override
-  public R update(R fetched, P primary) {
-    return updater.update(fetched, primary);
+  public R update(R fetched, P primary, Context context) {
+    return updater.update(fetched, primary, context);
+  }
+
+  @Override
+  public void delete(R fetched, P primary, Context context) {
+    cleaner.delete(fetched, primary, context);
   }
 
   public Class<R> getResourceType() {
@@ -44,4 +53,8 @@ public boolean creatable() {
   public boolean updatable() {
     return updater != null;
   }
+
+  public boolean deletable() {
+    return cleaner != null;
+  }
 }
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DependentResourceConfiguration.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DependentResourceConfiguration.java
@@ -3,6 +3,7 @@
 import java.util.Set;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 import io.javaoperatorsdk.operator.processing.event.source.AssociatedSecondaryResourceIdentifier;
 import io.javaoperatorsdk.operator.processing.event.source.PrimaryResourcesRetriever;
@@ -23,6 +24,8 @@
 
   Class<? extends Updater> updater() default DEFAULT_UPDATER.class;
 
+  Class<? extends Cleaner> cleaner() default DEFAULT_CLEANER.class;
+
   Class<? extends PrimaryResourcesRetriever> associatedPrimariesRetriever() default DEFAULT_PRIMARIES_RETRIEVER.class;
 
   Class<? extends AssociatedSecondaryResourceIdentifier> associatedSecondaryIdentifier() default DEFAULT_SECONDARY_IDENTIFIER.class;
@@ -47,22 +50,29 @@
   String labelSelector() default EMPTY_STRING;
 
 
-  final class DEFAULT_BUILDER implements Builder<HasMetadata, HasMetadata> {
+  final class DEFAULT_BUILDER implements Builder<Object, HasMetadata> {
 
     @Override
-    public HasMetadata buildFor(HasMetadata primary) {
+    public Object buildFor(HasMetadata primary, Context context) {
       return null;
     }
   }
 
-  final class DEFAULT_UPDATER implements Updater<HasMetadata, HasMetadata> {
-
+  final class DEFAULT_UPDATER implements Updater<Object, HasMetadata> {
     @Override
-    public HasMetadata update(HasMetadata fetched, HasMetadata primary) {
+    public Object update(Object fetched, HasMetadata primary, Context context) {
       return null;
     }
   }
 
+  final class DEFAULT_CLEANER implements Cleaner<Object, HasMetadata> {
+
+    @Override
+    public void delete(Object fetched, HasMetadata primary, Context context) {
+
+    }
+  }
+
 
   final class DEFAULT_PRIMARIES_RETRIEVER implements PrimaryResourcesRetriever<Object> {
 
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/KubernetesDependentResource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/KubernetesDependentResource.java
@@ -2,6 +2,7 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.fabric8.kubernetes.client.KubernetesClient;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
 import io.javaoperatorsdk.operator.processing.event.source.informer.InformerConfiguration;
@@ -16,8 +17,8 @@ public class KubernetesDependentResource<R extends HasMetadata, P extends HasMet
 
 
   public KubernetesDependentResource(Class<R> resourceType, boolean owned, Builder<R, P> builder,
-      Updater<R, P> updater, InformerConfiguration<R, P> configuration) {
-    super(resourceType, builder, updater);
+      Updater<R, P> updater, Cleaner<R, P> cleaner, InformerConfiguration<R, P> configuration) {
+    super(resourceType, builder, updater, cleaner);
     this.configuration = configuration;
     this.owned = owned;
   }
@@ -38,12 +39,12 @@ public EventSource initEventSource(EventSourceContext<P> context) {
   }
 
   @Override
-  public void createOrReplace(R dependentResource) {
+  public void createOrReplace(R dependentResource, Context context) {
     client.resource(dependentResource).createOrReplace();
   }
 
   @Override
-  public R getFor(P primary) {
+  public R getFor(P primary, Context context) {
     return informer.getAssociated(primary).orElse(null);
   }
 
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/Persister.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/Persister.java
@@ -1,10 +1,11 @@
 package io.javaoperatorsdk.operator.api.config.dependent;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
 
 public interface Persister<R, P extends HasMetadata> {
 
-  void createOrReplace(R dependentResource);
+  void createOrReplace(R dependentResource, Context context);
 
-  R getFor(P primary);
+  R getFor(P primary, Context context);
 }
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/Updater.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/Updater.java
@@ -1,9 +1,10 @@
 package io.javaoperatorsdk.operator.api.config.dependent;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
 
 @FunctionalInterface
 public interface Updater<R, P extends HasMetadata> {
 
-  R update(R fetched, P primary);
+  R update(R fetched, P primary, Context context);
 }
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/DefaultContext.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/DefaultContext.java
@@ -1,11 +1,10 @@
 package io.javaoperatorsdk.operator.api.reconciler;
 
-import java.util.Map;
 import java.util.Optional;
+import java.util.concurrent.ConcurrentHashMap;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.processing.Controller;
-import java.util.concurrent.ConcurrentHashMap;
 
 public class DefaultContext<P extends HasMetadata> implements Context {
 
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/Controller.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/Controller.java
@@ -62,7 +62,7 @@ public Controller(Reconciler<R> reconciler,
     prepareEventSources(context).forEach(eventSourceManager::registerEventSource);
   }
 
-  private void waitUntilStarted() {
+  private void waitUntilStartedAndInitContext(R resource, Context context) {
     if (!started.get()) {
       AtomicInteger count = new AtomicInteger(0);
       final var waitTime = 50;
@@ -77,11 +77,32 @@ private void waitUntilStarted() {
       log.info("Waited {}ms for controller '{}' to finish initializing", count.get() * waitTime,
           configuration.getName());
     }
+
+    if (reconciler instanceof ContextInitializer) {
+      final var initializer = (ContextInitializer<R>) reconciler;
+      initializer.initContext(resource, context);
+    }
   }
 
   @Override
   public DeleteControl cleanup(R resource, Context context) {
-    waitUntilStarted();
+    waitUntilStartedAndInitContext(resource, context);
+
+    configuration.getDependentResources().stream()
+        .filter(DependentResource::deletable)
+        .forEach(dependent -> {
+          var dependentResource = dependent.getFor(resource, context);
+          if (dependentResource != null) {
+            dependent.delete(dependentResource, resource, context);
+            logOperationInfo(resource, dependent, dependentResource, "Deleting");
+          } else {
+            log.info("Ignoring already deleted {} for '{}' {}",
+                dependent.getResourceType().getName(),
+                resource.getMetadata().getName(),
+                configuration.getResourceTypeName());
+          }
+        });
+
     return metrics().timeControllerExecution(
         new ControllerExecution<>() {
           @Override
@@ -108,30 +129,23 @@ public DeleteControl execute() {
 
   @Override
   public UpdateControl<R> reconcile(R resource, Context context) {
-    waitUntilStarted();
-
-    if (reconciler instanceof ContextInitializer) {
-      final var initializer = (ContextInitializer<R>) reconciler;
-      initializer.initContext(resource, context);
-    }
-
-    configuration.getDependentResources().forEach(dependent -> {
-      if (!dependent.creatable() && !dependent.updatable()) {
-        return;
-      }
-
-      var dependentResource = dependent.getFor(resource);
-      if (dependent.creatable() && dependentResource == null) {
-        // we need to create the dependent
-        dependentResource = dependent.buildFor(resource);
-        createOrReplaceDependent(resource, dependent, dependentResource, "Creating");
-      } else if (dependent.updatable()) {
-        dependentResource = dependent.update(dependentResource, resource);
-        createOrReplaceDependent(resource, dependent, dependentResource, "Updating");
-      } else {
-        logOperationInfo(resource, dependent, dependentResource, "Ignoring");
-      }
-    });
+    waitUntilStartedAndInitContext(resource, context);
+
+    configuration.getDependentResources().stream()
+        .filter(dependent -> !dependent.creatable() && !dependent.updatable())
+        .forEach(dependent -> {
+          var dependentResource = dependent.getFor(resource, context);
+          if (dependent.creatable() && dependentResource == null) {
+            // we need to create the dependent
+            dependentResource = dependent.buildFor(resource, context);
+            createOrReplaceDependent(resource, context, dependent, dependentResource, "Creating");
+          } else if (dependent.updatable()) {
+            dependentResource = dependent.update(dependentResource, resource, context);
+            createOrReplaceDependent(resource, context, dependent, dependentResource, "Updating");
+          } else {
+            logOperationInfo(resource, dependent, dependentResource, "Ignoring");
+          }
+        });
 
     return metrics().timeControllerExecution(
         new ControllerExecution<>() {
@@ -166,7 +180,7 @@ public UpdateControl<R> execute() {
 
   // todo: rename variables more explicitly
   private void createOrReplaceDependent(R resource,
-      DependentResource dependent,
+      Context context, DependentResource dependent,
       Object dependentResource, String operationDescription) {
     // add owner reference if needed
     if (dependentResource instanceof HasMetadata
@@ -178,7 +192,7 @@ private void createOrReplaceDependent(R resource,
 
     // commit the changes
     // todo: add metrics timing for dependent resource
-    dependent.createOrReplace(dependentResource);
+    dependent.createOrReplace(dependentResource, context);
   }
 
   private void logOperationInfo(R resource, DependentResource dependent,
diff --git a/operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/AnnotationConfiguration.java b/operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/AnnotationConfiguration.java
@@ -130,6 +130,9 @@ public List<? extends DependentResource> getDependentResources() {
           final var updater =
               valueIfPresentOrNull(dependentConfig, DependentResourceConfiguration::updater,
                   DependentResourceConfiguration.DEFAULT_UPDATER.class);
+          final var cleaner =
+              valueIfPresentOrNull(dependentConfig, DependentResourceConfiguration::cleaner,
+                  DependentResourceConfiguration.DEFAULT_CLEANER.class);
           final var resourceType = dependentConfig.resourceType();
 
           if (HasMetadata.class.isAssignableFrom(resourceType)) {
@@ -150,7 +153,7 @@ public List<? extends DependentResource> getDependentResources() {
                 resourceType, primariesMapper, secondaryMapper,
                 dependentConfig.skipUpdateIfUnchanged(), namespaces);
             dependent = new KubernetesDependentResource(resourceType, dependentConfig.owned(),
-                builder, updater, configuration);
+                builder, updater, cleaner, configuration);
           } else {
             // todo:
             dependent = null;
diff --git a/sample-operators/mysql-schema/src/main/java/io/javaoperatorsdk/operator/sample/schema/SchemaService.java b/sample-operators/mysql-schema/src/main/java/io/javaoperatorsdk/operator/sample/schema/SchemaService.java
@@ -29,7 +29,7 @@ public Optional<Schema> getSchema(String name) {
     }
   }
 
-  public static void createSchemaAndRelatedUser(Connection connection, String schemaName,
+  public static Schema createSchemaAndRelatedUser(Connection connection, String schemaName,
       String encoding,
       String userName,
       String password) {
@@ -49,6 +49,8 @@ public static void createSchemaAndRelatedUser(Connection connection, String sche
         statement.execute(
             format("GRANT ALL ON `%1$s`.* TO '%2$s'", schemaName, userName));
       }
+
+      return new Schema(schemaName, encoding);
     } catch (SQLException e) {
       throw new IllegalStateException(e);
     }
diff --git a/sample-operators/tomcat-operator/src/main/java/io/javaoperatorsdk/operator/sample/DeploymentDependentResource.java b/sample-operators/tomcat-operator/src/main/java/io/javaoperatorsdk/operator/sample/DeploymentDependentResource.java
@@ -5,12 +5,13 @@
 import io.fabric8.kubernetes.api.model.apps.DeploymentBuilder;
 import io.javaoperatorsdk.operator.api.config.dependent.Builder;
 import io.javaoperatorsdk.operator.api.config.dependent.Updater;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
 
 public class DeploymentDependentResource
     implements Builder<Deployment, Tomcat>, Updater<Deployment, Tomcat> {
 
   @Override
-  public Deployment buildFor(Tomcat tomcat) {
+  public Deployment buildFor(Tomcat tomcat, Context context) {
     Deployment deployment = TomcatReconciler.loadYaml(Deployment.class, "deployment.yaml");
     final ObjectMeta tomcatMetadata = tomcat.getMetadata();
     final String tomcatName = tomcatMetadata.getName();
@@ -39,7 +40,7 @@ public Deployment buildFor(Tomcat tomcat) {
   }
 
   @Override
-  public Deployment update(Deployment fetched, Tomcat tomcat) {
+  public Deployment update(Deployment fetched, Tomcat tomcat, Context context) {
     return new DeploymentBuilder(fetched).editSpec().editTemplate().editSpec().editFirstContainer()
         .withImage("tomcat:" + tomcat.getSpec().getVersion())
         .endContainer().endSpec().endTemplate().endSpec().build();
diff --git a/sample-operators/tomcat-operator/src/main/java/io/javaoperatorsdk/operator/sample/ServiceDependentResource.java b/sample-operators/tomcat-operator/src/main/java/io/javaoperatorsdk/operator/sample/ServiceDependentResource.java
@@ -4,11 +4,12 @@
 import io.fabric8.kubernetes.api.model.Service;
 import io.fabric8.kubernetes.api.model.ServiceBuilder;
 import io.javaoperatorsdk.operator.api.config.dependent.Builder;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
 
 public class ServiceDependentResource implements Builder<Service, Tomcat> {
 
   @Override
-  public Service buildFor(Tomcat tomcat) {
+  public Service buildFor(Tomcat tomcat, Context context) {
     final ObjectMeta tomcatMetadata = tomcat.getMetadata();
     final Service service =
         new ServiceBuilder(TomcatReconciler.loadYaml(Service.class, "service.yaml"))

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,9 @@`
`1`	`1`	`package io.javaoperatorsdk.operator.api.config.dependent;`
`2`	`2`
`3`	`3`	`import io.fabric8.kubernetes.api.model.HasMetadata;`
	`4`	`+import io.javaoperatorsdk.operator.api.reconciler.Context;`
`4`	`5`
`5`	`6`	`@FunctionalInterface`
`6`	`7`	`public interface Builder<R, P extends HasMetadata> {`
`7`		`- R buildFor(P primary);`
	`8`	`+ R buildFor(P primary, Context context);`
`8`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,10 @@`
`1`	`1`	`package io.javaoperatorsdk.operator.api.config.dependent;`
`2`	`2`
`3`	`3`	`import io.fabric8.kubernetes.api.model.HasMetadata;`
	`4`	`+import io.javaoperatorsdk.operator.api.reconciler.Context;`
`4`	`5`
`5`	`6`	`@FunctionalInterface`
`6`	`7`	`public interface Updater<R, P extends HasMetadata> {`
`7`	`8`
`8`		`- R update(R fetched, P primary);`
	`9`	`+ R update(R fetched, P primary, Context context);`
`9`	`10`	`}`