Version the last of the artifacts, remove the old format annotations and use the version labels instead to determine when resources are obsolete

Author: moreaut

operator/src/main/java/oracle/kubernetes/operator/helpers/AnnotationHelper.java

@@ -3,28 +3,13 @@
 
 package oracle.kubernetes.operator.helpers;
 
-import java.util.Objects;
-
 import io.kubernetes.client.models.V1ObjectMeta;
 
 /**
  * Annotates pods, services with details about the Domain instance and checks these annotations.
  * 
  */
 public class AnnotationHelper {
-  // Make these public so that the tests can use them:
-  public static final String FORMAT_ANNOTATION = "weblogic.oracle/operator-formatVersion";
-  public static final String FORMAT_VERSION = "1";
-  
-  /**
-   * Marks metadata object with an annotation saying that it was created for this format version
-   * @param meta Metadata object that will be included in a newly created resource, e.g. pod or service
-   */
-  public static void annotateWithFormat(V1ObjectMeta meta) {
-    meta.putAnnotationsItem(FORMAT_ANNOTATION, FORMAT_VERSION);
-  }
-
-
   /**
    * Marks metadata with annotations that let Prometheus know how to retrieve metrics from
    * the wls-exporter web-app.  The specified httpPort should be the listen port of the WebLogic server
@@ -37,14 +22,4 @@ public static void annotateForPrometheus(V1ObjectMeta meta, int httpPort) {
      meta.putAnnotationsItem("prometheus.io/path", "/wls-exporter/metrics");
      meta.putAnnotationsItem("prometheus.io/scrape", "true");
   }
-
-  /**
-   * Check the metadata object for the presence of an annotation matching the expected format version.
-   * @param meta The metadata object
-   * @return true, if the metadata includes an annotation matching the expected format version
-   */
-  public static boolean checkFormatAnnotation(V1ObjectMeta meta) {
-    String metaResourceVersion = meta.getAnnotations().get(FORMAT_ANNOTATION);
-    return Objects.equals(FORMAT_VERSION, metaResourceVersion);
-  }
 }

operator/src/main/java/oracle/kubernetes/operator/helpers/ConfigMapHelper.java

@@ -99,7 +99,8 @@ public NextAction onSuccess(Packet packet, V1ConfigMap result, int statusCode,
               }
             });
             return doNext(create, packet);
-          } else if (AnnotationHelper.checkFormatAnnotation(result.getMetadata()) && result.getData().entrySet().containsAll(cm.getData().entrySet())) {
+          } else if (VersionHelper.matchesResourceVersion(result.getMetadata(), LabelConstants.RESOURCE_VERSION_LABEL) &&
+                     result.getData().entrySet().containsAll(cm.getData().entrySet())) {
             // existing config map has correct data
             LOGGER.fine(MessageKeys.CM_EXISTS, domainNamespace);
             packet.put(ProcessingConstants.SCRIPT_CONFIG_MAP, result);
@@ -142,9 +143,7 @@ protected V1ConfigMap computeDomainConfigMap() {
       V1ObjectMeta metadata = new V1ObjectMeta();
       metadata.setName(name);
       metadata.setNamespace(domainNamespace);
-      
-      AnnotationHelper.annotateWithFormat(metadata);
-      
+
       Map<String, String> labels = new HashMap<>();
       labels.put(LabelConstants.RESOURCE_VERSION_LABEL, VersionConstants.DOMAIN_V1);
       labels.put(LabelConstants.OPERATORNAME_LABEL, operatorNamespace);

operator/src/main/java/oracle/kubernetes/operator/helpers/IngressHelper.java

@@ -20,6 +20,7 @@
 import oracle.kubernetes.operator.KubernetesConstants;
 import oracle.kubernetes.operator.LabelConstants;
 import oracle.kubernetes.operator.ProcessingConstants;
+import oracle.kubernetes.operator.VersionConstants;
 import oracle.kubernetes.weblogic.domain.v1.Domain;
 import oracle.kubernetes.weblogic.domain.v1.DomainSpec;
 import oracle.kubernetes.operator.work.ContainerResolver;
@@ -78,9 +79,9 @@ public NextAction apply(Packet packet) {
         v1ObjectMeta.setNamespace(namespace);
 
         v1ObjectMeta.putAnnotationsItem(KubernetesConstants.CLASS_INGRESS, KubernetesConstants.CLASS_INGRESS_VALUE);
-        AnnotationHelper.annotateWithFormat(v1ObjectMeta);
 
         Map<String, String> labels = new HashMap<>();
+        labels.put(LabelConstants.RESOURCE_VERSION_LABEL, VersionConstants.DOMAIN_V1);
         labels.put(LabelConstants.DOMAINUID_LABEL, weblogicDomainUID);
         labels.put(LabelConstants.DOMAINNAME_LABEL, weblogicDomainName);
         labels.put(LabelConstants.CLUSTERNAME_LABEL, clusterName);
@@ -141,7 +142,7 @@ public NextAction onSuccess(Packet packet, V1beta1Ingress result, int statusCode
                         }
                       }), packet);
                 } else {
-                  if (AnnotationHelper.checkFormatAnnotation(result.getMetadata()) && v1beta1Ingress.getSpec().equals(result.getSpec())) {
+                  if (VersionHelper.matchesResourceVersion(result.getMetadata(), VersionConstants.DOMAIN_V1) && v1beta1Ingress.getSpec().equals(result.getSpec())) {
                     return doNext(packet);
                   }
                   return doNext(factory.create().replaceIngressAsync(ingressName, meta.getNamespace(),

operator/src/main/java/oracle/kubernetes/operator/helpers/PodHelper.java

@@ -184,8 +184,7 @@ protected V1Pod computeAdminPodConfig(TuningParameters configMapHelper, Packet p
       metadata.setName(podName);
       metadata.setNamespace(namespace);
       adminPod.setMetadata(metadata);
-      
-      AnnotationHelper.annotateWithFormat(metadata);
+
       AnnotationHelper.annotateForPrometheus(metadata, spec.getAsPort());
 
       Map<String, String> labels = new HashMap<>();
@@ -408,7 +407,7 @@ private static boolean validateCurrentPod(V1Pod build, V1Pod current) {
     // returns fields, such as nodeName, even when export=true is specified.
     // Therefore, we'll just compare specific fields
 
-    if (!AnnotationHelper.checkFormatAnnotation(current.getMetadata())) {
+    if (!VersionHelper.matchesResourceVersion(current.getMetadata(), LabelConstants.RESOURCE_VERSION_LABEL)) {
       return false;
     }
 
@@ -613,7 +612,6 @@ protected V1Pod computeManagedPodConfig(TuningParameters configMapHelper, Packet
       metadata.setNamespace(namespace);
       pod.setMetadata(metadata);
 
-      AnnotationHelper.annotateWithFormat(metadata);
       AnnotationHelper.annotateForPrometheus(metadata, scan.getListenPort());
 
       Map<String, String> labels = new HashMap<>();

operator/src/main/java/oracle/kubernetes/operator/helpers/ServiceHelper.java

@@ -7,6 +7,7 @@
 import io.kubernetes.client.models.*;
 import oracle.kubernetes.operator.LabelConstants;
 import oracle.kubernetes.operator.ProcessingConstants;
+import oracle.kubernetes.operator.VersionConstants;
 import oracle.kubernetes.weblogic.domain.v1.Domain;
 import oracle.kubernetes.weblogic.domain.v1.DomainSpec;
 import oracle.kubernetes.operator.helpers.HealthCheckHelper.KubernetesVersion;
@@ -72,10 +73,10 @@ public NextAction apply(Packet packet) {
       metadata.setName(name);
       metadata.setNamespace(namespace);
 
-      AnnotationHelper.annotateWithFormat(metadata);
       metadata.putAnnotationsItem("service.alpha.kubernetes.io/tolerate-unready-endpoints", "true");
 
       Map<String, String> labels = new HashMap<>();
+      labels.put(LabelConstants.RESOURCE_VERSION_LABEL, VersionConstants.DOMAIN_V1);
       labels.put(LabelConstants.DOMAINUID_LABEL, weblogicDomainUID);
       labels.put(LabelConstants.DOMAINNAME_LABEL, weblogicDomainName);
       labels.put(LabelConstants.SERVERNAME_LABEL, serverName);
@@ -252,9 +253,8 @@ public NextAction apply(Packet packet) {
       metadata.setName(name);
       metadata.setNamespace(namespace);
 
-      AnnotationHelper.annotateWithFormat(metadata);
-
       Map<String, String> labels = new HashMap<>();
+      labels.put(LabelConstants.RESOURCE_VERSION_LABEL, VersionConstants.DOMAIN_V1);
       labels.put(LabelConstants.DOMAINUID_LABEL, weblogicDomainUID);
       labels.put(LabelConstants.DOMAINNAME_LABEL, weblogicDomainName);
       labels.put(LabelConstants.CLUSTERNAME_LABEL, clusterName);
@@ -368,7 +368,7 @@ private static boolean validateCurrentService(V1Service build, V1Service current
     V1ServiceSpec buildSpec = build.getSpec();
     V1ServiceSpec currentSpec = current.getSpec();
 
-    if (!AnnotationHelper.checkFormatAnnotation(current.getMetadata())) {
+    if (!VersionHelper.matchesResourceVersion(current.getMetadata(), LabelConstants.RESOURCE_VERSION_LABEL)) {
       return false;
     }
 
@@ -520,10 +520,9 @@ public NextAction apply(Packet packet) {
       V1ObjectMeta metadata = new V1ObjectMeta();
       metadata.setName(name);
       metadata.setNamespace(namespace);
-      
-      AnnotationHelper.annotateWithFormat(metadata);
 
       Map<String, String> labels = new HashMap<>();
+      labels.put(LabelConstants.RESOURCE_VERSION_LABEL, VersionConstants.DOMAIN_V1);
       labels.put(LabelConstants.DOMAINUID_LABEL, weblogicDomainUID);
       labels.put(LabelConstants.DOMAINNAME_LABEL, weblogicDomainName);
       labels.put(LabelConstants.SERVERNAME_LABEL, serverName);

operator/src/main/java/oracle/kubernetes/operator/helpers/VersionHelper.java

@@ -0,0 +1,35 @@
+// Copyright 2017, 2018, Oracle Corporation and/or its affiliates.  All rights reserved.
+// Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
+
+package oracle.kubernetes.operator.helpers;
+
+import java.util.Map;
+
+import io.kubernetes.client.models.V1ObjectMeta;
+import oracle.kubernetes.operator.LabelConstants;
+
+/**
+ * Helper methods for managing versions.
+ * 
+ */
+public class VersionHelper {
+  /**
+   * Determines whether a resource matches a version
+   * @param meta Metadata
+   * @param resourceVersion resource version
+   */
+  public static boolean matchesResourceVersion(V1ObjectMeta meta, String resourceVersion) {
+    if (meta == null) {
+      return false;
+    }
+    Map<String,String> labels = meta.getLabels();
+    if (labels == null) {
+      return false;
+    }
+    String val = labels.get(LabelConstants.RESOURCE_VERSION_LABEL);
+    if (val == null) {
+      return false;
+    }
+    return val.equals(resourceVersion);
+  }
+}

operator/src/test/java/oracle/kubernetes/operator/create/ConfigMapHelperConfigTest.java

@@ -58,8 +58,7 @@ private V1ConfigMap getDesiredDomainConfigMap() {
           .namespace(DOMAIN_NAMESPACE)
           .putLabelsItem(RESOURCE_VERSION_LABEL, DOMAIN_V1)
           .putLabelsItem(OPERATORNAME_LABEL, OPERATOR_NAMESPACE)
-          .putLabelsItem(CREATEDBYOPERATOR_LABEL, "true")
-          .putAnnotationsItem(FORMAT_ANNOTATION, FORMAT_VERSION))
+          .putLabelsItem(CREATEDBYOPERATOR_LABEL, "true"))
         .putDataItem(PROPERTY_LIVENESS_PROBE_SH, "")
         .putDataItem(PROPERTY_READINESS_PROBE_SH, "")
         .putDataItem(PROPERTY_READ_STATE_SH, "")

operator/src/test/java/oracle/kubernetes/operator/create/PodHelperConfigTest.java

@@ -426,7 +426,6 @@ private V1Pod getDesiredBaseServerPodConfigForDefaults(String image, String imag
           .putAnnotationsItem("prometheus.io/path", "/wls-exporter/metrics")
           .putAnnotationsItem("prometheus.io/port", "" + port)
           .putAnnotationsItem("prometheus.io/scrape", "true")
-          .putAnnotationsItem("weblogic.oracle/operator-formatVersion", "1")
           .putLabelsItem(RESOURCE_VERSION_LABEL, DOMAIN_V1)
           .putLabelsItem(CREATEDBYOPERATOR_LABEL, "true")
           .putLabelsItem(DOMAINNAME_LABEL, DOMAIN_NAME)