Add support for customizing PV reclaim policy

Signed-off-by: Dongbo Xiao <[email protected]>

Author: doxiao

kubernetes/create-weblogic-domain-inputs.yaml

@@ -46,6 +46,9 @@ weblogicDomainStorageType: HOST_PATH
 # The following line must be uncomment and customized:
 #weblogicDomainStoragePath: /scratch/k8s_dir/domain1
 
+# Reclaim policy of the domain's persistent storage
+weblogicDomainStorageReclaimPolicy: Retain
+
 # Total storage allocated to the domain's persistent storage.
 weblogicDomainStorageSize: 10Gi
 

kubernetes/create-weblogic-domain.sh

@@ -15,7 +15,7 @@
 #
 
 script="${BASH_SOURCE[0]}"
-scriptDir="$( cd "$( dirname "${script}" )" && pwd )"
+scriptDir="$( cd "$(dirname "${script}")" > /dev/null 2>&1 ; pwd -P)"
 internalDir="${scriptDir}/internal"
 
 # This is the script that the customers use to create a domain.

kubernetes/create-weblogic-operator.sh

@@ -3,7 +3,7 @@
 # Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
 
 script="${BASH_SOURCE[0]}"
-scriptDir="$( cd "$( dirname "${script}" )" && pwd )"
+scriptDir="$( cd "$(dirname "${script}")" > /dev/null 2>&1 ; pwd -P)"
 internalDir="${scriptDir}/internal"
 
 # This is the script that the customers use to create an operator.

kubernetes/internal/create-weblogic-domain.sh

@@ -124,6 +124,29 @@ function validateClusterName {
   clusterNameLC=$(toLower $clusterName)
 }
 
+#
+# Function to validate the weblogic domain storage reclaim policy
+#
+function validateWeblogicDomainStorageReclaimPolicy {
+  validateInputParamsSpecified weblogicDomainStorageReclaimPolicy
+  if [ ! -z "${weblogicDomainStorageReclaimPolicy}" ]; then
+    case ${weblogicDomainStorageReclaimPolicy} in
+      "Retain")
+      ;;
+      "Delete")
+        if [ "${weblogicDomainStoragePath:0:5}" != "/tmp/" ]; then
+          validationError "Invalid value for weblogicDomainStorageReclaimPolicy: ${weblogicDomainStorageReclaimPolicy} when weblogicDomainStoragePath is not /tmp/."
+        fi
+      ;;
+      "Recycle")
+      ;;
+      *)
+        validationError "Invalid value for weblogicDomainStorageReclaimPolicy: ${weblogicDomainStorageReclaimPolicy}. Valid values are Retain, Delete and Recycle."
+      ;;
+    esac
+  fi
+}
+
 #
 # Function to validate the weblogic domain storage type
 #
@@ -134,7 +157,7 @@ function validateWeblogicDomainStorageType {
       "HOST_PATH")
       ;;
       "NFS")
-        validateInputParamsSpecified weblogicDomainStorageNFSServer
+        validateInputParamsSpecified weblogicDomainStorageNFSServer        
       ;;
       *)
         validationError "Invalid value for weblogicDomainStorageType: ${weblogicDomainStorageType}. Valid values are HOST_PATH and NFS."
@@ -333,6 +356,7 @@ function initialize {
   validateNamespace
   validateClusterName
   validateWeblogicDomainStorageType
+  validateWeblogicDomainStorageReclaimPolicy
   validateWeblogicCredentialsSecretName
   validateWeblogicImagePullSecretName
   validateLoadBalancer
@@ -383,6 +407,7 @@ function createYamlFiles {
   sed -i -e "s:%DOMAIN_UID%:${domainUID}:g" ${domainPVOutput}
   sed -i -e "s:%NAMESPACE%:$namespace:g" ${domainPVOutput}
   sed -i -e "s:%WEBLOGIC_DOMAIN_STORAGE_PATH%:${weblogicDomainStoragePath}:g" ${domainPVOutput}
+  sed -i -e "s:%WEBLOGIC_DOMAIN_STORAGE_RECLAIM_POLICY%:${weblogicDomainStorageReclaimPolicy}:g" ${domainPVOutput}
   sed -i -e "s:%WEBLOGIC_DOMAIN_STORAGE_SIZE%:${weblogicDomainStorageSize}:g" ${domainPVOutput}
   sed -i -e "s:%HOST_PATH_PREFIX%:${hostPathPrefix}:g" ${domainPVOutput}
   sed -i -e "s:%NFS_PREFIX%:${nfsPrefix}:g" ${domainPVOutput}

kubernetes/internal/weblogic-domain-persistent-volume-template.yaml

@@ -13,7 +13,8 @@ spec:
     storage: %WEBLOGIC_DOMAIN_STORAGE_SIZE%
   accessModes:
     - ReadWriteMany
-  persistentVolumeReclaimPolicy: Retain
+  # Valid values are Retain, Delete or Recycle
+  persistentVolumeReclaimPolicy: %WEBLOGIC_DOMAIN_STORAGE_RECLAIM_POLICY%
   %HOST_PATH_PREFIX%hostPath:
   %NFS_PREFIX%nfs:
     %NFS_PREFIX%server: %WEBLOGIC_DOMAIN_STORAGE_NFS_SERVER%

src/integration-tests/bash/run.sh

@@ -383,7 +383,7 @@ function state_dump {
   # use a job to archive PV, /scratch mounts to PV_ROOT in the K8S cluster
   trace "Archiving pv directory using a kubernetes job.  Look for it on k8s cluster in $PV_ROOT/acceptance_test_pv_archive"
   local outfile=${DUMP_DIR}/archive_pv_job.out
-  $SCRIPTPATH/job.sh "/scripts/archive.sh /scratch/acceptance_test_pv /scratch/acceptance_test_pv_archive" > ${outfile} 2>&1
+  $SCRIPTPATH/job.sh "/scripts/archive.sh $PV_ROOT/acceptance_test_pv $PV_ROOT/acceptance_test_pv_archive" > ${outfile} 2>&1
   if [ "$?" = "0" ]; then
      trace Job complete.
   else
@@ -773,7 +773,7 @@ function run_create_domain_job {
 
     # Note that the job.sh job mounts PV_ROOT to /scratch and runs as UID 1000,
     # so PV_ROOT must already exist and have 777 or UID=1000 permissions.
-    $SCRIPTPATH/job.sh "mkdir -p /scratch/acceptance_test_pv/$DOMAIN_STORAGE_DIR" > ${outfile} 2>&1
+    $SCRIPTPATH/job.sh "mkdir -p $PV_ROOT/acceptance_test_pv/$DOMAIN_STORAGE_DIR" > ${outfile} 2>&1
     if [ "$?" = "0" ]; then
        cat ${outfile} | sed 's/^/+/g'
        trace Job complete.  Directory created on k8s cluster.
@@ -2453,10 +2453,10 @@ function test_suite_init {
       # 777 is needed because this script, k8s pods, and/or jobs may need access.
 
       /usr/local/packages/aime/ias/run_as_root "mkdir -p $RESULT_ROOT/acceptance_test_tmp"
-      /usr/local/packages/aime/ias/run_as_root "chmod 777 $PV_ROOT/acceptance_test_tmp"
+      /usr/local/packages/aime/ias/run_as_root "chmod 777 $RESULTPV_ROOT/acceptance_test_tmp"
 
       /usr/local/packages/aime/ias/run_as_root "mkdir -p $RESULT_ROOT/acceptance_test_tmp_archive"
-      /usr/local/packages/aime/ias/run_as_root "chmod 777 $PV_ROOT/acceptance_test_tmp_archive"
+      /usr/local/packages/aime/ias/run_as_root "chmod 777 $RESULT_ROOT/acceptance_test_tmp_archive"
 
       /usr/local/packages/aime/ias/run_as_root "mkdir -p $PV_ROOT/acceptance_test_pv"
       /usr/local/packages/aime/ias/run_as_root "chmod 777 $PV_ROOT/acceptance_test_pv"

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

@@ -29,6 +29,9 @@ public class CreateDomainInputs {
   public static final String LOAD_BALANCER_TRAEFIK = "TRAEFIK";
   public static final String STORAGE_TYPE_HOST_PATH = "HOST_PATH";
   public static final String STORAGE_TYPE_NFS = "NFS";
+  public static final String STORAGE_RECLAIM_POLICY_RETAIN = "Retain";
+  public static final String STORAGE_RECLAIM_POLICY_DELETE = "Delete";
+  public static final String STORAGE_RECLAIM_POLICY_RECYCLE = "Recycle";
   public static final String STARTUP_CONTROL_NONE = "NONE";
   public static final String STARTUP_CONTROL_ALL = "ALL";
   public static final String STARTUP_CONTROL_ADMIN = "ADMIN";
@@ -47,6 +50,7 @@ public class CreateDomainInputs {
   private String initialManagedServerReplicas = "";
   private String managedServerNameBase = "";
   private String managedServerPort = "";
+  private String weblogicDomainStorageReclaimPolicy = "";
   private String weblogicDomainStorageNFSServer = "";
   private String weblogicDomainStoragePath = "";
   private String weblogicDomainStorageSize = "";
@@ -286,6 +290,19 @@ public CreateDomainInputs weblogicDomainStorageSize(String weblogicDomainStorage
     return this;
   }
 
+  public String getWeblogicDomainStorageReclaimPolicy() {
+    return weblogicDomainStorageReclaimPolicy;
+  }
+
+  public void setWeblogicDomainStorageReclaimPolicy(String weblogicDomainStorageReclaimPolicy) {
+    this.weblogicDomainStorageReclaimPolicy = convertNullToEmptyString(weblogicDomainStorageReclaimPolicy);
+  }
+
+  public CreateDomainInputs weblogicDomainStorageReclaimPolicy(String weblogicDomainStorageReclaimPolicy) {
+    setWeblogicDomainStorageReclaimPolicy(weblogicDomainStorageReclaimPolicy);
+    return this;
+  }
+
   public String getWeblogicDomainStorageType() {
     return weblogicDomainStorageType;
   }

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

@@ -61,6 +61,7 @@ public void defaultInputsFile_hasCorrectContents() throws Exception {
         .namespace("default")
         .weblogicDomainStorageNFSServer("")
         .weblogicDomainStoragePath("")
+        .weblogicDomainStorageReclaimPolicy(STORAGE_RECLAIM_POLICY_RETAIN)
         .weblogicDomainStorageSize("10Gi")
         .weblogicDomainStorageType(STORAGE_TYPE_HOST_PATH)
         .productionModeEnabled("true")

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

@@ -28,6 +28,7 @@ public class CreateDomainInputsValidationTest {
   private static final String PARAM_INITIAL_MANAGED_SERVER_REPLICAS = "initialManagedServerReplicas";
   private static final String PARAM_MANAGED_SERVER_NAME_BASE = "managedServerNameBase";
   private static final String PARAM_MANAGED_SERVER_PORT = "managedServerPort";
+  private static final String PARAM_WEBLOGIC_DOMAIN_STORAGE_RECLAIM_POLICY = "weblogicDomainStorageReclaimPolicy";
   private static final String PARAM_WEBLOGIC_DOMAIN_STORAGE_NFS_SERVER = "weblogicDomainStorageNFSServer";
   private static final String PARAM_WEBLOGIC_DOMAIN_STORAGE_PATH = "weblogicDomainStoragePath";
   private static final String PARAM_WEBLOGIC_DOMAIN_STORAGE_SIZE = "weblogicDomainStorageSize";
@@ -215,11 +216,37 @@ public void createDomain_with_invalidManagedServerPort_failsAndReturnsError() th
   }
 
   @Test
-  public void createDomain_with_weblogicDomainStorageTypeNfsAndMissingWeblogicDomainStorageNFSServer_failsAndReturnsError() throws Exception {
+  public void createDomain_with_invalidWeblogicDomainStorageReclaimPolicy_failsAndReturnsError() throws Exception {
+    String val = "invalid-storage-reclaim-policy";
+    assertThat(
+      execCreateDomain(newInputs().weblogicDomainStorageReclaimPolicy(val)),
+      failsAndPrints(invalidEnumParamValueError(PARAM_WEBLOGIC_DOMAIN_STORAGE_RECLAIM_POLICY, val)));
+  }
+
+  @Test
+  public void createDomain_with_weblogicDomainStorageReclaimPolicyDeleteAndNonTmoWeblogicDomainStoragePath_failsAndReturnsError() throws Exception {
     assertThat(
+      execCreateDomain(newInputs().weblogicDomainStorageReclaimPolicy(STORAGE_RECLAIM_POLICY_DELETE).weblogicDomainStoragePath("/scratch")),
+      failsAndPrints(invalidRelatedParamValueError(PARAM_WEBLOGIC_DOMAIN_STORAGE_RECLAIM_POLICY, STORAGE_RECLAIM_POLICY_DELETE, 
+                                              PARAM_WEBLOGIC_DOMAIN_STORAGE_PATH, "/scratch")));
+  }
+
+  @Test
+  public void createDomain_with_weblogicDomainStorageReclaimPolicyDelete_and_tmpWeblogicDomainStoragePath_succeeds() throws Exception {
+    GeneratedDomainYamlFiles
+      .generateDomainYamlFiles(
+        newInputs()
+          .weblogicDomainStorageReclaimPolicy(STORAGE_RECLAIM_POLICY_DELETE)
+          .weblogicDomainStoragePath("/tmp/"))
+      .remove();
+  }
+
+  @Test
+  public void createDomain_with_weblogicDomainStorageTypeNfsAndMissingWeblogicDomainStorageNFSServer_failsAndReturnsError() throws Exception {
+     assertThat(
       execCreateDomain(newInputs().weblogicDomainStorageType(STORAGE_TYPE_NFS).weblogicDomainStorageNFSServer("")),
       failsAndPrints(paramMissingError(PARAM_WEBLOGIC_DOMAIN_STORAGE_NFS_SERVER)));
-  }
+   }
 
   @Test
   public void createDomain_with_invalidWeblogicDomainStorageType_failsAndReturnsError() throws Exception {
@@ -466,6 +493,10 @@ private String invalidEnumParamValueError(String param, String val) {
     return errorRegexp("Invalid.*" + param + ".*" + val);
   }
 
+  private String invalidRelatedParamValueError(String param, String val, String param2, String val2) {
+    return errorRegexp("Invalid.*" + param + ".*" + val + " with " + param2 + ".*" + val2);
+  }
+
   private String paramMissingError(String param) {
     return errorRegexp(param + ".*missing");
   }

src/test/scripts/unit-test-create-weblogic-domain.sh

@@ -8,7 +8,7 @@
 # create domain script that generates the yaml files.
 
 script="${BASH_SOURCE[0]}"
-scriptDir="$( cd "$( dirname "${script}" )" && pwd )"
+scriptDir="$( cd "$(dirname "${script}")" > /dev/null 2>&1 ; pwd -P)"
 kubernetesDir="${scriptDir}/../../../kubernetes"
 internalDir="${kubernetesDir}/internal"