Domain sample update and cleanup (#614)

* Cleanup sample code and README plus update domain template for envs

Signed-off-by: doxiao <[email protected]>

* Move envs to serverPod and serverStartStae to domain level

Signed-off-by: doxiao <[email protected]>

* Move serverStartState back to admin server level to avoid empty adminServer element

Signed-off-by: doxiao <[email protected]>

* Remove unused functions and update README

Signed-off-by: doxiao <[email protected]>

* Minor edits to the README files

Signed-off-by: doxiao <[email protected]>

* Remove only the generated files

Signed-off-by: doxiao <[email protected]>

* Address a review comment

Signed-off-by: doxiao <[email protected]>

* refactor the create domain scripts to share common code

* Fix a merge error

Signed-off-by: doxiao <[email protected]>

* Fix an error in commit 73a4df4

Signed-off-by: doxiao <[email protected]>

* Customize base image in domain-home-in-image sample

Signed-off-by: doxiao <[email protected]>

* Correct the default base image

Signed-off-by: doxiao <[email protected]>

* Fix a problem in domain home in image case

Signed-off-by: doxiao <[email protected]>

* Minor correction

Signed-off-by: doxiao <[email protected]>

* Revert "Minor correction"

This reverts commit ec9ee5c.

* Remove what is already in another PR

Signed-off-by: doxiao <[email protected]>

Author: doxiao

kubernetes/samples/scripts/common/utility.sh

@@ -41,6 +41,15 @@ function parseYaml {
   }' > $2
 }
 
+#
+# Function to remove a file if it exists 
+#
+function removeFileIfExists {
+  if [ -f $1 ]; then
+    rm $1
+  fi
+}
+
 #
 # Function to parse the common parameter inputs file
 #
@@ -203,4 +212,44 @@ function getKubernetesClusterIP {
   K8S_IP="${array[1]}"
 }
 
+#
+# Function to create the domain recource
+#
+function createDomainResource {
+  kubectl apply -f ${dcrOutput}
+  DCR_AVAIL=`kubectl get domain -n ${namespace} | grep ${domainUID} | wc | awk ' { print $1; } '`
+  if [ "${DCR_AVAIL}" != "1" ]; then
+    fail "The domain resource ${domainUID} was not found"
+  fi
+}
+
+#
+# Function to create a domain
+#
+function createDomain {
+
+  # Setup the environment for running this script and perform initial validation checks
+  initialize
+
+  # Generate files for creating the domain
+  createFiles
+
+  # Check that the domain secret exists and contains the required elements
+  validateDomainSecret
+
+  # Validate the domain's persistent volume claim
+  if [ "$doValidation" == true ]; then
+    validateDomainPVC
+  fi
+
+  # Create the WebLogic domain home
+  createDomainHome
+
+  if [ "${executeIt}" = true ]; then
+    createDomainResource
+  fi
+
+  # Print a summary
+  printSummary
+}
 

kubernetes/samples/scripts/common/validate.sh

@@ -100,72 +100,6 @@ function validateNamespace {
   validateLowerCase "namespace" ${namespace}
 }
 
-#
-# Function to validate that either the output dir does not exist,
-# or that if it does, it does not contain any generated yaml files
-# and does not contain an inputs file that differs from the one
-# the script is using
-# $1   - the output directory to validate
-# $2   - the name of the input file the create script is using
-# $3   - the name of the input file that is put into the output directory
-# $4-n - the names of the generated yaml files
-function validateOutputDir {
-  local dir=$1
-  shift
-  if [ -e ${dir} ]; then
-    # the output directory already exists
-    if [ -d ${dir} ]; then
-      # the output directory is a directory
-      local in1=$1
-      shift
-      local in2=${1}
-      shift
-      internalValidateGeneratedYamlFilesDoNotExist ${dir} $@
-    else
-      validationError "${dir} exists but is not a directory."
-    fi
-  fi
-}
-
-#
-# Internal function to validate that the inputs file does not exist in the
-# outputs directory or is the same as the inputs file the script is using
-# $1 - the output directory to validate
-# $2 - the name of the input file the create script is using
-# $3 - the name of the input file that is put into the output directory
-function internalValidateInputsFileDoesNotExistOrIsTheSame {
-  local dir=$1
-  local in1=$2
-  local in2=$3
-  local f="${dir}/${in2}"
-  if [ -e ${f} ]; then
-    if [ -f ${f} ]; then
-      local differences=`diff -q ${f} ${in1}`
-      if ! [ -z "${differences}" ]; then
-        validationError "${f} is different than ${in1}"
-      fi
-    else
-      validationError "${f} exists and is not a file."
-    fi
-  fi
-}
-
-#
-# Internal unction to validate that the generated yaml files do not exist
-# in the outputs directory
-# $1 - the output directory to validate
-# $2-n - the names of the generated yaml files
-function internalValidateGeneratedYamlFilesDoNotExist {
-  local dir=$1
-  shift
-  for var in "$@"; do
-    local f="${dir}/${var}"
-    if [ -e ${f} ]; then
-      validationError "${f} exists."
-    fi
-  done
-}
-
 #
 # Function to validate the version of the inputs file
 #
@@ -329,4 +263,82 @@ function validateLoadBalancer {
   fi
 }
 
+#
+# Function to validate a kubernetes secret exists
+# $1 - the name of the secret
+# $2 - namespace
+function validateSecretExists {
+  echo "Checking to see if the secret ${1} exists in namespace ${2}"
+  local SECRET=`kubectl get secret ${1} -n ${2} | grep ${1} | wc | awk ' { print $1; }'`
+  if [ "${SECRET}" != "1" ]; then
+    validationError "The secret ${1} was not found in namespace ${2}"
+  fi
+}
+
+#
+# Function to validate the domain secret
+#
+function validateDomainSecret {
+  # Verify the secret exists
+  validateSecretExists ${weblogicCredentialsSecretName} ${namespace}
+  failIfValidationErrors
+
+  # Verify the secret contains a username
+  SECRET=`kubectl get secret ${weblogicCredentialsSecretName} -n ${namespace} -o jsonpath='{.data}'| grep username: | wc | awk ' { print $1; }'`
+  if [ "${SECRET}" != "1" ]; then
+    validationError "The domain secret ${weblogicCredentialsSecretName} in namespace ${namespace} does contain a username"
+  fi
+
+  # Verify the secret contains a password
+  SECRET=`kubectl get secret ${weblogicCredentialsSecretName} -n ${namespace} -o jsonpath='{.data}'| grep password: | wc | awk ' { print $1; }'`
+  if [ "${SECRET}" != "1" ]; then
+    validationError "The domain secret ${weblogicCredentialsSecretName} in namespace ${namespace} does contain a password"
+  fi
+  failIfValidationErrors
+}
+
+#
+# Function to validate the common input parameters
+#
+function validateCommonInputs {
+  # Parse the commonn inputs file
+  parseCommonInputs
+
+  validateInputParamsSpecified \
+    adminServerName \
+    domainUID \
+    clusterName \
+    managedServerNameBase \
+    namespace \
+    t3PublicAddress \
+    includeServerOutInPodLog \
+    version
+
+  validateIntegerInputParamsSpecified \
+    adminPort \
+    configuredManagedServerCount \
+    initialManagedServerReplicas \
+    managedServerPort \
+    t3ChannelPort \
+    adminNodePort
+
+  validateBooleanInputParamsSpecified \
+    productionModeEnabled \
+    exposeAdminT3Channel \
+    exposeAdminNodePort \
+    includeServerOutInPodLog
+
+  export requiredInputsVersion="create-weblogic-sample-domain-inputs-v1"
+  validateVersion
+
+  validateDomainUid
+  validateNamespace
+  validateAdminServerName
+  validateManagedServerNameBase
+  validateClusterName
+  validateWeblogicCredentialsSecretName
+  validateServerStartPolicy
+  validateClusterType
+  failIfValidationErrors
+}
 

kubernetes/samples/scripts/create-weblogic-domain-load-balancer/create-load-balancer.sh

@@ -62,23 +62,23 @@ fi
 # Function to initialize and validate the output directory
 # for the generated yaml files for this domain.
 #
-function initAndValidateOutputDir {
+function initOutputDir {
   lbOutputDir=${outputDir}/load-balancers/${domainUID}
 
   if [ ! -z "${loadBalancer}" ]; then
     case ${loadBalancer} in
       "TRAEFIK")
-        fileList="traefik.yaml \
-                  traefik-security.yaml "
+        removeFileIfExists ${lbOutputDir}/traefik.yaml
+        removeFileIfExists ${lbOutputDir}/traefik-security.yaml
       ;;
       "APACHE")
-        fileList="apache.yaml \
-                  apache-security.yaml "
+        removeFileIfExists ${lbOutputDir}/apache.yaml 
+        removeFileIfExists ${lbOutputDir}/apache-security.yaml 
       ;;
       "VOYAGER")
-        fileList="voyager-ingress.yaml \
-                  voyager-operator.yaml \
-                  voyager-operator-security.yaml"
+        removeFileIfExists ${lbOutputDir}/voyager-ingress.yaml 
+        removeFileIfExists ${lbOutputDir}/voyager-operator.yaml \
+        removeFileIfExists ${lbOutputDir}/voyager-operator-security.yaml
       ;;
       "NONE")
       ;;
@@ -87,11 +87,10 @@ function initAndValidateOutputDir {
       ;;
     esac
   fi
-  validateOutputDir \
-    ${lbOutputDir} \
-    ${valuesInputFile} \
-    create-load-balancer-inputs.yaml \
-    ${fileList}
+
+  removeFileIfExists ${lbOutputDir}/${valuesInputFile}
+  removeFileIfExists ${lbOutputDir}/create-load-balancer-inputs.yaml 
+
 }
 
 #
@@ -169,7 +168,7 @@ function initialize {
   validateNamespace
   validateClusterName
   validateLoadBalancer
-  initAndValidateOutputDir
+  initOutputDir
   failIfValidationErrors
 }
 

kubernetes/samples/scripts/create-weblogic-domain-pv-pvc/README.md

@@ -61,9 +61,9 @@ The PV and PVC creation inputs can be customized by editing the `create-pv-pvc-i
 
 ## Shared versus dedicated PVC
 
-By default, the `domainUID` is left empty in the inputs file so that the generated PV and PVC can be shared by multiple domain resources in the same Kubernetes namespaces.
+By default, the `domainUID` is left empty in the inputs file, which means the generated PV and PVC will not be associated with a particular domain, but can be shared by multiple domain resources in the same Kubernetes namespaces as the PV and PVC.
 
-For the use cases where a dedicated PV and PVC is desired for a particular domain, the `domainUID` can be set, which will cause the generated PV and PVC to be associated with the specified `domainUID`. In the per domain PV and PVC case, the names of the generated YAML files and the Kubernetes PV and PVC objects are decorated with the `domainUID`, and the PV and PVC objects are also labeled with the `domainUID`.
+For the use cases where dedicated PV and PVC are desired for a particular domain, the `domainUID` needs to be set in the `create-pv-pvc-inputs.yaml` file. The presence of a non-empty domainUID in the inputs file will cause the generated PV and PVC to be associated with the specified `domainUID`. The association includes that the names of the generated YAML files and the Kubernetes PV and PVC objects are decorated with the `domainUID`, and the PV and PVC objects are also labeled with the `domainUID`.
 
 ## Verify the results
 

kubernetes/samples/scripts/create-weblogic-domain-pv-pvc/create-pv-pvc.sh

@@ -64,7 +64,7 @@ fi
 # Function to initialize and validate the output directory
 # for the generated yaml files for this domain.
 #
-function initAndValidateOutputDir {
+function initOutputDir {
   pvOutputDir="$outputDir/pv-pvcs"
 
   if [ -z ${domainUID} ]; then
@@ -78,13 +78,10 @@ function initAndValidateOutputDir {
     persistentVolumeName=${domainUID}-${baseName}-pv
     persistentVolumeClaimName=${domainUID}-${baseName}-pvc
   fi
-
-  validateOutputDir \
-    ${pvOutputDir} \
-    ${valuesInputFile} \
-    create-pv-pvc-inputs.yaml \
-    ${pvOutput} \
-    ${pvcOutput}
+  removeFileIfExists ${pvOutputDir}/{valuesInputFile}
+  removeFileIfExists ${pvOutputDir}/{pvOutput}
+  removeFileIfExists ${pvOutputDir}/{pvcOutput}
+  removeFileIfExists ${pvOutputDir}/create-pv-pvc-inputs.yaml
 }
 
 #
@@ -133,7 +130,7 @@ function initialize {
   validateNamespace
   validateWeblogicDomainStorageType
   validateWeblogicDomainStorageReclaimPolicy
-  initAndValidateOutputDir
+  initOutputDir
   failIfValidationErrors
 }
 

kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image/README.md

@@ -24,7 +24,7 @@ Make a copy of the `create-domain-inputs.yaml` file, and run the create script,
 
 The script will perform the following steps:
 
-* Create a directory for the generated properties and Kubernetes YAML files for this domain if it does not already exist.  The pathname is `/path/to/weblogic-operator-output-directory/weblogic-domains/<domainUID>`. Note that the script fails if the directory is not empty when the `create-domain.sh` script is executed.
+* Create a directory for the generated properties and Kubernetes YAML files for this domain if it does not already exist.  The pathname is `/path/to/weblogic-operator-output-directory/weblogic-domains/<domainUID>`. If the directory already exists, its contents will be removed.
 * Create a properties file, `domain.properties`, in the directory that is created above. This properties file will be used to create a sample WebLogic Server domain.
 * Clone the weblogic docker-images project via the `git clone https://github.com/oracle/docker-images.git` into the current directory.
 * Replace the built-in username and password in the `properties/docker_build/domain_security.properties` file with the `username` and `password` that are supplied in the command line via the `-u` and `-p` options. These credentials need to match the WebLogic domain admin credentials in the secret that is specified via `weblogicCredentialsSecretName` property in the `create-domain-inputs.yaml` file.
@@ -188,11 +188,11 @@ API Version:  weblogic.oracle/v2
 Kind:         Domain
 Metadata:
   Cluster Name:        
-  Creation Timestamp:  2018-12-11T01:33:27Z
+  Creation Timestamp:  2018-12-11T21:27:35Z
   Generation:          1
-  Resource Version:    46624
+  Resource Version:    814010
   Self Link:           /apis/weblogic.oracle/v2/namespaces/default/domains/domain1
-  UID:                 c1f7be60-fce4-11e8-bc6c-0021f6985fb7
+  UID:                 93e55739-fd8b-11e8-b751-fa163e855ac8
 Spec:
   Admin Secret:
     Name:  domain1-weblogic-credentials
@@ -246,6 +246,10 @@ Spec:
   Server Pod:
     Container Security Context:
     Env:
+      Name:   JAVA_OPTIONS
+      Value:  -Dweblogic.StdoutDebugEnabled=false
+      Name:   USER_MEM_ARGS
+      Value:  -Xms64m -Xmx256m 
     Liveness Probe:
     Node Selector:
     Pod Annotations:
@@ -262,35 +266,27 @@ Spec:
   Server Start Policy:  IF_NEEDED
 Status:
   Conditions:
-    Last Transition Time:  2018-12-11T01:35:23.652Z
+    Last Transition Time:  2018-12-11T21:28:59.537Z
     Reason:                ServersReady
     Status:                True
     Type:                  Available
   Servers:
     Health:
-      Activation Time:  2018-12-11T01:34:59.546Z
+      Activation Time:  2018-12-11T21:28:36.983Z
       Overall Health:   ok
       Subsystems:
     Node Name:     xxxxxxxx
     Server Name:   admin-server
     State:         RUNNING
     Cluster Name:  cluster-1
-    Health:
-      Activation Time:  2018-12-11T01:36:46.132Z
-      Overall Health:   ok
-      Subsystems:
     Node Name:     xxxxxxxx
     Server Name:   managed-server1
-    State:         RUNNING
+    State:         STARTING
     Cluster Name:  cluster-1
-    Health:
-      Activation Time:  2018-12-11T01:36:47.865Z
-      Overall Health:   ok
-      Subsystems:
     Node Name:     xxxxxxxx
     Server Name:   managed-server2
-    State:        RUNNING
-  Start Time:     2018-12-11T01:33:27.339Z
+    State:         STARTING
+  Start Time:      2018-12-11T21:27:35.869Z
 Events:            <none>
 ```