feat: bulk dependent resource

csviri · csviri · commit 413197799295 · 2025-01-02T19:26:47.000+01:00
Signed-off-by: Attila Mészáros &lt;a_meszaros@apple.com&gt;
diff --git a/src/main/java/io/javaoperatorsdk/operator/glue/Utils.java b/src/main/java/io/javaoperatorsdk/operator/glue/Utils.java
@@ -138,9 +138,7 @@ public static String getKindFromTemplate(String resourceTemplate) {
   public static Set<String> leafResourceNames(Glue glue) {
     Set<String> result = new HashSet<>();
     glue.getSpec().getChildResources().forEach(r -> result.add(r.getName()));
-    glue.getSpec().getChildResources().forEach(r -> {
-      r.getDependsOn().forEach(result::remove);
-    });
+    glue.getSpec().getChildResources().forEach(r -> r.getDependsOn().forEach(result::remove));
     return result;
   }
 
@@ -157,4 +155,10 @@ private static String getPropertyValueFromTemplate(String resourceTemplate, Stri
             "Template does not contain property. " + resourceTemplate));
   }
 
+  public static GroupVersionKind getGVKFromTemplate(String resourceTemplate) {
+    String apiVersion = getApiVersionFromTemplate(resourceTemplate);
+    String kind = getKindFromTemplate(resourceTemplate);
+    return new GroupVersionKind(apiVersion, kind);
+  }
+
 }
diff --git a/src/main/java/io/javaoperatorsdk/operator/glue/customresource/glue/DependentResourceSpec.java b/src/main/java/io/javaoperatorsdk/operator/glue/customresource/glue/DependentResourceSpec.java
@@ -23,6 +23,8 @@ public class DependentResourceSpec {
 
   private Matcher matcher = Matcher.SSA;
 
+  private Boolean bulk = false;
+
   private List<String> dependsOn = new ArrayList<>();
 
   @PreserveUnknownFields
@@ -102,6 +104,14 @@ public void setMatcher(Matcher matcher) {
     this.matcher = matcher;
   }
 
+  public Boolean getBulk() {
+    return bulk;
+  }
+
+  public void setBulk(Boolean bulk) {
+    this.bulk = bulk;
+  }
+
   @Override
   public boolean equals(Object o) {
     if (this == o)
@@ -112,14 +122,14 @@ public boolean equals(Object o) {
     return clusterScoped == that.clusterScoped && Objects.equals(name, that.name)
         && Objects.equals(resource, that.resource)
         && Objects.equals(resourceTemplate, that.resourceTemplate) && matcher == that.matcher
-        && Objects.equals(dependsOn, that.dependsOn)
+        && Objects.equals(bulk, that.bulk) && Objects.equals(dependsOn, that.dependsOn)
         && Objects.equals(readyPostCondition, that.readyPostCondition)
         && Objects.equals(condition, that.condition);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(name, clusterScoped, resource, resourceTemplate, matcher, dependsOn,
+    return Objects.hash(name, clusterScoped, resource, resourceTemplate, matcher, bulk, dependsOn,
         readyPostCondition, condition);
   }
 }
diff --git a/src/main/java/io/javaoperatorsdk/operator/glue/dependent/GCGenericBulkDependentResource.java b/src/main/java/io/javaoperatorsdk/operator/glue/dependent/GCGenericBulkDependentResource.java
@@ -0,0 +1,17 @@
+package io.javaoperatorsdk.operator.glue.dependent;
+
+import io.javaoperatorsdk.operator.api.reconciler.dependent.GarbageCollected;
+import io.javaoperatorsdk.operator.glue.customresource.glue.Glue;
+import io.javaoperatorsdk.operator.glue.customresource.glue.Matcher;
+import io.javaoperatorsdk.operator.glue.templating.GenericTemplateHandler;
+
+public class GCGenericBulkDependentResource extends GenericBulkDependentResource
+    implements GarbageCollected<Glue> {
+
+  public GCGenericBulkDependentResource(GenericTemplateHandler genericTemplateHandler,
+      String desiredTemplate, String name,
+      boolean clusterScoped, Matcher matcher) {
+    super(genericTemplateHandler, desiredTemplate, name, clusterScoped, matcher);
+  }
+
+}
diff --git a/src/main/java/io/javaoperatorsdk/operator/glue/dependent/GenericBulkDependentResource.java b/src/main/java/io/javaoperatorsdk/operator/glue/dependent/GenericBulkDependentResource.java
@@ -0,0 +1,52 @@
+package io.javaoperatorsdk.operator.glue.dependent;
+
+import java.util.Map;
+import java.util.stream.Collectors;
+
+import io.fabric8.kubernetes.api.model.GenericKubernetesResource;
+import io.fabric8.kubernetes.api.model.GenericKubernetesResourceList;
+import io.fabric8.kubernetes.client.utils.Serialization;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
+import io.javaoperatorsdk.operator.glue.customresource.glue.Glue;
+import io.javaoperatorsdk.operator.glue.customresource.glue.Matcher;
+import io.javaoperatorsdk.operator.glue.templating.GenericTemplateHandler;
+import io.javaoperatorsdk.operator.processing.dependent.BulkDependentResource;
+
+import static io.javaoperatorsdk.operator.glue.reconciler.glue.GlueReconciler.DEPENDENT_NAME_ANNOTATION_KEY;
+
+public class GenericBulkDependentResource extends
+    GenericDependentResource implements
+    BulkDependentResource<GenericKubernetesResource, Glue> {
+
+  public GenericBulkDependentResource(GenericTemplateHandler genericTemplateHandler,
+      String desiredTemplate, String name,
+      boolean clusterScoped,
+      Matcher matcher) {
+    super(genericTemplateHandler, desiredTemplate, name, clusterScoped, matcher);
+  }
+
+  @Override
+  public Map<String, GenericKubernetesResource> desiredResources(Glue primary,
+      Context<Glue> context) {
+
+    var res = genericTemplateHandler.processTemplate(desiredTemplate, primary, context);
+    var desiredList = Serialization.unmarshal(res, GenericKubernetesResourceList.class).getItems();
+    desiredList.forEach(r -> {
+      r.getMetadata().getAnnotations()
+          .put(DEPENDENT_NAME_ANNOTATION_KEY, name);
+      if (r.getMetadata().getNamespace() == null && !clusterScoped) {
+        r.getMetadata().setNamespace(primary.getMetadata().getNamespace());
+      }
+    });
+    return desiredList.stream().collect(Collectors.toMap(r -> r.getMetadata().getName(), r -> r));
+  }
+
+  @Override
+  public Map<String, GenericKubernetesResource> getSecondaryResources(Glue glue,
+      Context<Glue> context) {
+    return context.getSecondaryResources(GenericKubernetesResource.class).stream()
+        .filter(
+            r -> name.equals(r.getMetadata().getAnnotations().get(DEPENDENT_NAME_ANNOTATION_KEY)))
+        .collect(Collectors.toMap(r -> r.getMetadata().getName(), r -> r));
+  }
+}
diff --git a/src/main/java/io/javaoperatorsdk/operator/glue/dependent/GenericDependentResource.java b/src/main/java/io/javaoperatorsdk/operator/glue/dependent/GenericDependentResource.java
@@ -20,14 +20,13 @@ public class GenericDependentResource
     Updater<GenericKubernetesResource, Glue>,
     Creator<GenericKubernetesResource, Glue> {
 
-  private final GenericKubernetesResource desired;
-  private final String desiredTemplate;
-  private final String name;
-  private final boolean clusterScoped;
-  private final Matcher matcher;
+  protected final GenericKubernetesResource desired;
+  protected final String desiredTemplate;
+  protected final String name;
+  protected final boolean clusterScoped;
+  protected final Matcher matcher;
 
-  // optimize share between instances
-  private final GenericTemplateHandler genericTemplateHandler;
+  protected final GenericTemplateHandler genericTemplateHandler;
 
   public GenericDependentResource(GenericTemplateHandler genericTemplateHandler,
       GenericKubernetesResource desired, String name,
diff --git a/src/main/java/io/javaoperatorsdk/operator/glue/reconciler/ValidationAndErrorHandler.java b/src/main/java/io/javaoperatorsdk/operator/glue/reconciler/ValidationAndErrorHandler.java
@@ -42,7 +42,20 @@ public class ValidationAndErrorHandler {
     }
   }
 
-  public void checkIfNamesAreUnique(GlueSpec glueSpec) {
+  public void checkIfValidGlueSpec(GlueSpec glueSpec) {
+    checkIfBulkProvidesResourceTemplate(glueSpec);
+    checkIfNamesAreUnique(glueSpec);
+  }
+
+  private void checkIfBulkProvidesResourceTemplate(GlueSpec glueSpec) {
+    glueSpec.getChildResources().forEach(r -> {
+      if (Boolean.TRUE.equals(r.getBulk()) && r.getResourceTemplate() == null) {
+        throw new GlueException("Bulk resource requires a template to be set");
+      }
+    });
+  }
+
+  void checkIfNamesAreUnique(GlueSpec glueSpec) {
     Set<String> seen = new HashSet<>();
     List<String> duplicates = new ArrayList<>();
 
diff --git a/src/main/java/io/javaoperatorsdk/operator/glue/reconciler/glue/GlueReconciler.java b/src/main/java/io/javaoperatorsdk/operator/glue/reconciler/glue/GlueReconciler.java
@@ -21,6 +21,7 @@
 import io.javaoperatorsdk.operator.glue.customresource.glue.condition.ConditionSpec;
 import io.javaoperatorsdk.operator.glue.customresource.glue.condition.JavaScriptConditionSpec;
 import io.javaoperatorsdk.operator.glue.customresource.glue.condition.ReadyConditionSpec;
+import io.javaoperatorsdk.operator.glue.dependent.GCGenericBulkDependentResource;
 import io.javaoperatorsdk.operator.glue.dependent.GCGenericDependentResource;
 import io.javaoperatorsdk.operator.glue.dependent.GenericDependentResource;
 import io.javaoperatorsdk.operator.glue.dependent.GenericResourceDiscriminator;
@@ -78,7 +79,7 @@ public UpdateControl<Glue> reconcile(Glue primary,
     log.debug("Reconciling glue. name: {} namespace: {}",
         primary.getMetadata().getName(), primary.getMetadata().getNamespace());
 
-    validationAndErrorHandler.checkIfNamesAreUnique(primary.getSpec());
+    validationAndErrorHandler.checkIfValidGlueSpec(primary.getSpec());
 
     registerRelatedResourceInformers(context, primary);
     if (deletedGlueIfParentMarkedForDeletion(context, primary)) {
@@ -209,9 +210,14 @@ private GenericDependentResource createDependentResource(DependentResourceSpec s
 
     if (leafDependent && resourceInSameNamespaceAsPrimary && !spec.isClusterScoped()) {
       return spec.getResourceTemplate() != null
-          ? new GCGenericDependentResource(genericTemplateHandler, spec.getResourceTemplate(),
-              spec.getName(),
-              spec.isClusterScoped(), spec.getMatcher())
+          ? spec.getBulk()
+              ? new GCGenericBulkDependentResource(genericTemplateHandler,
+                  spec.getResourceTemplate(),
+                  spec.getName(),
+                  spec.isClusterScoped(), spec.getMatcher())
+              : new GCGenericDependentResource(genericTemplateHandler, spec.getResourceTemplate(),
+                  spec.getName(),
+                  spec.isClusterScoped(), spec.getMatcher())
           : new GCGenericDependentResource(genericTemplateHandler, spec.getResource(),
               spec.getName(),
               spec.isClusterScoped(), spec.getMatcher());
diff --git a/src/main/java/io/javaoperatorsdk/operator/glue/reconciler/operator/GlueOperatorReconciler.java b/src/main/java/io/javaoperatorsdk/operator/glue/reconciler/operator/GlueOperatorReconciler.java
@@ -75,7 +75,7 @@ public UpdateControl<GlueOperator> reconcile(GlueOperator glueOperator,
     log.info("Reconciling GlueOperator {} in namespace: {}", glueOperator.getMetadata().getName(),
         glueOperator.getMetadata().getNamespace());
 
-    validationAndErrorHandler.checkIfNamesAreUnique(glueOperator.getSpec());
+    validationAndErrorHandler.checkIfValidGlueSpec(glueOperator.getSpec());
 
     var targetCREventSource = getOrRegisterCustomResourceEventSource(glueOperator, context);
     targetCREventSource.list().forEach(cr -> {

Original file line number	Diff line number	Diff line change
`@@ -138,9 +138,7 @@ public static String getKindFromTemplate(String resourceTemplate) {`
`138`	`138`	`public static Set<String> leafResourceNames(Glue glue) {`
`139`	`139`	`Set<String> result = new HashSet<>();`
`140`	`140`	`glue.getSpec().getChildResources().forEach(r -> result.add(r.getName()));`
`141`		`- glue.getSpec().getChildResources().forEach(r -> {`
`142`		`- r.getDependsOn().forEach(result::remove);`
`143`		`- });`
	`141`	`+ glue.getSpec().getChildResources().forEach(r -> r.getDependsOn().forEach(result::remove));`
`144`	`142`	`return result;`
`145`	`143`	`}`
`146`	`144`
`@@ -157,4 +155,10 @@ private static String getPropertyValueFromTemplate(String resourceTemplate, Stri`
`157`	`155`	`"Template does not contain property. " + resourceTemplate));`
`158`	`156`	`}`
`159`	`157`
	`158`	`+ public static GroupVersionKind getGVKFromTemplate(String resourceTemplate) {`
	`159`	`+ String apiVersion = getApiVersionFromTemplate(resourceTemplate);`
	`160`	`+ String kind = getKindFromTemplate(resourceTemplate);`
	`161`	`+ return new GroupVersionKind(apiVersion, kind);`
	`162`	`+ }`
	`163`	`+`
`160`	`164`	`}`