Change domain-home-in-image inputs property names and fix changes to required image property

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

Author: doxiao

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

@@ -6,10 +6,9 @@ The sample scripts demonstrate the creation of a WebLogic domain home in a Docke
 
 The following prerequisites must be handled prior to running the create domain script:
 * 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.
+* 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.
 * Create the Kubernetes secrets `username` and `password` of the admin account in the same Kubernetes namespace as the domain.
-* Build the Oracle WebLogic image `oracle/weblogic:12.2.1.3-developer`. Refer to [Oracle WebLogic Server on Docker](https://github.com/oracle/docker-images/tree/master/OracleWebLogic/dockerfiles/12.2.1.3). If a different `baseImage` (see Configuration table below) is specified, the specified image needs to be built locally or pulled from a repository.
 
 ## Use the script to create a domain
 
@@ -71,15 +70,15 @@ The following parameters can be provided in the inputs file.
 | `adminPort` | Port number for the Administration Server inside the Kubernetes cluster. | `7001` |
 | `adminNodePort` | Port number of the Administration Server outside the Kubernetes cluster. | `30701` |
 | `adminServerName` | Name of the Administration Server. | `admin-server` |
-| `baseImage` | The image that is used to build the domain-home-in-image Docker image. If not specified, use the built-in base image `oracle/weblogic:12.2.1.3-developer`. The image specified here needs to be built locally or pulled from a repository before the `create-domain.sh` script is executed. | `oracle/weblogic:12.2.1.3-developer` |
 | `clusterName` | Name of the WebLogic cluster instance to generate for the domain. | `cluster-1` |
 | `clusterType` | Type of the WebLogic Cluster. Legal values are `CONFIGURED` or `DYNAMIC`. | `DYNAMIC` |
 | `configuredManagedServerCount` | Number of Managed Server instances to generate for the domain. | `2` |
+| `domainHomeImageBase` | 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" whichuses WLST script, instead of WDT, to generate the domain configuration. | `./docker-images/OracleWebLogic/samples/12213-domain-home-in-image-wdt` |
 | `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` |
-| `image` | WebLogic Docker image that the domain resource will use. If not specified, the value is the name of the generated Docker image. | `12213-domain-home-in-image-wdt` |
-| `imagePath` | The relative directory of the WebLogic domain home in image Docker image in `https://github.com/oracle/docker-images.git` project under the `docker-images/OracleWebLogic/samples` directory.  | `12213-domain-home-in-image-wdt` |
+| `image` | WebLogic Docker image that the domain resource will pull if needed. You only need to specify this if you are going to push the generated image from the local Docker repository to another Docker repository. If not specified, will use the internally generated image name, say "domain-home-in-image-wlst:latest" or "domain-home-in-image-wdt:latest". | |
 | `imagePullPolicy` | WebLogic Docker image pull policy. Legal values are "IfNotPresent", "Always", or "Never" | `IfNotPresent` |
 | `imagePullSecretName` | Name of the Kubernetes secret to access the Docker Store to pull the WebLogic Server Docker image. The presence of the secret will be validated when this parameter is specified |  |
 | `includeServerOutInPodLog` | Boolean indicating whether to include server .out to the pod's stdout. | `true` |

kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image/create-domain-inputs.yaml

@@ -40,9 +40,12 @@ managedServerPort: 8001
 # Boolean indicating if production mode is enabled for the domain
 productionModeEnabled: true
 
-# WebLogic Docker image.
-# The operator requires WebLogic Server 12.2.1.3.0 with patch 28076014 applied. See README.md for more help.
-#image:
+# WebLogic Docker image that the domain resource will pull if needed.
+# You only need to specify this if you are going to push the generated image from the local Docker repository
+# to another Docker repository.
+# If not specified, will use the internally generated image name, say "domain-home-in-image-wlst:latest"
+# or "domain-home-in-image-wdt:latest".
+# image: 
 
 # Image pull policy
 # Legal values are "IfNotPresent", "Always", or "Never"
@@ -85,14 +88,14 @@ namespace: default
 # Java Option for Weblogic Server
 javaOptions: -Dweblogic.StdoutDebugEnabled=false
 
-# Base image used to build the domain home in image Docker image
-# If not specified, use the built-in base image oracle/weblogic:12.2.1.3-developer
-baseImage: oracle/weblogic:12.2.1.3-developer
-
-# The relative directory of the WebLogic domain home in image Docker image in the i
-# `https://github.com/oracle/docker-images.git` project under the `docker-images/OracleWebLogic/samples` directory.
-# If not specified, use 12213-domain-home-in-image-wdt. 
-# Another possible value is 12213-domain-home-in-image which uses WLST script instead of WDT to 
-# generate the domain home.
-imagePath: 12213-domain-home-in-image-wdt
+# WebLogic binary image used to build the WebLogic domain image
+# The operator requires WebLogic Server 12.2.1.3.0 with patch 28076014 applied. See README.md for more help.
+# domainHomeImageBase: 
+
+# Location of the WebLogic "domain home in image" Docker image sample in the 
+# `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 script, instead of WDT, to generate the domain configuration.
+domainHomeImageBuildPath: ./docker-images/OracleWebLogic/samples/12213-domain-home-in-image-wdt
 

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

@@ -174,8 +174,8 @@ function createFiles {
   enabledPrefix=""     # uncomment the feature
   disabledPrefix="# "  # comment out the feature
 
-  if [ -z "${image}" ]; then
-    fail "Please specify image in your input YAML"
+  if [ -z "${domainHomeImageBase}" ]; then
+    fail "Please specify domainHomeImageBase in your input YAML"
   fi
 
   domainName=${domainUID}
@@ -238,11 +238,13 @@ function createFiles {
   sed -i -e "s:%WEBLOGIC_IMAGE_PULL_POLICY%:${imagePullPolicy}:g" ${dcrOutput}
   sed -i -e "s:%WEBLOGIC_IMAGE_PULL_SECRET_NAME%:${imagePullSecretName}:g" ${dcrOutput}
   sed -i -e "s:%WEBLOGIC_IMAGE_PULL_SECRET_PREFIX%:${imagePullSecretPrefix}:g" ${dcrOutput}
- 
-  if [ -z $imagePath ]; then
-    imagePath="12213-domain-home-in-image-wdt"
+
+  domainHomeImageBuildPathDefault="./docker-images/OracleWebLogic/samples/docker-images/OracleWebLogic/samples/12213-domain-home-in-image-wdt"
+  if [ -z $domainHomeImageBuildPath ]; then
+    domainHomeImageBuildPath=${domainHomeImageBuildPathDefault}
   fi
-  imageName="${imagePath}:latest"
+
+  imageName="`basename ${domainHomeImageBuildPath} | sed 's/^[0-9]*-//'`"
 
   # now we know which image to use, update the domain yaml file
   if [ -z $image ]; then
@@ -259,7 +261,7 @@ function createFiles {
 # Function to build docker image and create WebLogic domain home
 #
 function createDomainHome {
-  dockerDir=${scriptDir}/docker-images/OracleWebLogic/samples/${imagePath}
+  dockerDir=${scriptDir}/${domainHomeImageBuildPath}
   dockerPropsDir=${dockerDir}/properties
   cp ${domainPropertiesOutput} ${dockerPropsDir}/docker-build
 
@@ -276,11 +278,17 @@ function createDomainHome {
   sed -i -e "s|myuser|${username}|g" $usernameFile
   sed -i -e "s|mypassword1|${password}|g" $passwordFile
 
-  if [ ! -z $baseImage ]; then
-    sed -i -e "s|\(FROM \).*|\1 ${baseImage}|g" ${dockerDir}/Dockerfile
+  if [ ! -z $domainHomeImageBase ]; then
+    sed -i -e "s|\(FROM \).*|\1 ${domainHomeImageBase}|g" ${dockerDir}/Dockerfile
   fi
 
   sh ${dockerDir}/build.sh
+  imageNameOrigin="`basename ${domainHomeImageBuildPath}`"
+
+  # if use the default images, we tag it to a more generic name (without the release version numbers)
+  if [ -z $image ]; then
+    docker tag $imageNameOrigin:latest $imageName:latest
+  fi
 
   if [ "$?" != "0" ]; then
     fail "Create domain ${domainName} failed."

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

@@ -8,7 +8,7 @@ Before you begin, read this guide, [Domain Resource](../../../../../site/domain-
 
 The following prerequisites must be handled prior to running the create domain script:
 * 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.
+* 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.
 * Create a Kubernetes namespace for the domain unless the intention is to use the default namespace.
 * In the same Kubernetes namespace, create the Kubernetes persistent volume where the domain home will be hosted, and the Kubernetes persistent volume claim for the domain. 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.
@@ -83,7 +83,7 @@ The following parameters can be provided in the inputs file.
 | `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` |
-| `image` | WebLogic Docker image. | `store/oracle/weblogic:12.2.1.3` |
+| `image` | WebLogic Docker 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. | |
 | `imagePullPolicy` | WebLogic Docker image pull policy. Legal values are "IfNotPresent", "Always", or "Never" | `IfNotPresent` |
 | `imagePullSecretName` | Name of the Kubernetes secret to access the Docker Store to pull the WebLogic Server Docker image. The presence of the secret will be validated when this parameter is specified |  |
 | `includeServerOutInPodLog` | Boolean indicating whether to include server .out to the pod's stdout. | `true` |