Remove the domain pv, pvc & storage class inputs and switch to hard coded vals based on the domain uid, get rid of the default domain uid, weblogic domain storage path and weblogic domain nfs server

Author: moreaut

kubernetes/create-weblogic-domain-inputs.yaml

@@ -11,8 +11,10 @@ adminServerName: admin-server
 domainName: base_domain
 
 # Unique id identifying a domain.
-# This id must be lowercase and unique across all domains in a Kubernetes cluster
-domainUID: domain1
+# This id must be lowercase and unique across all domains in a Kubernetes cluster.
+# Best practice is to use a globally unique name.
+# The following line must be uncomment and customized:
+#domainUID: domain1.development-stage.yourcompany.com
 
 # Determines which WebLogic Servers the Operator will start up
 # Legal values are "NONE", "ALL", "ADMIN", "SPECIFIED", or "AUTO"
@@ -38,32 +40,17 @@ managedServerPort: 8001
 # If using 'NFS', weblogicDomainStorageNFSServer must be specified.
 weblogicDomainStorageType: HOST_PATH
 
-# The server name or ip address of the NFS server to use
-# for the domain's storage.
-# Only used if persistenceType is nfs.
-weblogicDomainStorageNFSServer: nfsServer
+# The server name or ip address of the NFS server to use for the domain's storage.
+# The following line must be uncomment and customized if weblogicDomainStorateType is NFS:
+#weblogicDomainStorageNFSServer: nfsServer
 
 # Physical path of the domain's persistent storage.
-weblogicDomainStoragePath: /scratch/k8s_dir/persistentVolume001
+# The following line must be uncomment and customized:
+#weblogicDomainStoragePath: /scratch/k8s_dir/domain1
 
 # Total storage allocated to the domain's persistent storage.
 weblogicDomainStorageSize: 10Gi
 
-# Name of the storage class to set for the persistent volume and persistent volume claim
-# The default value that will be used is the value of the domainUid input parameter
-# The name of the storage class must be in lowercase
-#persistenceStorageClass:
-
-# Name of the Kubernetes persistent volume claim for this domain.  Name must be lowercase.
-# The persistent volume claim name will be prepended with '${domainUid}-' by create-domain-job.sh
-# if it is not already
-persistenceVolumeClaimName: pv001-claim
-
-# Name of the Kubernetes persistent volume for this domain.  Name must be lowercase.
-# The persistent volume name will be prepended with '${domainUid}-' by create-domain-job.sh
-# if it is not already
-persistenceVolumeName: pv001
-
 # Boolean indicating if production mode is enabled for the domain
 productionModeEnabled: true
 

kubernetes/internal/create-weblogic-domain-job-template.yaml

@@ -491,7 +491,7 @@ spec:
             name: domain-%DOMAIN_UID%-scripts
         - name: pv-storage
           persistentVolumeClaim:
-            claimName: %PERSISTENT_VOLUME_CLAIM%
+            claimName: %DOMAIN_UID%-weblogic-domain-pvc
         - name: secrets
           secret:
             secretName: %WEBLOGIC_CREDENTIALS_SECRET_NAME%

kubernetes/internal/create-weblogic-domain.sh

@@ -124,49 +124,6 @@ function validateClusterName {
   clusterNameLC=$(toLower $clusterName)
 }
 
-#
-# Function to default the value of persistenceStorageClass.
-# When the parameter is not specified in the input file, it will default to use the value domainUID
-#
-function validateStorageClass {
-  if [ -z "${persistenceStorageClass}" ]; then
-    persistenceStorageClass=${domainUID}
-    echo Defaulting the input parameter persistenceStorageClass to be $domainUID
-  else
-    validateLowerCase "persistenceStorageClass" ${persistenceStorageClass}
-  fi
-}
-
-#
-# Function to validate the persistent volume claim name
-#
-function validatePersistentVolumeClaimName {
-  validateInputParamsSpecified persistenceVolumeClaimName
-  if [ ! -z "${persistenceVolumeClaimName}" ]; then
-    validateLowerCase "persistenceVolumeClaimName" ${persistenceVolumeClaimName}
-    if [[ "${persistenceVolumeClaimName}" != ${domainUID}-* ]] ; then
-      echo persistenceVolumeClaimName specified does not starts with \'${domainUID}-\', appending it
-      persistenceVolumeClaimName=${domainUID}-${persistenceVolumeClaimName}
-      echo persistenceVolumeClaimName is now ${persistenceVolumeClaimName}
-    fi
-  fi
-}
-
-#
-# Function to validate the persistent volume name
-#
-function validatePersistentVolumeName {
-  validateInputParamsSpecified persistenceVolumeName
-  if [ ! -z "${persistenceVolumeName}" ]; then
-    validateLowerCase "persistenceVolumeName" ${persistenceVolumeName}
-    if [[ "${persistenceVolumeName}" != ${domainUID}-* ]] ; then
-      echo persistenceVolumeName specified does not starts with \'${domainUID}-\', appending it
-      persistenceVolumeName=${domainUID}-${persistenceVolumeName}
-      echo persistenceVolumeName is now ${persistenceVolumeName}
-    fi
-  fi
-}
-
 #
 # Function to validate the weblogic domain storage type
 #
@@ -352,8 +309,6 @@ function initialize {
     managedServerNameBase \
     weblogicDomainStoragePath \
     weblogicDomainStorageSize \
-    persistenceVolumeName \
-    persistenceVolumeClaimName \
     weblogicCredentialsSecretName \
     namespace \
     javaOptions \
@@ -377,10 +332,7 @@ function initialize {
   validateDomainUid
   validateNamespace
   validateClusterName
-  validateStorageClass
   validateWeblogicDomainStorageType
-  validatePersistentVolumeName
-  validatePersistentVolumeClaimName
   validateWeblogicCredentialsSecretName
   validateWeblogicImagePullSecretName
   validateLoadBalancer
@@ -426,10 +378,8 @@ function createYamlFiles {
 
   sed -i -e "s:%DOMAIN_UID%:${domainUID}:g" ${domainPVOutput}
   sed -i -e "s:%NAMESPACE%:$namespace:g" ${domainPVOutput}
-  sed -i -e "s:%PERSISTENT_VOLUME%:${persistenceVolumeName}:g" ${domainPVOutput}
   sed -i -e "s:%WEBLOGIC_DOMAIN_STORAGE_PATH%:${weblogicDomainStoragePath}:g" ${domainPVOutput}
   sed -i -e "s:%WEBLOGIC_DOMAIN_STORAGE_SIZE%:${weblogicDomainStorageSize}:g" ${domainPVOutput}
-  sed -i -e "s:%STORAGE_CLASS_NAME%:${persistenceStorageClass}:g" ${domainPVOutput}
   sed -i -e "s:%HOST_PATH_PREFIX%:${hostPathPrefix}:g" ${domainPVOutput}
   sed -i -e "s:%NFS_PREFIX%:${nfsPrefix}:g" ${domainPVOutput}
 
@@ -439,8 +389,6 @@ function createYamlFiles {
   cp ${domainPVCInput} ${domainPVCOutput}
   sed -i -e "s:%NAMESPACE%:$namespace:g" ${domainPVCOutput}
   sed -i -e "s:%DOMAIN_UID%:${domainUID}:g" ${domainPVCOutput}
-  sed -i -e "s:%PERSISTENT_VOLUME_CLAIM%:${persistenceVolumeClaimName}:g" ${domainPVCOutput}
-  sed -i -e "s:%STORAGE_CLASS_NAME%:${persistenceStorageClass}:g" ${domainPVCOutput}
   sed -i -e "s:%WEBLOGIC_DOMAIN_STORAGE_SIZE%:${weblogicDomainStorageSize}:g" ${domainPVCOutput}
 
   # Generate the yaml to create the kubernetes job that will create the weblogic domain
@@ -451,7 +399,6 @@ function createYamlFiles {
   sed -i -e "s:%WEBLOGIC_CREDENTIALS_SECRET_NAME%:${weblogicCredentialsSecretName}:g" ${jobOutput}
   sed -i -e "s:%WEBLOGIC_IMAGE_PULL_SECRET_NAME%:${weblogicImagePullSecretName}:g" ${jobOutput}
   sed -i -e "s:%WEBLOGIC_IMAGE_PULL_SECRET_PREFIX%:${weblogicImagePullSecretPrefix}:g" ${jobOutput}
-  sed -i -e "s:%PERSISTENT_VOLUME_CLAIM%:${persistenceVolumeClaimName}:g" ${jobOutput}
   sed -i -e "s:%DOMAIN_UID%:${domainUID}:g" ${jobOutput}
   sed -i -e "s:%DOMAIN_NAME%:${domainName}:g" ${jobOutput}
   sed -i -e "s:%PRODUCTION_MODE_ENABLED%:${productionModeEnabled}:g" ${jobOutput}
@@ -519,26 +466,29 @@ function createYamlFiles {
 # Function to create the domain's persistent volume
 #
 function createDomainPV {
-
   # Check if the persistent volume is already available
-  checkPvExists ${persistenceVolumeName}
+  persistentVolumeName="${domainUID}-weblogic-domain-pv"
+  checkPvExists ${persistentVolumeName}
   if [ "${PV_EXISTS}" = "false" ]; then
-    echo Creating the persistent volume ${persistenceVolumeName}
+    echo Creating the persistent volume ${persistentVolumeName}
     kubectl create -f ${domainPVOutput}
-    checkPvState ${persistenceVolumeName} Available
+    checkPvState ${persistentVolumeName} Available
   fi
 }
 
 #
 # Function to create the domain's persistent volume claim
+# Must be called after createDomainPV since it relies on
+# createDomainPV defining persistentVolumeName
 #
 function createDomainPVC {
   # Check if the persistent volume claim is already available
-  checkPvcExists ${persistenceVolumeClaimName} ${namespace}
+  persistentVolumeClaimName="${domainUID}-weblogic-domain-pvc"
+  checkPvcExists ${persistentVolumeClaimName} ${namespace}
   if [ "${PVC_EXISTS}" = "false" ]; then
-    echo Creating the persistent volume claim ${persistenceVolumeClaimName}
+    echo Creating the persistent volume claim ${persistentVolumeClaimName}
     kubectl create -f ${domainPVCOutput}
-    checkPvState ${persistenceVolumeName} Bound
+    checkPvState ${persistentVolumeName} Bound
   fi
 }
 

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

@@ -4,12 +4,12 @@
 kind: PersistentVolumeClaim
 apiVersion: v1
 metadata:
-  name: %PERSISTENT_VOLUME_CLAIM%
+  name: %DOMAIN_UID%-weblogic-domain-pvc
   namespace: %NAMESPACE%
   labels:
     weblogic.domainUID: %DOMAIN_UID%
 spec:
-  storageClassName: %STORAGE_CLASS_NAME%
+  storageClassName: %DOMAIN_UID%-weblogic-domain-storage-class
   accessModes:
     - ReadWriteMany
   resources:

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

@@ -4,11 +4,11 @@
 apiVersion: v1
 kind: PersistentVolume
 metadata:
-  name: %PERSISTENT_VOLUME%
+  name: %DOMAIN_UID%-weblogic-domain-pv
   labels:
     weblogic.domainUID: %DOMAIN_UID%
 spec:
-  storageClassName: %STORAGE_CLASS_NAME%
+  storageClassName: %DOMAIN_UID%-weblogic-domain-storage-class
   capacity:
     storage: %WEBLOGIC_DOMAIN_STORAGE_SIZE%
   accessModes:

src/integration-tests/bash/cleanup.sh

@@ -196,8 +196,8 @@ function orderlyDelete {
     kubectl -n $curns delete job domain-${curdomain}-job --ignore-not-found
 
     echo @@ Deleting domain pv and pvc for domain ${curdomain} in namespace $curns
-    kubectl delete pv ${curdomain}-pv --ignore-not-found
-    kubectl -n $curns delete pvc ${curdomain}-pv-claim --ignore-not-found
+    kubectl delete pv ${curdomain}-weblogic-domain-pv --ignore-not-found
+    kubectl -n $curns delete pvc ${curdomain}-weblogic-domain-pvc --ignore-not-found
 
     echo @@ Deleting ${curdomain}-weblogic-credentials secret in namespace $curns
     kubectl -n $curns delete secret ${curdomain}-weblogic-credentials --ignore-not-found

src/integration-tests/bash/run.sh

@@ -136,7 +136,7 @@
 #
 #      Local tmp files:      RESULT_ROOT/acceptance_test_tmp/...
 #
-#      PV dirs K8S NFS:      PV_ROOT/acceptance_test_pv/persistentVolume-${domain_uid}/...
+#      PV dirs K8S NFS:      PV_ROOT/acceptance_test_pv/domain-${domain_uid}-storage/...
 #
 #      Archives of above:    PV_ROOT/acceptance_test_pv_archive/...
 #                            RESULT_ROOT/acceptance_test_tmp_archive/...
@@ -705,8 +705,7 @@ function run_create_domain_job {
 
     trace "WLS_JAVA_OPTIONS = \"$WLS_JAVA_OPTIONS\""
 
-    local PV="pv"
-    local PV_DIR="persistentVolume-${DOMAIN_UID}"
+    local DOMAIN_STORAGE_DIR="domain-${DOMAIN_UID}-storage"
 
     trace "Create $DOMAIN_UID in $NAMESPACE namespace "
 
@@ -745,10 +744,8 @@ function run_create_domain_job {
     sed -i -e "s/^exposeAdminT3Channel:.*/exposeAdminT3Channel: true/" $inputs
 
     # Customize more configuration 
-    sed -i -e "s/^persistenceVolumeName:.*/persistenceVolumeName: ${PV}/" $inputs
-    sed -i -e "s/^persistenceVolumeClaimName:.*/persistenceVolumeClaimName: $PV-claim/" $inputs
-    sed -i -e "s;^persistencePath:.*;persistencePath: $PV_ROOT/acceptance_test_pv/$PV_DIR;" $inputs
-    sed -i -e "s/^domainUID:.*/domainUID: $DOMAIN_UID/" $inputs
+    sed -i -e "s;^#weblogicDomainStoragePath:.*;weblogicDomainStoragePath: $PV_ROOT/acceptance_test_pv/$DOMAIN_STORAGE_DIR;" $inputs
+    sed -i -e "s/^#domainUID:.*/domainUID: $DOMAIN_UID/" $inputs
     sed -i -e "s/^clusterName:.*/clusterName: $WL_CLUSTER_NAME/" $inputs
     sed -i -e "s/^namespace:.*/namespace: $NAMESPACE/" $inputs
     sed -i -e "s/^t3ChannelPort:.*/t3ChannelPort: $ADMIN_WLST_PORT/" $inputs
@@ -762,7 +759,7 @@ function run_create_domain_job {
       sed -i -e "s|#weblogicImagePullSecretName:.*|weblogicImagePullSecretName: ${WEBLOGIC_IMAGE_PULL_SECRET_NAME}|g" $inputs
     fi
     sed -i -e "s/^loadBalancerWebPort:.*/loadBalancerWebPort: $LOAD_BALANCER_WEB_PORT/" $inputs
-    sed -i -e "s/^loadBalancerDashboardPort:.*/loadBalancerAdminPort: $LOAD_BALANCER_DASHBOARD_PORT/" $inputs
+    sed -i -e "s/^loadBalancerDashboardPort:.*/loadBalancerDashboardPort: $LOAD_BALANCER_DASHBOARD_PORT/" $inputs
     sed -i -e "s/^javaOptions:.*/javaOptions: $WLS_JAVA_OPTIONS/" $inputs
     sed -i -e "s/^startupControl:.*/startupControl: $STARTUP_CONTROL/"  $inputs
 
@@ -772,11 +769,11 @@ function run_create_domain_job {
     fi
 
     local outfile="${tmp_dir}/mkdir_physical_nfs.out"
-    trace "Use a job to create the k8s host directory \"$PV_ROOT/acceptance_test_pv/$PV_DIR\" that we will use for the domain's persistent volume, see \"$outfile\" for job tracing."
+    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."
 
     # 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/$PV_DIR" > ${outfile} 2>&1
+    $SCRIPTPATH/job.sh "mkdir -p /scratch/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.

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

@@ -182,7 +182,7 @@ protected V1Job getExpectedCreateWeblogicDomainJob() {
               .addVolumesItem(newVolume()
                 .name("pv-storage")
                 .persistentVolumeClaim(newPersistentVolumeClaimVolumeSource()
-                  .claimName(getInputs().getDomainUID() + "-" + getInputs().getPersistenceVolumeClaimName())))
+                  .claimName(getInputs().getWeblogicDomainPersistentVolumeClaimName())))
               .addVolumesItem(newVolume()
                 .name("secrets")
                   .secret(newSecretVolumeSource()
@@ -652,10 +652,10 @@ protected V1PersistentVolume getExpectedWeblogicDomainPersistentVolume() {
     return
         newPersistentVolume()
           .metadata(newObjectMeta()
-            .name(getInputs().getDomainUID() + "-" + getInputs().getPersistenceVolumeName())
+            .name(getInputs().getWeblogicDomainPersistentVolumeName())
             .putLabelsItem("weblogic.domainUID", getInputs().getDomainUID()))
           .spec(newPersistentVolumeSpec()
-            .storageClassName(getInputs().getDomainUID())
+            .storageClassName(getInputs().getWeblogicDomainStorageClass())
             .putCapacityItem("storage", getInputs().getWeblogicDomainStorageSize())
             .addAccessModesItem("ReadWriteMany")
             .persistentVolumeReclaimPolicy("Retain"));
@@ -676,11 +676,11 @@ protected V1PersistentVolumeClaim getExpectedWeblogicDomainPersistentVolumeClaim
     return
       newPersistentVolumeClaim()
         .metadata(newObjectMeta()
-          .name(getInputs().getDomainUID() + "-" + getInputs().getPersistenceVolumeClaimName())
+          .name(getInputs().getWeblogicDomainPersistentVolumeClaimName())
           .namespace(getInputs().getNamespace())
           .putLabelsItem("weblogic.domainUID", getInputs().getDomainUID()))
         .spec(newPersistentVolumeClaimSpec()
-          .storageClassName(getInputs().getDomainUID())
+          .storageClassName(getInputs().getWeblogicDomainStorageClass())
           .addAccessModesItem("ReadWriteMany")
           .resources(newResourceRequirements()
             .putRequestsItem("storage", getInputs().getWeblogicDomainStorageSize())));

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

@@ -51,8 +51,6 @@ public class CreateDomainInputs {
   private String weblogicDomainStoragePath = "";
   private String weblogicDomainStorageSize = "";
   private String weblogicDomainStorageType = "";
-  private String persistenceVolumeClaimName = "";
-  private String persistenceVolumeName = "";
   private String productionModeEnabled = "";
   private String weblogicCredentialsSecretName = "";
   private String weblogicImagePullSecretName = "";
@@ -87,8 +85,6 @@ public static CreateDomainInputs newInputs() throws Exception {
         .namespace("test-domain-namespace")
         .weblogicDomainStoragePath("TestDomainStoragePath")
         .weblogicDomainStorageSize("20Gi")
-        .persistenceVolumeClaimName("test-domain-pvc")
-        .persistenceVolumeName("test-domain-pv")
         .productionModeEnabled("false")
         .weblogicCredentialsSecretName("test-weblogic-credentials")
         .startupControl(STARTUP_CONTROL_ALL)
@@ -109,6 +105,18 @@ private static Path defaultInputsPath() {
     return FileSystems.getDefault().getPath(DEFAULT_INPUTS);
   }
 
+  public String getWeblogicDomainStorageClass() {
+    return getDomainUID() + "-weblogic-domain-storage-class";
+  }
+
+  public String getWeblogicDomainPersistentVolumeName() {
+    return getDomainUID() + "-weblogic-domain-pv";
+  }
+
+  public String getWeblogicDomainPersistentVolumeClaimName() {
+    return getDomainUID() + "-weblogic-domain-pvc";
+  }
+
   public String getAdminPort() {
     return adminPort;
   }
@@ -291,32 +299,6 @@ public CreateDomainInputs weblogicDomainStorageType(String weblogicDomainStorage
     return this;
   }
 
-  public String getPersistenceVolumeClaimName() {
-    return persistenceVolumeClaimName;
-  }
-
-  public void setPersistenceVolumeClaimName(String persistenceVolumeClaimName) {
-    this.persistenceVolumeClaimName = convertNullToEmptyString(persistenceVolumeClaimName);
-  }
-
-  public CreateDomainInputs persistenceVolumeClaimName(String persistenceVolumeClaimName) {
-    setPersistenceVolumeClaimName(persistenceVolumeClaimName);
-    return this;
-  }
-
-  public String getPersistenceVolumeName() {
-    return persistenceVolumeName;
-  }
-
-  public void setPersistenceVolumeName(String persistenceVolumeName) {
-    this.persistenceVolumeName = convertNullToEmptyString(persistenceVolumeName);
-  }
-
-  public CreateDomainInputs persistenceVolumeName(String persistenceVolumeName) {
-    setPersistenceVolumeName(persistenceVolumeName);
-    return this;
-  }
-
   public String getProductionModeEnabled() {
     return productionModeEnabled;
   }