Merge pull request #733 from oracle/OWLS-70652

Update the domain home in image sample to keep server logs on PV

Author: rjeberhard

kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/domain-template.yaml renamed to kubernetes/samples/scripts/common/domain-template.yaml

@@ -16,7 +16,7 @@ spec:
   # The WebLogic Domain Home
   domainHome: %DOMAIN_HOME%
   # If the domain home is in the image
-  domainHomeInImage: false
+  domainHomeInImage: %DOMAIN_HOME_IN_IMAGE%
   # The Operator currently does not support other images
   image: "%WEBLOGIC_IMAGE%"
   # imagePullPolicy defaults to "Always" if image version is :latest
@@ -30,11 +30,13 @@ spec:
     name: %WEBLOGIC_CREDENTIALS_SECRET_NAME%
   # Whether to include the server out file into the pod's stdout, default is true
   includeServerOutInPodLog: %INCLUDE_SERVER_OUT_IN_POD_LOG%
+  # Whether to enable log home 
+  %LOG_HOME_ON_PV_PREFIX%logHomeEnabled: %LOG_HOME_ENABLED%
   # The in-pod name of the directory to store the domain, node manager, server logs, and server .out
   # files in.
   # If not specified or empty, domain log file, server logs, server out, and node manager log files 
   # will be stored in the default logHome location of /shared/logs/<domainUID>/.
-  logHome: %LOG_HOME%
+  %LOG_HOME_ON_PV_PREFIX%logHome: %LOG_HOME%
   # serverStartPolicy legal values are "NEVER", "IF_NEEDED", or "ADMIN_ONLY"
   # This determines which WebLogic Servers the Operator will start up when it discovers this Domain
   # - "NEVER" will not start any server in the domain
@@ -48,13 +50,13 @@ spec:
       value: "%JAVA_OPTIONS%"
     - name: USER_MEM_ARGS
       value: "-Xms64m -Xmx256m "
-    volumes:
-    - name: weblogic-domain-storage-volume
-      persistentVolumeClaim:
-        claimName: %DOMAIN_PVC_NAME%
-    volumeMounts:
-    - mountPath: %DOMAIN_ROOT_DIR%
-      name: weblogic-domain-storage-volume
+    %LOG_HOME_ON_PV_PREFIX%volumes:
+    %LOG_HOME_ON_PV_PREFIX%- name: weblogic-domain-storage-volume
+    %LOG_HOME_ON_PV_PREFIX%  persistentVolumeClaim:
+    %LOG_HOME_ON_PV_PREFIX%    claimName: %DOMAIN_PVC_NAME%
+    %LOG_HOME_ON_PV_PREFIX%volumeMounts:
+    %LOG_HOME_ON_PV_PREFIX%- mountPath: %DOMAIN_ROOT_DIR%
+    %LOG_HOME_ON_PV_PREFIX%  name: weblogic-domain-storage-volume
   # adminServer is used to configure the desired behavior for starting the administration server.
   adminServer:
     # serverStartState legal values are "RUNNING" or "ADMIN"

kubernetes/samples/scripts/common/utility.sh

@@ -212,6 +212,210 @@ function getKubernetesClusterIP {
   K8S_IP="${array[1]}"
 }
 
+#
+# Function to generate the properties and yaml files for creating a domain
+#
+function createFiles {
+
+  # Make sure the output directory has a copy of the inputs file.
+  # The user can either pre-create the output directory, put the inputs
+  # file there, and create the domain from it, or the user can put the
+  # inputs file some place else and let this script create the output directory
+  # (if needed) and copy the inputs file there.
+  copyInputsFileToOutputDirectory ${valuesInputFile} "${domainOutputDir}/create-domain-inputs.yaml"
+
+  if [ "${domainHomeInImage}" == "true" ]; then
+    if [ -z "${domainHomeImageBase}" ]; then
+      fail "Please specify domainHomeImageBase in your input YAML"
+    fi
+  else
+    if [ -z "${image}" ]; then
+      fail "Please specify image in your input YAML"
+    fi
+  fi
+
+  dcrOutput="${domainOutputDir}/domain.yaml"
+
+  domainName=${domainUID}
+
+  enabledPrefix=""     # uncomment the feature
+  disabledPrefix="# "  # comment out the feature
+
+  if [ "${exposeAdminT3Channel}" = true ]; then
+    exposeAdminT3ChannelPrefix="${enabledPrefix}"
+  else
+    exposeAdminT3ChannelPrefix="${disabledPrefix}"
+  fi
+
+  if [ "${exposeAdminNodePort}" = true ]; then
+    exposeAdminNodePortPrefix="${enabledPrefix}"
+  else
+    exposeAdminNodePortPrefix="${disabledPrefix}"
+  fi
+
+  # For some parameters, use the default value if not defined.
+  if [ -z "${domainPVMountPath}" ]; then
+    domainPVMountPath="/shared"
+  fi
+
+  if [ -z "${logHome}" ]; then
+    logHome="${domainPVMountPath}/logs/${domainUID}"
+  fi
+
+  if [ -z "${persistentVolumeClaimName}" ]; then
+    persistentVolumeClaimName="${domainUID}-weblogic-sample-pvc"
+  fi
+
+  if [ -z "${weblogicCredentialsSecretName}" ]; then
+    weblogicCredentialsSecretName="${domainUID}-weblogic-credentials"
+  fi
+
+  if [ "${domainHomeInImage}" == "true" ]; then
+    domainPropertiesOutput="${domainOutputDir}/domain.properties"
+    domainHome="/u01/oracle/user_projects/domains/${domainName}"
+
+    # Generate the properties file that will be used when creating the weblogic domain
+    echo Generating ${domainPropertiesOutput}
+
+    cp ${domainPropertiesInput} ${domainPropertiesOutput}
+    sed -i -e "s:%DOMAIN_NAME%:${domainName}:g" ${domainPropertiesOutput}
+    sed -i -e "s:%ADMIN_PORT%:${adminPort}:g" ${domainPropertiesOutput}
+    sed -i -e "s:%ADMIN_SERVER_NAME%:${adminServerName}:g" ${domainPropertiesOutput}
+    sed -i -e "s:%MANAGED_SERVER_PORT%:${managedServerPort}:g" ${domainPropertiesOutput}
+    sed -i -e "s:%MANAGED_SERVER_NAME_BASE%:${managedServerNameBase}:g" ${domainPropertiesOutput}
+    sed -i -e "s:%CONFIGURED_MANAGED_SERVER_COUNT%:${configuredManagedServerCount}:g" ${domainPropertiesOutput}
+    sed -i -e "s:%CLUSTER_NAME%:${clusterName}:g" ${domainPropertiesOutput}
+    sed -i -e "s:%PRODUCTION_MODE_ENABLED%:${productionModeEnabled}:g" ${domainPropertiesOutput}
+    sed -i -e "s:%CLUSTER_TYPE%:${clusterType}:g" ${domainPropertiesOutput}
+    sed -i -e "s:%JAVA_OPTIONS%:${javaOptions}:g" ${domainPropertiesOutput}
+    sed -i -e "s:%T3_CHANNEL_PORT%:${t3ChannelPort}:g" ${domainPropertiesOutput}
+    sed -i -e "s:%T3_PUBLIC_ADDRESS%:${t3PublicAddress}:g" ${domainPropertiesOutput}
+
+  else
+
+    createJobOutput="${domainOutputDir}/create-domain-job.yaml"
+    deleteJobOutput="${domainOutputDir}/delete-domain-job.yaml"
+
+    if [ -z "${domainHome}" ]; then
+      domainHome="${domainPVMountPath}/domains/${domainUID}"
+    fi
+
+    # Use the default value if not defined.
+    if [ -z "${createDomainScriptsMountPath}" ]; then
+      createDomainScriptsMountPath="/u01/weblogic"
+    fi
+
+    if [ -z "${createDomainScriptName}" ]; then
+      createDomainScriptName="create-domain-job.sh"
+    fi
+
+    # Must escape the ':' value in image for sed to properly parse and replace
+    image=$(echo ${image} | sed -e "s/\:/\\\:/g")
+
+    # Generate the yaml to create the kubernetes job that will create the weblogic domain
+    echo Generating ${createJobOutput}
+
+    cp ${createJobInput} ${createJobOutput}
+    sed -i -e "s:%NAMESPACE%:$namespace:g" ${createJobOutput}
+    sed -i -e "s:%WEBLOGIC_CREDENTIALS_SECRET_NAME%:${weblogicCredentialsSecretName}:g" ${createJobOutput}
+    sed -i -e "s:%WEBLOGIC_IMAGE%:${image}:g" ${createJobOutput}
+    sed -i -e "s:%WEBLOGIC_IMAGE_PULL_POLICY%:${imagePullPolicy}:g" ${createJobOutput}
+    sed -i -e "s:%WEBLOGIC_IMAGE_PULL_SECRET_NAME%:${imagePullSecretName}:g" ${createJobOutput}
+    sed -i -e "s:%WEBLOGIC_IMAGE_PULL_SECRET_PREFIX%:${imagePullSecretPrefix}:g" ${createJobOutput}
+    sed -i -e "s:%DOMAIN_UID%:${domainUID}:g" ${createJobOutput}
+    sed -i -e "s:%DOMAIN_NAME%:${domainName}:g" ${createJobOutput}
+    sed -i -e "s:%DOMAIN_HOME%:${domainHome}:g" ${createJobOutput}
+    sed -i -e "s:%PRODUCTION_MODE_ENABLED%:${productionModeEnabled}:g" ${createJobOutput}
+    sed -i -e "s:%ADMIN_SERVER_NAME%:${adminServerName}:g" ${createJobOutput}
+    sed -i -e "s:%ADMIN_SERVER_NAME_SVC%:${adminServerNameSVC}:g" ${createJobOutput}
+    sed -i -e "s:%ADMIN_PORT%:${adminPort}:g" ${createJobOutput}
+    sed -i -e "s:%CONFIGURED_MANAGED_SERVER_COUNT%:${configuredManagedServerCount}:g" ${createJobOutput}
+    sed -i -e "s:%MANAGED_SERVER_NAME_BASE%:${managedServerNameBase}:g" ${createJobOutput}
+    sed -i -e "s:%MANAGED_SERVER_NAME_BASE_SVC%:${managedServerNameBaseSVC}:g" ${createJobOutput}
+    sed -i -e "s:%MANAGED_SERVER_PORT%:${managedServerPort}:g" ${createJobOutput}
+    sed -i -e "s:%T3_CHANNEL_PORT%:${t3ChannelPort}:g" ${createJobOutput}
+    sed -i -e "s:%T3_PUBLIC_ADDRESS%:${t3PublicAddress}:g" ${createJobOutput}
+    sed -i -e "s:%CLUSTER_NAME%:${clusterName}:g" ${createJobOutput}
+    sed -i -e "s:%CLUSTER_TYPE%:${clusterType}:g" ${createJobOutput}
+    sed -i -e "s:%DOMAIN_PVC_NAME%:${persistentVolumeClaimName}:g" ${createJobOutput}
+    sed -i -e "s:%DOMAIN_ROOT_DIR%:${domainPVMountPath}:g" ${createJobOutput}
+    sed -i -e "s:%CREATE_DOMAIN_SCRIPT_DIR%:${createDomainScriptsMountPath}:g" ${createJobOutput}
+    sed -i -e "s:%CREATE_DOMAIN_SCRIPT%:${createDomainScriptName}:g" ${createJobOutput}
+
+    # Generate the yaml to create the kubernetes job that will delete the weblogic domain_home folder
+    echo Generating ${deleteJobOutput}
+
+    cp ${deleteJobInput} ${deleteJobOutput}
+    sed -i -e "s:%NAMESPACE%:$namespace:g" ${deleteJobOutput}
+    sed -i -e "s:%WEBLOGIC_IMAGE%:${image}:g" ${deleteJobOutput}
+    sed -i -e "s:%WEBLOGIC_IMAGE_PULL_POLICY%:${imagePullPolicy}:g" ${deleteJobOutput}
+    sed -i -e "s:%WEBLOGIC_CREDENTIALS_SECRET_NAME%:${weblogicCredentialsSecretName}:g" ${deleteJobOutput}
+    sed -i -e "s:%WEBLOGIC_IMAGE_PULL_SECRET_NAME%:${imagePullSecretName}:g" ${deleteJobOutput}
+    sed -i -e "s:%WEBLOGIC_IMAGE_PULL_SECRET_PREFIX%:${imagePullSecretPrefix}:g" ${deleteJobOutput}
+    sed -i -e "s:%DOMAIN_UID%:${domainUID}:g" ${deleteJobOutput}
+    sed -i -e "s:%DOMAIN_NAME%:${domainName}:g" ${deleteJobOutput}
+    sed -i -e "s:%DOMAIN_HOME%:${domainHome}:g" ${deleteJobOutput}
+    sed -i -e "s:%DOMAIN_PVC_NAME%:${persistentVolumeClaimName}:g" ${deleteJobOutput}
+    sed -i -e "s:%DOMAIN_ROOT_DIR%:${domainPVMountPath}:g" ${deleteJobOutput}
+  fi
+
+  if [ "${domainHomeInImage}" == "true" ]; then
+    if [ "${logHomeOnPV}" == "true" ]; then
+      logHomeOnPVPrefix="${enabledPrefix}"
+    else
+      logHomeOnPVPrefix="${disabledPrefix}"
+    fi
+  else
+    logHomeOnPVPrefix="${enabledPrefix}"
+    logHomeOnPV=true
+  fi
+
+  # Generate the yaml file for creating the domain resource
+  echo Generating ${dcrOutput}
+
+  cp ${dcrInput} ${dcrOutput}
+  sed -i -e "s:%DOMAIN_UID%:${domainUID}:g" ${dcrOutput}
+  sed -i -e "s:%NAMESPACE%:$namespace:g" ${dcrOutput}
+  sed -i -e "s:%DOMAIN_HOME%:${domainHome}:g" ${dcrOutput}
+  sed -i -e "s:%DOMAIN_HOME_IN_IMAGE%:${domainHomeInImage}:g" ${dcrOutput}
+  sed -i -e "s:%WEBLOGIC_IMAGE_PULL_POLICY%:${imagePullPolicy}:g" ${dcrOutput}
+  sed -i -e "s:%WEBLOGIC_IMAGE_PULL_SECRET_PREFIX%:${imagePullSecretPrefix}:g" ${dcrOutput}
+  sed -i -e "s:%WEBLOGIC_IMAGE_PULL_SECRET_NAME%:${imagePullSecretName}:g" ${dcrOutput}
+  sed -i -e "s:%WEBLOGIC_CREDENTIALS_SECRET_NAME%:${weblogicCredentialsSecretName}:g" ${dcrOutput}
+  sed -i -e "s:%INCLUDE_SERVER_OUT_IN_POD_LOG%:${includeServerOutInPodLog}:g" ${dcrOutput}
+  sed -i -e "s:%LOG_HOME_ON_PV_PREFIX%:${logHomeOnPVPrefix}:g" ${dcrOutput}
+  sed -i -e "s:%LOG_HOME_ENABLED%:${logHomeOnPV}:g" ${dcrOutput}
+  sed -i -e "s:%LOG_HOME%:${logHome}:g" ${dcrOutput}
+  sed -i -e "s:%SERVER_START_POLICY%:${serverStartPolicy}:g" ${dcrOutput}
+  sed -i -e "s:%JAVA_OPTIONS%:${javaOptions}:g" ${dcrOutput}
+  sed -i -e "s:%DOMAIN_PVC_NAME%:${persistentVolumeClaimName}:g" ${dcrOutput}
+  sed -i -e "s:%DOMAIN_ROOT_DIR%:${domainPVMountPath}:g" ${dcrOutput}
+  sed -i -e "s:%EXPOSE_ADMIN_PORT_PREFIX%:${exposeAdminNodePortPrefix}:g" ${dcrOutput}
+  sed -i -e "s:%ADMIN_NODE_PORT%:${adminNodePort}:g" ${dcrOutput}
+  sed -i -e "s:%EXPOSE_T3_CHANNEL_PREFIX%:${exposeAdminT3ChannelPrefix}:g" ${dcrOutput}
+  sed -i -e "s:%CLUSTER_NAME%:${clusterName}:g" ${dcrOutput}
+  sed -i -e "s:%INITIAL_MANAGED_SERVER_REPLICAS%:${initialManagedServerReplicas}:g" ${dcrOutput}
+
+  if [ "${domainHomeInImage}" == "true" ]; then
+    if [ -z $domainHomeImageBuildPath ]; then
+      domainHomeImageBuildPath="./docker-images/OracleWebLogic/samples/12213-domain-home-in-image-wdt"
+    fi
+    imageName="`basename ${domainHomeImageBuildPath} | sed 's/^[0-9]*-//'`"
+
+    # now we know which image to use, update the domain yaml file
+    if [ -z $image ]; then
+      sed -i -e "s|%WEBLOGIC_IMAGE%|${imageName}|g" ${dcrOutput}
+    else
+      sed -i -e "s:%WEBLOGIC_IMAGE%:${image}:g" ${dcrOutput}
+    fi
+  else
+    sed -i -e "s:%WEBLOGIC_IMAGE%:${image}:g" ${dcrOutput}
+  fi
+
+  # Remove any "...yaml-e" files left over from running sed
+  rm -f ${domainOutputDir}/*.yaml-e
+}
+
 #
 # Function to create the domain recource
 #
@@ -231,8 +435,19 @@ function createDomainResource {
 
 #
 # Function to create a domain
+# $1 - boolean value indicating the location of the domain home
+#      true means domain home in image
+#      false means domain home on PV
 #
 function createDomain {
+  if [ "$#" != 1 ]; then
+    fail "The function must be called with domainHomeInImage parameter."
+  fi
+
+  domainHomeInImage="${1}"
+  if [ "true" != "${domainHomeInImage}" ] && [ "false" != "${domainHomeInImage}" ]; then
+    fail "The value of domainHomeInImage must be true or false: ${domainHomeInImage}"
+  fi
 
   # Setup the environment for running this script and perform initial validation checks
   initialize

kubernetes/samples/scripts/common/validate.sh

@@ -395,3 +395,15 @@ function validateCommonInputs {
   failIfValidationErrors
 }
 
+#
+# Function to validate the domain's persistent volume claim has been created
+#
+function validateDomainPVC {
+  # Check if the persistent volume claim is already available
+  checkPvcExists ${persistentVolumeClaimName} ${namespace}
+  if [ "${PVC_EXISTS}" = "false" ]; then
+    validationError "The domain persistent volume claim ${persistentVolumeClaimName} does not exist in namespace ${namespace}"
+  fi
+  failIfValidationErrors
+}
+

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

@@ -1,14 +1,17 @@
 # WebLogic sample domain home in Docker image
 
-The sample scripts demonstrate the creation of a WebLogic domain home in a Docker image. The scripts also generate the domain YAML file, which can then be used to start the Kubernetes artifacts of the corresponding domain. Optionally, the scripts start up the domain, and WebLogic Server pods and services.
+The sample scripts demonstrate the creation of a WebLogic domain home in a Docker image. If logHomeOnPV is enabled, then the log home resides on an existing Kubernetes persistent volume (PV) and persistent volume claim (PVC). The scripts also generate the domain YAML file, which can then be used to start the Kubernetes artifacts of the corresponding domain. Optionally, the scripts start up the domain, and WebLogic Server pods and services.
 
 ## Prerequisites
 
+Before you begin, read this guide, [Domain Resource](../../../../../site/domain-resource.md)
+
 The following prerequisites must be handled prior to running the create domain script:
 * The WDT sample requires that JAVA_HOME is set to a java JDK version 1.8 or greater
 * Make sure the WebLogic operator is running.
 * The operator requires WebLogic Server 12.2.1.3.0 with patch 28076014 applied. Refer to [Weblogic Docker images](../../../../../site/weblogic-docker-images.md) for details on how to create one. If a different `domainHomeImageBase` (see Configuration table below) is specified, the specified image needs to be built locally or pulled from a repository.
 * Create a Kubernetes namespace for the domain unless the intention is to use the default namespace.
+* If logHomeOnPV is enabled, create the Kubernetes persistent volume where the log home will be hosted, and the Kubernetes persistent volume claim for the domain in the same Kubernates namespace. For samples to create a PV and PVC, see [Create sample PV and PVC](../../create-weblogic-domain-pv-pvc/README.md).
 * Create the Kubernetes secrets `username` and `password` of the admin account in the same Kubernetes namespace as the domain.
 
 ## Use the script to create a domain
@@ -50,6 +53,7 @@ usage: create-domain.sh -o dir -i file -u username -p password [-k] [-e] [-h]
   -u Username used in building the Docker image for WebLogic domain in image.
   -p Password used in building the Docker image for WebLogic domain in image.
   -e Also create the resources in the generated YAML files, optional.
+  -v Validate the existence of persistentVolumeClaim, optional.
   -k Keep what has been previously cloned from https://github.com/oracle/docker-images.git, optional.
      If not specified, this script will always remove existing project and clone again.
   -h Help
@@ -91,6 +95,7 @@ The following parameters can be provided in the inputs file.
 | `configuredManagedServerCount` | Number of Managed Server instances to generate for the domain. | `5` |
 | `domainHomeImageBase` | Base WebLogic binary image used to build the WebLogic domain image. The operator requires WebLogic Server 12.2.1.3.0 with patch 28076014 applied. Refer to [Weblogic Docker images](../../../../../site/weblogic-docker-images.md) for details on how to create one. If a different `domainHomeImageBase` (see Configuration table below) is specified, the specified image needs to be built locally or pulled from a repository before the `create-domain.sh` script is executed. | |
 | `domainHomeImageBuildPath` | Location of the WebLogic "domain home in image" Docker image in `https://github.com/oracle/docker-images.git` project. If not specified, use "./docker-images/OracleWebLogic/samples/12213-domain-home-in-image-wdt". Another possible value is "./docker-images/OracleWebLogic/samples/12213-domain-home-in-image" which uses WLST scripts, instead of WDT, to generate the domain configuration. | `./docker-images/OracleWebLogic/samples/12213-domain-home-in-image-wdt` |
+| `domainPVMountPath` | Mount path of the domain persistent volume. | `/shared` |
 | `domainUID` | Unique ID that will be used to identify this particular domain. Used as the name of the generated WebLogic domain as well as the name of the Kubernetes domain resource. This ID must be unique across all domains in a Kubernetes cluster. This ID cannot contain any character that is not valid in a Kubernetes service name. | `domain1` |
 | `exposeAdminNodePort` | Boolean indicating if the Administration Server is exposed outside of the Kubernetes cluster. | `false` |
 | `exposeAdminT3Channel` | Boolean indicating if the T3 administrative channel is exposed outside the Kubernetes cluster. | `false` |
@@ -100,9 +105,12 @@ The following parameters can be provided in the inputs file.
 | `includeServerOutInPodLog` | Boolean indicating whether to include server .out to the pod's stdout. | `true` |
 | `initialManagedServerReplicas` | Number of Managed Servers to initially start for the domain. | `2` |
 | `javaOptions` | Java options for starting the Administration and Managed Servers. A Java option can have references to one or more of the following pre-defined variables to obtain WebLogic domain information: `$(DOMAIN_NAME)`, `$(DOMAIN_HOME)`, `$(ADMIN_NAME)`, `$(ADMIN_PORT)`, and `$(SERVER_NAME)`. | `-Dweblogic.StdoutDebugEnabled=false` |
+| `logHomeOnPV` | Specifies whether the log home is stored on the persistent volume. | `false` |
+| `logHome` | The in-pod name of the directory to store the domain, node manager, server logs, and server .out files in. If not specified, the value is derived from the `domainUID` as `/shared/logs/<domainUID>`. | `/shared/logs/domain1` |
 | `managedServerNameBase` | Base string used to generate Managed Server names. | `managed-server` |
 | `managedServerPort` | Port number for each Managed Server. | `8001` |
 | `namespace` | Kubernetes namespace in which to create the domain. | `default` |
+| `persistentVolumeClaimName` | Name of the persistent volume claim. If not specified, the value is derived from the `domainUID` as `<domainUID>-weblogic-sample-pvc` | `domain1-weblogic-sample-pvc` |
 | `productionModeEnabled` | Boolean indicating if production mode is enabled for the domain. | `true` |
 | `serverStartPolicy` | Determines which WebLogic Servers will be started up. Legal values are `NEVER`, `IF_NEEDED`, `ADMIN_ONLY`. | `IF_NEEDED` |
 | `t3ChannelPort` | Port for the T3 channel of the NetworkAccessPoint. | `30012` |