Update comments, usage text, function name, and temp file name.

Author: Tom Barnes

kubernetes/delete-domain.sh

@@ -3,23 +3,15 @@
 # Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
 #
 # Description:
-#   Use this script to delete a set of given domains, or all domains.
-#
-#   Alternatively, run the script in a test mode to show what would
-#   be deleted without actually performing the deletes.
+#   Use this script to delete all kubernetes resources associated
+#   with a set of given domains.  Alternatively, run the script
+#   in a test mode to show what would be deleted without actually
+#   performing the deletes.
 #
 # Usage:
 #   See "function usage" below or call this script with no parameters.
 #
 
-# default when to stop retrying (override via command line)
-default_maxwaitsecs=120
-
-# optional test mode that lists what would be deleted without 
-# actually deleting (override via command line)
-test_mode=false
-
-
 function usage {
 cat << EOF
   Usage:
@@ -28,9 +20,9 @@ cat << EOF
     $(basename $0) -d all [-s max-seconds] [-t]
     $(basename $0) -h
 
-  Perform a best-effort delete of the k8s artifacts for
+  Perform a best-effort delete of the kubernetes resources for
   the given domain(s), and retry until either max-seconds is reached
-  or all artifacts were deleted (default $default_maxwaitsecs seconds).
+  or all resources were deleted (default $default_maxwaitsecs seconds).
 
   The domains can be specified as a comma-separated list of 
   domain-uids (no spaces), or the keyword 'all'.  The domains can be
@@ -39,21 +31,22 @@ cat << EOF
   Specify '-t' to run the script in a test mode which will
   show kubernetes commands but not actually perform them.
 
-  The delete occurs in three phases:  
+  The script runs in three phases:  
 
-    Phase 1:  Set the startupControl of each domain to NONE 
-              if it's not already NONE.  This should cause each
-              domain's operator to initiate a controlled
-              shutdown of the domain.
+    Phase 1:  Set the startupControl of each domain to NONE if
+              it's not already NONE.  This should cause each
+              domain's operator to initiate a controlled shutdown
+              of the domain.  Immediately proceed to phase 2.
 
-    Phase 2:  Wait up to half the max wait seconds
-              for WebLogic Server pods to exit normally.
+    Phase 2:  Wait up to half of max-seconds for WebLogic
+              Server pods to exit normally, and then proceed
+              to phase 3.
 
-    Phase 3:  Delete all kubernetes objects for the 
-              specified domains, including any pods
-              leftover from phase 2.  Give up if max
-              seconds is exceeded and there are any
-              leftover kubernetes objects for the domain(s).
+    Phase 3:  Periodically delete all remaining kubernetes resources
+              for the specified domains, including any pods
+              leftover from phase 2.  Exit and fail if max-seconds
+              is exceeded and there are any leftover kubernetes
+              resources.
 
   This script exits with a zero status on success, and a 
   non-zero status on failure.
@@ -62,20 +55,20 @@ EOF
 
 
 #
-# getDomains domain(s) outfilename
+# getDomainResources domain(s) outfilename
 #
 # Usage:
-#   getDomains domainA,domainB,... outfilename
-#   getDomains all outfilename
+#   getDomainResources domainA,domainB,... outfilename
+#   getDomainResources all outfilename
 #
 # Internal helper function
 #
-# File output is all domain related artifacts for the given domain uids, one per line,
-# in the form:  'kind  name [-n namespace]'.  For example
+# File output is all domain related resources for the given domain uids, one per line,
+# in the form:  'kind  name [-n namespace]'.  For example:
 #    PersistentVolumeClaim domain1-pv-claim -n default 
 #    PersistentVolume domain1-pv 
 #
-function getDomains {
+function getDomainResources {
   if [ "$1" = "all" ]; then
     local label_selector="weblogic.domainUID"
   else
@@ -115,7 +108,7 @@ function getDomains {
 # Internal helper function
 #   This function first sets the startupControl of each Domain to NONE
 #   and waits up to half of $2 for pods to 'self delete'.  It then deletes
-#   all remaining k8s artifacts for domain $1 (including any remaining pods)
+#   all remaining k8s resources for domain $1 (including any remaining pods)
 #   and retries up to $2 seconds.
 #
 #   If $1 has special value "all", it deletes all domains in all namespaces.
@@ -125,38 +118,38 @@ function getDomains {
 function deleteDomains {
 
   if [ "$test_mode" = "true" ]; then
-    echo @@ Test mode! Displaying commands for deleting kubernetes artifacts with label weblogic.domainUID \'$1\' without actually deleting them.
+    echo @@ Test mode! Displaying commands for deleting kubernetes resources with label weblogic.domainUID \'$1\' without actually deleting them.
   else
-    echo @@ Deleting kubernetes artifacts with label weblogic.domainUID \'$1\'.
+    echo @@ Deleting kubernetes resources with label weblogic.domainUID \'$1\'.
   fi
 
   local maxwaitsecs=${2:-$default_maxwaitsecs}
-  local tempfile="/tmp/getdomain.tmp.$1.$$"
+  local tempfile="/tmp/$(basename $0).tmp.$$"  # == /tmp/[script-file-name].tmp.[pid]
   local mstart=`date +%s`
   local phase=1
 
   while : ; do
-    # get all k8s objects with matching domain-uid labels and put them in $tempfile
-    getDomains $1 $tempfile
+    # get all k8s resources with matching domain-uid labels and put them in $tempfile
+    getDomainResources $1 $tempfile
 
-    # get a count of all k8s objects with matching domain-uid labels
+    # get a count of all k8s resources with matching domain-uid labels
     local allcount=`wc -l $tempfile | awk '{ print $1 }'`
 
     # get a count of all WLS pods (any pod with a matching domain-uid label that doesn't have 'traefik' embedded in its name)
     local podcount=`grep "^Pod" $tempfile | grep -v traefik | wc -l | awk '{ print $1 }'`
 
     local mnow=`date +%s`
 
-    echo @@ $allcount objects remaining after $((mnow - mstart)) seconds, including $podcount WebLogic Server pods. Max wait is $maxwaitsecs seconds.
+    echo @@ $allcount resources remaining after $((mnow - mstart)) seconds, including $podcount WebLogic Server pods. Max wait is $maxwaitsecs seconds.
 
-    # Exit if all k8s objects deleted are max wait seconds exceeded.
+    # Exit if all k8s resources deleted or max wait seconds exceeded.
 
     if [ $allcount -eq 0 ]; then
       echo @@ Success.
       rm -f $tempfile
       exit 0
     elif [ $((mnow - mstart)) -gt $maxwaitsecs ]; then
-      echo @@ Error! Max wait of $maxwaitsecs seconds exceeded with $allcount objects remaining, including $podcount WebLogic Server pods. Giving up. Remaining objects:
+      echo @@ Error! Max wait of $maxwaitsecs seconds exceeded with $allcount resources remaining, including $podcount WebLogic Server pods. Giving up. Remaining resources:
       cat $tempfile
       rm -f $tempfile
       exit $allcount
@@ -184,9 +177,9 @@ function deleteDomains {
 
     if [ $phase -eq 2 ]; then
       if [ $podcount -eq 0 ]; then
-        echo @@ All pods shutdown, about to directly delete remaining artifacts.
+        echo @@ All pods shutdown, about to directly delete remaining resources.
       elif [ $((mnow - mstart)) -gt $((maxwaitsecs / 2)) ]; then
-        echo @@ Warning! $podcount WebLogic Server pods remaining but wait time exceeds half of max wait seconds.  About to directly delete all remaining artifacts, including the leftover pods.
+        echo @@ Warning! $podcount WebLogic Server pods remaining but wait time exceeds half of max wait seconds.  About to directly delete all remaining resources, including the leftover pods.
       else
         echo @@ "Waiting for operator to shutdown pods (will wait for no more than half of max wait seconds before directly deleting them)."
         sleep 3
@@ -195,7 +188,7 @@ function deleteDomains {
     fi
     phase=3
 
-    # In phase 3, directly delete all k8s artifacts for the given domainUids
+    # In phase 3, directly delete all k8s resources for the given domainUids
     # (including any leftover WLS pods from phases 1 & 2).
 
     cat $tempfile | while read line; do 
@@ -209,6 +202,15 @@ function deleteDomains {
   done
 }
 
+# main entry point
+
+# default when to stop retrying (override via command line)
+default_maxwaitsecs=120
+
+# optional test mode that lists what would be deleted without 
+# actually deleting (override via command line)
+test_mode=false
+
 domains=""
 
 # parse command line options