skeleton of the update

Author: csviri

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

@@ -264,4 +264,10 @@ static ConfigurationService newOverriddenConfigurationService(
   default ExecutorServiceManager getExecutorServiceManager() {
     return new ExecutorServiceManager(this);
   }
+
+  // todo test transition
+  // todo configurable
+  default boolean useLegacyCreateUpdateAndMatchingOnDependentResources() {
+    return false;
+  }
 }

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

@@ -11,6 +11,8 @@
 import io.fabric8.kubernetes.api.model.Namespaced;
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.dsl.Resource;
+import io.fabric8.kubernetes.client.dsl.base.PatchContext;
+import io.fabric8.kubernetes.client.dsl.base.PatchType;
 import io.javaoperatorsdk.operator.OperatorException;
 import io.javaoperatorsdk.operator.api.config.dependent.Configured;
 import io.javaoperatorsdk.operator.api.config.informer.InformerConfiguration;
@@ -38,12 +40,17 @@ public abstract class KubernetesDependentResource<R extends HasMetadata, P exten
     DependentResourceConfigurator<KubernetesDependentResourceConfig<R>> {
 
   private static final Logger log = LoggerFactory.getLogger(KubernetesDependentResource.class);
+  private static final PatchContext SSA_PATCH_CONTEXT = new PatchContext.Builder()
+      .withPatchType(PatchType.SERVER_SIDE_APPLY)
+      .withForce(true)
+      .build();
 
   protected KubernetesClient client;
   private final ResourceUpdatePreProcessor<R> processor;
   private final boolean garbageCollected = this instanceof GarbageCollected;
   private KubernetesDependentResourceConfig<R> kubernetesDependentResourceConfig;
 
+
   @SuppressWarnings("unchecked")
   public KubernetesDependentResource(Class<R> resourceType) {
     super(resourceType);
@@ -128,16 +135,35 @@ protected R handleUpdate(R actual, R desired, P primary, Context<P> context) {
 
   @SuppressWarnings("unused")
   public R create(R target, P primary, Context<P> context) {
-    return prepare(target, primary, "Creating").create();
+    if (context.getControllerConfiguration().getConfigurationService()
+        .useLegacyCreateUpdateAndMatchingOnDependentResources()) {
+      return prepare(target, primary, "Creating").create();
+    } else {
+      return prepare(target, primary, "Creating").patch(SSA_PATCH_CONTEXT);
+    }
   }
 
   public R update(R actual, R target, P primary, Context<P> context) {
-    var updatedActual = processor.replaceSpecOnActual(actual, target, context);
-    return prepare(updatedActual, primary, "Updating").replace();
+    if (context.getControllerConfiguration().getConfigurationService()
+        .useLegacyCreateUpdateAndMatchingOnDependentResources()) {
+      var updatedActual = processor.replaceSpecOnActual(actual, target, context);
+      return prepare(updatedActual, primary, "Updating").replace();
+    } else {
+      return prepare(actual, primary, "Updating").patch(SSA_PATCH_CONTEXT);
+    }
   }
 
   public Result<R> match(R actualResource, P primary, Context<P> context) {
-    return GenericKubernetesResourceMatcher.match(this, actualResource, primary, context, false);
+    if (context.getControllerConfiguration().getConfigurationService()
+        .useLegacyCreateUpdateAndMatchingOnDependentResources()) {
+      return GenericKubernetesResourceMatcher.match(this, actualResource, primary, context, false);
+    } else {
+      final var desired = desired(primary, context);
+      addReferenceHandlingMetadata(desired, primary);
+      var matches = SSABasedGenericKubernetesResourceMatcher.getInstance().matches(actualResource,
+          desired, context);
+      return Result.computed(matches, desired);
+    }
   }
 
   @SuppressWarnings("unused")
@@ -164,11 +190,7 @@ protected Resource<R> prepare(R desired, P primary, String actionName) {
         desired.getClass(),
         ResourceID.fromResource(desired));
 
-    if (addOwnerReference()) {
-      desired.addOwnerReference(primary);
-    } else if (useDefaultAnnotationsToIdentifyPrimary()) {
-      addDefaultSecondaryToPrimaryMapperAnnotations(desired, primary);
-    }
+    addReferenceHandlingMetadata(desired, primary);
 
     if (desired instanceof Namespaced) {
       return client.resource(desired).inNamespace(desired.getMetadata().getNamespace());
@@ -177,6 +199,14 @@ protected Resource<R> prepare(R desired, P primary, String actionName) {
     }
   }
 
+  protected void addReferenceHandlingMetadata(R desired, P primary) {
+    if (addOwnerReference()) {
+      desired.addOwnerReference(primary);
+    } else if (useDefaultAnnotationsToIdentifyPrimary()) {
+      addDefaultSecondaryToPrimaryMapperAnnotations(desired, primary);
+    }
+  }
+
   @Override
   @SuppressWarnings("unchecked")
   protected InformerEventSource<R, P> createEventSource(EventSourceContext<P> context) {

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

@@ -10,20 +10,32 @@
 import io.fabric8.kubernetes.api.model.ManagedFieldsEntry;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 public class SSABasedGenericKubernetesResourceMatcher<R extends HasMetadata> {
 
+  @SuppressWarnings("rawtypes")
+  private static final SSABasedGenericKubernetesResourceMatcher INSTANCE =
+      new SSABasedGenericKubernetesResourceMatcher<>();
+
+  @SuppressWarnings("unchecked")
+  public static <L extends HasMetadata> SSABasedGenericKubernetesResourceMatcher<L> getInstance() {
+    return INSTANCE;
+  }
+
+  private static final TypeReference<HashMap<String, Object>> typeRef = new TypeReference<>() {};
+
   private static final String F_PREFIX = "f:";
   private static final String K_PREFIX = "k:";
-
-  public static final String METADATA_LABELS = "/metadata/labels";
-  public static final String METADATA_ANNOTATIONS = "/metadata/annotations";
+  public static final String METADATA_KEY = "metadata";
 
   private static final Logger log =
       LoggerFactory.getLogger(SSABasedGenericKubernetesResourceMatcher.class);
 
+  // todo list orders should be irrelevant, change lists to sets?
+  // todo owner reference removal?
   public boolean matches(R actual, R desired, Context<?> context) {
 
     var optionalManagedFieldsEntry =
@@ -33,20 +45,35 @@ public boolean matches(R actual, R desired, Context<?> context) {
     if (optionalManagedFieldsEntry.isEmpty()) {
       return false;
     }
+
     var managedFieldsEntry = optionalManagedFieldsEntry.orElseThrow();
 
     var objectMapper =
         context.getControllerConfiguration().getConfigurationService().getObjectMapper();
 
-    TypeReference<HashMap<String, Object>> typeRef = new TypeReference<>() {};
     var actualMap = objectMapper.convertValue(actual, typeRef);
     var desiredMap = objectMapper.convertValue(desired, typeRef);
 
     var prunedActual = new HashMap<String, Object>();
     pruneActualAccordingManagedFields(prunedActual, actualMap,
         managedFieldsEntry.getFieldsV1().getAdditionalProperties(), objectMapper);
+    removeIrrelevantValues(desiredMap);
+
+    log.trace("Pruned actual: \n {} \n desired: \n {} ", prunedActual, desiredMap);
+
+    return prunedActual.equals(desiredMap);
+  }
+
+  private void removeIrrelevantValues(HashMap<String, Object> desiredMap) {
+    var metadata = (Map<String, Object>) desiredMap.get(METADATA_KEY);
+    metadata.remove("name");
+    metadata.remove("namespace");
+    if (metadata.isEmpty()) {
+      desiredMap.remove(METADATA_KEY);
+    }
+    desiredMap.remove("kind");
+    desiredMap.remove("apiVersion");
 
-    return actualMap.equals(desiredMap);
   }
 
   private void pruneActualAccordingManagedFields(Map<String, Object> result,
@@ -71,9 +98,6 @@ private void pruneActualAccordingManagedFields(Map<String, Object> result,
               pruneActualAccordingManagedFields(emptyResMapValue, actualListEntry,
                   (Map<String, Object>) listEntry.getValue(), objectMapper);
             }
-
-            // todo handle lists
-            return;
           } else {
             var emptyMapValue = new HashMap<String, Object>();
             result.put(targetKey, emptyMapValue);
@@ -87,16 +111,36 @@ private void pruneActualAccordingManagedFields(Map<String, Object> result,
         } else {
           result.put(targetKey, actualMap.get(targetKey));
         }
+      } else {
+        if (!".".equals(key)) {
+          throw new IllegalStateException("Key: " + key + " has no prefix: " + F_PREFIX);
+        }
       }
     }
 
   }
 
-  private Map<String, Object> selectListEntryBasedOnKey(String key, List<Map<String, Object>> value,
+  private Map<String, Object> selectListEntryBasedOnKey(String key,
+      List<Map<String, Object>> values,
       ObjectMapper objectMapper) {
-    // objectMapper.
+    try {
+      Map<String, Object> ids = objectMapper.readValue(key, typeRef);
+      var possibleTargets =
+          values.stream().filter(v -> v.entrySet().containsAll(ids.entrySet()))
+              .collect(Collectors.toList());
+      if (possibleTargets.isEmpty()) {
+        throw new IllegalStateException(
+            "Cannot find list element for key:" + key + ", in map: " + values);
+      }
+      if (possibleTargets.size() > 1) {
+        throw new IllegalStateException(
+            "More targets found in list element for key:" + key + ", in map: " + values);
+      }
 
-    return null;
+      return possibleTargets.get(0);
+    } catch (JsonProcessingException e) {
+      throw new IllegalStateException(e);
+    }
   }