Merge pull request #159 from oracle/domain-pv-reclaim-policy-customization

Domain pv reclaim policy customization

Author: rjeberhard

kubernetes/create-weblogic-domain-inputs.yaml

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

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 "ERROR - Invalid value for weblogicDomainStorageReclaimPolicy ${weblogicDomainStorageReclaimPolicy} with weblogicDomainStoragePath ${weblogicDomainStoragePath} that 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
 #
@@ -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%

site/creating-domain.md

@@ -120,6 +120,7 @@ The following parameters must be provided in the input file:
 | t3PublicAddress | Public address for the t3 channel. | kubernetes |
 | weblogicCredentialsSecretName | Name of the Kubernetes secret for the Administration Server's username and password. | domain1-weblogic-credentials |
 | weblogicDomainStoragePath | Physical path of the storage for the domain. | no default |
+| weblogicDomainStorageReclaimPolicy | Kubernetes persistent volume reclaim policy for the domain persistent storage | Retain |
 | weblogicDomainStorageSize | Total storage allocated for the domain. | 10Gi |
 | weblogicDomainStorageType | Type of storage for the domain. Legal values are 'NFS' and 'HOST_PATH". | HOST_PATH |
 | weblogicDomainStorageNFSServer| The name of IP address of the NFS server for the domain's storage. | no default |

src/integration-tests/bash/cleanup.sh

@@ -51,6 +51,7 @@ OCOUNT=${#OPER_NAMESPACES[@]}
 SCRIPTPATH="$( cd "$(dirname "$0")" > /dev/null 2>&1 ; pwd -P )"
 PROJECT_ROOT="$SCRIPTPATH/../../.."
 RESULT_ROOT=${RESULT_ROOT:-/scratch/$USER/wl_k8s_test_results}
+PV_ROOT=${PV_ROOT:-$RESULT_ROOT}
 RESULT_DIR="$RESULT_ROOT/acceptance_test_tmp"
 USER_PROJECTS_DIR="$RESULT_DIR/user-projects"
 TMP_DIR="$RESULT_DIR/cleanup_tmp"

src/integration-tests/bash/run.sh

@@ -768,6 +768,11 @@ function run_create_domain_job {
       sed -i -e "s/^configuredManagedServerCount:.*/configuredManagedServerCount: 3/" $inputs
     fi
 
+    # we will test pv reclaim policy in domain6. We choose to do this way to void adding too many parameters in dom_define
+    if [ "$DOMAIN_UID" == "domain6" ] ; then
+      sed -i -e "s/^weblogicDomainStorageReclaimPolicy:.*/weblogicDomainStorageReclaimPolicy: Recycle/" $inputs
+    fi
+
     local outfile="${tmp_dir}/mkdir_physical_nfs.out"
     trace "Use a job to create the k8s host directory \"$PV_ROOT/acceptance_test_pv/$DOMAIN_STORAGE_DIR\" that we will use for the domain's persistent volume, see \"$outfile\" for job tracing."
 
@@ -2250,6 +2255,32 @@ function test_create_domain_startup_control_admin {
     declare_test_pass
 }
 
+
+function test_create_domain_pv_reclaim_policy_recycle {
+    declare_new_test 1 "$@"
+
+    if [ "$#" != 1 ] ; then
+      fail "requires 1 parameters: domainKey"
+    fi
+
+    local DOM_KEY=${1}
+    local DOMAIN_UID="`dom_get $1 DOMAIN_UID`"
+    local NAMESPACE="`dom_get $1 NAMESPACE`"
+
+    run_create_domain_job $DOMAIN_UID
+    verify_domain_created $DOMAIN_UID
+    shutdown_domain $DOM_KEY
+
+    kubectl delete pvc ${DOMAIN_UID}-weblogic-domain-pvc -n $NAMESPACE
+
+    local count=`kubectl get pv $DOMAIN_UID-weblogic-domain-pv -n $NAMESPACE |grep "^$DOMAIN_UID " | wc -l `
+    if [ ${count:=Error} != 0 ] ; then
+      fail "ERROR: pv for $DOMAIN_UID still exists after the pvc is deleted, exiting!"
+    fi
+
+    declare_test_pass
+}
+
 # scale domain $1 up and down, and optionally verify the scaling had no effect on domain $2
 function test_cluster_scale {
     declare_new_test 1 "$@"
@@ -2453,10 +2484,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 $RESULT_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"
@@ -2524,6 +2555,7 @@ function test_suite {
     dom_define domain3  oper1   test1     domain3    AUTO            cluster-1       managed-server 7021       30041           30703           8031    30307                  30317
     dom_define domain4  oper2   test2     domain4    AUTO            cluster-1       managed-server 7041       30051           30704           8041    30308                  30318
     dom_define domain5  oper1   default   domain5    ADMIN           cluster-1       managed-server 7051       30061           30705           8051    30309                  30319
+    dom_define domain6  oper1   default   domain6    AUTO            cluster-1       managed-server 7061       30071           30706           8061    30310                  30320
 
     # create namespaces for domains (the operator job creates a namespace if needed)
     # TODO have the op_define commands themselves create target namespace if it doesn't already exist, or test if the namespace creation is needed in the first place, and if so, ask MikeG to create them as part of domain create job
@@ -2588,9 +2620,12 @@ function test_suite {
       # cycle domain1 down and back up, plus verify no impact on domain4
       test_domain_lifecycle domain1 domain4 
 
-      # create another domain in the default namespace with startupControl="ADMIN", and verify that only admin server is created
+      # create domain5 in the default namespace with startupControl="ADMIN", and verify that only admin server is created
       test_create_domain_startup_control_admin domain5
 
+      # create domain6 in the default namespace with pvReclaimPolicy="Recycle", and verify that the PV is deleted once the domain and PVC are deleted
+      test_create_domain_pv_reclaim_policy_recycle domain6
+
       # test managed server 1 pod auto-restart
       test_wls_liveness_probe domain1
 

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";
@@ -246,6 +247,41 @@ public void createDomain_with_missingWeblogicDomainStoragePath_failsAndReturnsEr
       failsAndPrints(paramMissingError(PARAM_WEBLOGIC_DOMAIN_STORAGE_PATH)));
   }
 
+  @Test
+  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_weblogicDomainStorageReclaimPolicyDeleteAndNonTmpWeblogicDomainStoragePath_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_weblogicDomainStorageReclaimPolicyRecycle_succeeds() throws Exception {
+    GeneratedDomainYamlFiles
+      .generateDomainYamlFiles(
+        newInputs()
+          .weblogicDomainStorageReclaimPolicy(STORAGE_RECLAIM_POLICY_RECYCLE))
+      .remove();
+  }
+
+  @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_missingWeblogicDomainStorageSize_failsAndReturnsError() throws Exception {
     assertThat(
@@ -466,6 +502,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");
   }