Owls 104212 - Changes to shorten the generated volume names and container names for converted aux images (#3669)

* Changes to truncate the generated volume name for the converted v8 auxiliary images when the name is longer than 63 characters.

Author: ankedia

common/src/main/java/oracle/kubernetes/common/AuxiliaryImageConstants.java

@@ -10,7 +10,7 @@ private AuxiliaryImageConstants() {
   }
 
   public static final String AUXILIARY_IMAGE_TARGET_PATH = "/tmpAuxiliaryImage";
-  public static final String AUXILIARY_IMAGE_VOLUME_NAME_PREFIX = "aux-image-volume-";
+  public static final String AUXILIARY_IMAGE_VOLUME_NAME_PREFIX = "ai-vol-";
   public static final String AUXILIARY_IMAGE_INIT_CONTAINER_WRAPPER_SCRIPT = "/weblogic-operator/scripts/auxImage.sh";
   public static final String AUXILIARY_IMAGE_INIT_CONTAINER_NAME_PREFIX = "operator-aux-container";
   public static final String AUXILIARY_IMAGE_DEFAULT_INIT_CONTAINER_COMMAND

common/src/main/java/oracle/kubernetes/common/CommonConstants.java

@@ -9,7 +9,7 @@ private CommonConstants() {
     //not called
   }
 
-  public static final String COMPATIBILITY_MODE = "compatibility-mode-";
+  public static final String COMPATIBILITY_MODE = "compat-";
   public static final String API_VERSION_V9 = "weblogic.oracle/v9";
   public static final String API_VERSION_V8 = "weblogic.oracle/v8";
 

common/src/main/java/oracle/kubernetes/common/utils/CommonUtils.java

@@ -3,10 +3,20 @@
 
 package oracle.kubernetes.common.utils;
 
+import java.nio.charset.StandardCharsets;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
+import java.util.Optional;
+
 import oracle.kubernetes.common.CommonConstants;
 
 public class CommonUtils {
 
+  private static CheckedFunction<String, String> getMD5Hash = CommonUtils::getMD5Hash;
+
+  public static final int MAX_ALLOWED_VOLUME_NAME_LENGTH = 63;
+  public static final String VOLUME_NAME_SUFFIX = "-volume";
+
   private CommonUtils() {
     //not called
   }
@@ -33,4 +43,45 @@ public static String toDns1123LegalName(String value) {
     return value.toLowerCase().replace('_', '-');
   }
 
+  /**
+   * Returns a truncated volume name if the name exceeds the max allowed limit of characters for volume name.
+   * @param volumeName volume name
+   * @return truncated volume name if the name exceeds the limit, else return volumeName
+   * @throws NoSuchAlgorithmException Thrown when particular cryptographic algorithm
+   *                                  is not available in the environment.
+   */
+  public static String getLegalVolumeName(String volumeName) throws NoSuchAlgorithmException {
+    return volumeName.length() > (MAX_ALLOWED_VOLUME_NAME_LENGTH)
+        ? getShortName(volumeName)
+        : volumeName;
+  }
+
+
+  private static String getShortName(String resourceName) throws NoSuchAlgorithmException {
+    String volumeSuffix = Optional.ofNullable(getMD5Hash.apply(resourceName)).orElse("");
+    return resourceName.substring(0, MAX_ALLOWED_VOLUME_NAME_LENGTH - volumeSuffix.length()) + volumeSuffix;
+  }
+
+  /**
+   * Gets the MD5 hash of a string.
+   *
+   * @param data input string
+   * @return MD5 hash value of the data, null in case of an exception.
+   */
+  public static String getMD5Hash(String data) throws NoSuchAlgorithmException {
+    return bytesToHex(MessageDigest.getInstance("MD5").digest(data.getBytes(StandardCharsets.UTF_8)));
+  }
+
+  private static String bytesToHex(byte[] hash) {
+    StringBuilder result = new StringBuilder();
+    for (byte b : hash) {
+      result.append(String.format("%02x", b));
+    }
+    return result.toString();
+  }
+
+  @FunctionalInterface
+  public interface CheckedFunction<T, R> {
+    R apply(T t) throws NoSuchAlgorithmException;
+  }
 }

common/src/main/java/oracle/kubernetes/common/utils/SchemaConversionUtils.java

@@ -59,6 +59,7 @@ public class SchemaConversionUtils {
   private static final String DOLLAR_SPEC_AS_SERVERPOD = "$.spec.adminServer.serverPod";
 
   public static final String INTERNAL = "Internal";
+
   /**
    * The list of failure reason strings. Hard-coded here to match the values in DomainFailureReason.
    * Validated in tests in the operator.
@@ -683,7 +684,15 @@ private boolean hasMatchingVolumeMountName(Object volumeMount, Map<String, Objec
     return getDNS1123auxiliaryImageVolumeName(auxiliaryImage.get(VOLUME)).equals(((Map)volumeMount).get("name"));
   }
 
-  public static String getDNS1123auxiliaryImageVolumeName(Object name) {
+  private static String getDNS1123auxiliaryImageVolumeName(Object name) {
+    try {
+      return CommonUtils.getLegalVolumeName(getVolumeName(name));
+    } catch (Exception ex) {
+      return getVolumeName(name);
+    }
+  }
+
+  private static String getVolumeName(Object name) {
     return CommonUtils.toDns1123LegalName(CommonConstants.COMPATIBILITY_MODE
         + AuxiliaryImageConstants.AUXILIARY_IMAGE_VOLUME_NAME_PREFIX + name);
   }

common/src/test/java/oracle/kubernetes/common/utils/SchemaConversionUtilsTest.java

@@ -5,6 +5,7 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.security.NoSuchAlgorithmException;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
@@ -15,6 +16,8 @@
 import java.util.Optional;
 
 import com.meterware.simplestub.Memento;
+import com.meterware.simplestub.StaticStubSupport;
+import oracle.kubernetes.common.CommonConstants;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -24,6 +27,7 @@
 
 import static com.jayway.jsonpath.matchers.JsonPathMatchers.hasJsonPath;
 import static com.jayway.jsonpath.matchers.JsonPathMatchers.hasNoJsonPath;
+import static oracle.kubernetes.common.AuxiliaryImageConstants.AUXILIARY_IMAGE_VOLUME_NAME_PREFIX;
 import static oracle.kubernetes.common.CommonConstants.API_VERSION_V8;
 import static oracle.kubernetes.common.CommonConstants.API_VERSION_V9;
 import static org.hamcrest.Matchers.contains;
@@ -47,11 +51,16 @@ class SchemaConversionUtilsTest {
   private final ConversionAdapter converterv8 = new ConversionAdapter(API_VERSION_V8);
   private Map<String, Object> v8Domain;
 
+  private static CommonUtils.CheckedFunction<String, String> getMD5Hash = SchemaConversionUtilsTest::getMD5Hash;
+
+  private static String getMD5Hash(String s) throws NoSuchAlgorithmException {
+    throw new NoSuchAlgorithmException();
+  }
+
   @BeforeEach
   public void setUp() throws Exception {
     mementos.add(CommonTestUtils.silenceLogger());
     mementos.add(BaseTestUtils.silenceJsonPathLogger());
-    
     v8Domain = readAsYaml(DOMAIN_V8_AUX_IMAGE30_YAML);
   }
 
@@ -606,4 +615,35 @@ void testV8DomainWebLogicCredentialsSecretWithNamespace_remove() {
 
     assertThat(converter.getDomain(), hasNoJsonPath("$.spec.webLogicCredentialsSecret.namespace"));
   }
+
+  @Test
+  void testV8DomainWithLongAuxiliaryImageVolumeName_convertedVolumeNameIsTruncated() throws NoSuchAlgorithmException {
+    Map<String, Object> auxImageVolume = ((Map<String, Object>)
+        ((List<Object>) getDomainSpec(v8Domain).get("auxiliaryImageVolumes")).get(0));
+    auxImageVolume.put("name", "test-domain-aux-image-volume-test-domain-aux-image-volume");
+    getDomainSpec(v8Domain).put("auxiliaryImageVolumes",  Collections.singletonList(auxImageVolume));
+
+    converter.convert(v8Domain);
+
+    assertThat(converter.getDomain(), hasJsonPath("$.spec.serverPod.volumes[0].name",
+        equalTo(CommonUtils.getLegalVolumeName(CommonUtils.toDns1123LegalName(CommonConstants.COMPATIBILITY_MODE
+            + AUXILIARY_IMAGE_VOLUME_NAME_PREFIX + (String)auxImageVolume.get("name"))))));
+  }
+
+  @Test
+  void testV8DomainWithLongAuxiliaryImageVolumeNameAndMessageDigestThrowsException_volumeNameIsNotChanged()
+      throws NoSuchFieldException {
+    mementos.add(StaticStubSupport.install(CommonUtils.class, "getMD5Hash", getMD5Hash));
+
+    Map<String, Object> auxImageVolume = ((Map<String, Object>)
+        ((List<Object>) getDomainSpec(v8Domain).get("auxiliaryImageVolumes")).get(0));
+    auxImageVolume.put("name", "test-domain-aux-image-volume-test-domain-aux-image-volume");
+    getDomainSpec(v8Domain).put("auxiliaryImageVolumes",  Collections.singletonList(auxImageVolume));
+
+    converter.convert(v8Domain);
+
+    assertThat(converter.getDomain(), hasJsonPath("$.spec.serverPod.volumes[0].name",
+        equalTo(CommonUtils.toDns1123LegalName(CommonConstants.COMPATIBILITY_MODE
+            + AUXILIARY_IMAGE_VOLUME_NAME_PREFIX + "test-domain-aux-image-volume-test-domain-aux-image-volume"))));
+  }
 }

common/src/test/resources/oracle/kubernetes/common/utils/converted-domain-sample-2.yaml

@@ -34,11 +34,11 @@ spec:
   adminServer:
     serverPod:
       volumes:
-      - name: compatibility-mode-aux-image-volume-auxiliaryimagevolume1
+      - name: compat-ai-vol-auxiliaryimagevolume1
         emptyDir: {
           }
       initContainers:
-      - name: compatibility-mode-operator-aux-container1
+      - name: compat-operator-aux-container1
         image: model-in-image:WLS-AI-v1
         command:
         - /weblogic-operator/scripts/auxImage.sh
@@ -53,14 +53,14 @@ spec:
         - name: AUXILIARY_IMAGE_CONTAINER_IMAGE
           value: model-in-image:WLS-AI-v1
         - name: AUXILIARY_IMAGE_CONTAINER_NAME
-          value: compatibility-mode-operator-aux-container1
+          value: compat-operator-aux-container1
         volumeMounts:
-        - name: compatibility-mode-aux-image-volume-auxiliaryimagevolume1
+        - name: compat-ai-vol-auxiliaryimagevolume1
           mountPath: /tmpAuxiliaryImage
         - name: weblogic-scripts-cm-volume
           mountPath: /weblogic-operator/scripts
       volumeMounts:
-      - name: compatibility-mode-aux-image-volume-auxiliaryimagevolume1
+      - name: compat-ai-vol-auxiliaryimagevolume1
         mountPath: /auxiliary
       env:
       - name: AUXILIARY_IMAGE_PATHS

common/src/test/resources/oracle/kubernetes/common/utils/converted-domain-sample.yaml

@@ -34,11 +34,11 @@ spec:
         cpu: 250m
         memory: 768Mi
     volumes:
-    - name: compatibility-mode-aux-image-volume-auxiliaryimagevolume1
+    - name: compat-ai-vol-auxiliaryimagevolume1
       emptyDir: {
         }
     initContainers:
-    - name: compatibility-mode-operator-aux-container1
+    - name: compat-operator-aux-container1
       image: model-in-image:WLS-AI-v1
       command:
       - /weblogic-operator/scripts/auxImage.sh
@@ -53,14 +53,14 @@ spec:
       - name: AUXILIARY_IMAGE_CONTAINER_IMAGE
         value: model-in-image:WLS-AI-v1
       - name: AUXILIARY_IMAGE_CONTAINER_NAME
-        value: compatibility-mode-operator-aux-container1
+        value: compat-operator-aux-container1
       volumeMounts:
-      - name: compatibility-mode-aux-image-volume-auxiliaryimagevolume1
+      - name: compat-ai-vol-auxiliaryimagevolume1
         mountPath: /tmpAuxiliaryImage
       - name: weblogic-scripts-cm-volume
         mountPath: /weblogic-operator/scripts
     volumeMounts:
-    - name: compatibility-mode-aux-image-volume-auxiliaryimagevolume1
+    - name: compat-ai-vol-auxiliaryimagevolume1
       mountPath: /auxiliary
   adminServer:
     adminChannelPortForwardingEnabled: false

documentation/4.0/content/managing-domains/model-in-image/auxiliary-images.md

@@ -198,21 +198,21 @@ spec:
       - name: AUXILIARY_IMAGE_CONTAINER_IMAGE
         value: model-in-image:WLS-AI-v1
       - name: AUXILIARY_IMAGE_CONTAINER_NAME
-        value: compatibility-mode-operator-aux-container1
+        value: compat-operator-aux-container1
       image: model-in-image:WLS-AI-v1
       imagePullPolicy: IfNotPresent
-      name: compatibility-mode-operator-aux-container1
+      name: compat-operator-aux-container1
       volumeMounts:
       - mountPath: /tmpAuxiliaryImage
-        name: compatibility-mode-aux-image-volume-auxiliaryimagevolume1
+        name: compat-ai-vol-auxiliaryimagevolume1
       - mountPath: /weblogic-operator/scripts
         name: weblogic-scripts-cm-volume
     volumeMounts:
     - mountPath: /auxiliary
-      name: compatibility-mode-aux-image-volume-auxiliaryimagevolume1
+      name: compat-ai-vol-auxiliaryimagevolume1
     volumes:
     - emptyDir: {}
-      name: compatibility-mode-aux-image-volume-auxiliaryimagevolume1
+      name: compat-ai-vol-auxiliaryimagevolume1
 ```
 
 ### Domain upgrade tool to manually upgrade the `weblogic.oracle/v8` schema domain resource

integration-tests/src/test/java/oracle/weblogic/kubernetes/ItAuxV8DomainImplicitUpgrade.java

@@ -277,7 +277,7 @@ void testMultipleAuxImagesV8Domain() {
     assertNotNull(containerList, "/spec/serverPod/InitContainers is null");
     containerList.forEach(container -> {
       logger.info("The Init Container name is: {0} ", container.getName());
-      if (container.getName().equalsIgnoreCase("compatibility-mode-operator-aux-container1")) {
+      if (container.getName().equalsIgnoreCase("compat-operator-aux-container1")) {
         logger.info("The Compatiblity Init Container found");
         foundCompatiblityContainer = true;
       }

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

@@ -4,6 +4,7 @@
 package oracle.kubernetes.operator.helpers;
 
 import java.io.File;
+import java.security.NoSuchAlgorithmException;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
@@ -27,6 +28,7 @@
 import io.kubernetes.client.openapi.models.V1VolumeMount;
 import oracle.kubernetes.common.helpers.AuxiliaryImageEnvVars;
 import oracle.kubernetes.common.logging.MessageKeys;
+import oracle.kubernetes.common.utils.CommonUtils;
 import oracle.kubernetes.operator.DomainSourceType;
 import oracle.kubernetes.operator.IntrospectorConfigMapConstants;
 import oracle.kubernetes.operator.KubernetesConstants;
@@ -40,7 +42,6 @@
 import oracle.kubernetes.operator.logging.LoggingFactory;
 import oracle.kubernetes.operator.processing.EffectiveServerSpec;
 import oracle.kubernetes.operator.tuning.TuningParameters;
-import oracle.kubernetes.operator.utils.ChecksumUtils;
 import oracle.kubernetes.operator.wlsconfig.WlsDomainConfig;
 import oracle.kubernetes.operator.work.NextAction;
 import oracle.kubernetes.operator.work.Packet;
@@ -54,6 +55,8 @@
 import static oracle.kubernetes.common.CommonConstants.COMPATIBILITY_MODE;
 import static oracle.kubernetes.common.CommonConstants.SCRIPTS_MOUNTS_PATH;
 import static oracle.kubernetes.common.CommonConstants.SCRIPTS_VOLUME;
+import static oracle.kubernetes.common.utils.CommonUtils.MAX_ALLOWED_VOLUME_NAME_LENGTH;
+import static oracle.kubernetes.common.utils.CommonUtils.VOLUME_NAME_SUFFIX;
 import static oracle.kubernetes.operator.DomainStatusUpdater.createKubernetesFailureSteps;
 import static oracle.kubernetes.operator.helpers.AffinityHelper.getDefaultAntiAffinity;
 import static oracle.kubernetes.utils.OperatorUtils.emptyToNull;
@@ -72,12 +75,11 @@ public class JobStepContext extends BasePodStepContext {
   private static final LoggingFacade LOGGER = LoggingFactory.getLogger("Operator", "Operator");
   private static final String WEBLOGIC_OPERATOR_SCRIPTS_INTROSPECT_DOMAIN_SH =
         "/weblogic-operator/scripts/introspectDomain.sh";
-  private static final int MAX_ALLOWED_VOLUME_NAME_LENGTH = 63;
-  private static final String VOLUME_NAME_SUFFIX = "-volume";
   private static final String CONFIGMAP_TYPE = "cm";
   private static final String SECRET_TYPE = "st";
   // domainTopology is null if this is 1st time we're running job for this domain
   private final WlsDomainConfig domainTopology;
+  private static CommonUtils.CheckedFunction<String, String> getMD5Hash = CommonUtils::getMD5Hash;
   private V1Job jobModel;
   private Step conflictStep;
 
@@ -508,18 +510,23 @@ protected V1Container createPrimaryContainer() {
   }
 
   private String getVolumeName(String resourceName, String type) {
-    return getName(resourceName, type);
+    try {
+      return getLegalVolumeName(resourceName, type);
+    } catch (Exception ex) {
+      LOGGER.severe(MessageKeys.EXCEPTION, ex);
+      return resourceName;
+    }
   }
 
-  private String getName(String resourceName, String type) {
-    return resourceName.length() > (MAX_ALLOWED_VOLUME_NAME_LENGTH - VOLUME_NAME_SUFFIX.length())
-            ? getShortName(resourceName, type)
-            : resourceName + VOLUME_NAME_SUFFIX;
+  private String getLegalVolumeName(String volumeName, String type) throws NoSuchAlgorithmException {
+    return volumeName.length() > (MAX_ALLOWED_VOLUME_NAME_LENGTH - VOLUME_NAME_SUFFIX.length())
+        ? getShortName(volumeName, type)
+        : volumeName + VOLUME_NAME_SUFFIX;
   }
 
-  private String getShortName(String resourceName, String type) {
+  private String getShortName(String resourceName, String type) throws NoSuchAlgorithmException {
     String volumeSuffix = VOLUME_NAME_SUFFIX + "-" + type + "-"
-            + Optional.ofNullable(ChecksumUtils.getMD5Hash(resourceName)).orElse("");
+        + Optional.ofNullable(getMD5Hash.apply(resourceName)).orElse("");
     return resourceName.substring(0, MAX_ALLOWED_VOLUME_NAME_LENGTH - volumeSuffix.length()) + volumeSuffix;
   }