Added modelHome variable for Verrazzano/WKO templates (#241)

ddsharpe · web-flow · commit 745b73c8a4e0 · 2021-02-10T14:46:48.000-06:00
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cachestore/OPatchFile.java
@@ -36,6 +36,7 @@ public class OPatchFile extends PatchFile {
     public static OPatchFile getInstance(String patchId, String userid, String password, CacheStore cache)
         throws AruException, XPathExpressionException, IOException {
 
+        logger.entering(patchId);
         String patchNumber = patchId;
         String providedVersion = null;
         if (patchId == null) {
@@ -46,13 +47,16 @@ public static OPatchFile getInstance(String patchId, String userid, String passw
             int separator = patchId.indexOf(CacheStore.CACHE_KEY_SEPARATOR);
             patchNumber = patchId.substring(0, separator);
             providedVersion = patchId.substring(separator + 1);
+            logger.fine("User provided OPatch version {0} {1}", patchNumber, providedVersion);
         }
 
         List<AruPatch> patches = AruUtil.rest().getPatches(patchNumber, userid, password);
         if (!isOffline(userid, password)) {
             // if working online with ARU metadata, filter results based on availability and ARU recommendation
             Stream<AruPatch> filteredList = patches.stream().filter(AruPatch::isOpenAccess);
             if (providedVersion == null) {
+                // When the user did not provide a specific version, try to reduce the patch list to one patch.
+                // There should only be ONE recommended patch/install for OPatch
                 filteredList = filteredList.filter(AruPatch::isRecommended);
             }
             patches = filteredList.collect(Collectors.toList());
@@ -65,6 +69,7 @@ public static OPatchFile getInstance(String patchId, String userid, String passw
             if (isOffline(userid, password) && providedVersion == null) {
                 selectedPatch.version(getLatestCachedVersion(cache, patchNumber));
             }
+            logger.exiting(selectedPatch);
             return new OPatchFile(selectedPatch, userid, password);
         } else {
             throw new MultiplePatchVersionsException(patchNumber, patches);
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/WdtOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/WdtOptions.java
@@ -134,6 +134,7 @@ public void handleResourceTemplates(String imageName) throws IOException {
         ResourceTemplateOptions options = new ResourceTemplateOptions()
             .domainHome(wdtDomainHome)
             .imageName(imageName)
+            .modelHome(wdtModelHome)
             .domainHomeSourceType(domainType);
 
         // resolve parameters in the list of mustache templates returned by gatherFiles()
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/ResourceTemplateOptions.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/ResourceTemplateOptions.java
@@ -9,6 +9,7 @@
 public class ResourceTemplateOptions {
     private String imageName;
     private String domainHome;
+    private String modelHome;
     private DomainHomeSourceType domainHomeSourceType = DomainHomeSourceType.PV;
 
 
@@ -17,6 +18,7 @@ public class ResourceTemplateOptions {
      *
      * @return image tag name
      */
+    @SuppressWarnings("unused")
     public String imageName() {
         return imageName;
     }
@@ -37,6 +39,7 @@ public ResourceTemplateOptions imageName(String value) {
      *
      * @return domain home value
      */
+    @SuppressWarnings("unused")
     public String domainHome() {
         return domainHome;
     }
@@ -60,6 +63,7 @@ public ResourceTemplateOptions domainHome(String value) {
      *
      * @return domain home source type
      */
+    @SuppressWarnings("unused")
     public String domainHomeSourceType() {
         return domainHomeSourceType.toString();
     }
@@ -74,4 +78,25 @@ public ResourceTemplateOptions domainHomeSourceType(DomainHomeSourceType value)
         domainHomeSourceType = value;
         return this;
     }
+
+    /**
+     * Return the model home passed in the --wdtModelHome argument or the default if not provided.
+     *
+     * @return the location where the models will be written in the image, for --modelOnly
+     */
+    @SuppressWarnings("unused")
+    public String modelHome() {
+        return modelHome;
+    }
+
+    /**
+     * Set the model home.
+     *
+     * @param value the model home from the --wdtModelHome argument
+     * @return builder/this
+     */
+    public ResourceTemplateOptions modelHome(String value) {
+        modelHome = value;
+        return this;
+    }
 }
diff --git a/site/create-image.md b/site/create-image.md
@@ -30,6 +30,7 @@ Usage: imagetool create [OPTIONS]
 | `--passwordFile` | Path to a file containing just the Oracle Support password, see `--user`.  |   |
 | `--patches` | Comma separated list of patch IDs. Example: `12345678,87654321`  |   |
 | `--pull` | Always attempt to pull a newer version of base images during the build.  |   |
+| `--resourceTemplates` | One or more files containing placeholders that need to be resolved by the Image Tool. See [Resource Template Files](#resource-template-files). |   |
 | `--strictPatchOrdering` |  Instruct OPatch to apply patches one at a time (uses `apply` instead of `napply`). |   |
 | `--tag` | (Required) Tag for the final build image. Example: `store/oracle/weblogic:12.2.1.3.0`  |   |
 | `--type` | Installer type. Supported values: `WLS`, `WLSDEV`, `WLSSLIM`, `FMW`, `IDM`, `OSB`, `OUD_WLS`, `SOA_OSB`, `WCP`, `OAM`, `OIG`, `OUD`, `SOA`, `WCC`, `WCS`, `WCP`  | `WLS`  |
@@ -99,6 +100,19 @@ installation or domain creation steps, use the `final-build-commands` section so
 final stage of the image build.  Or, if the file needs to change the Oracle Home prior to domain creation, use 
 the `after-fmw-install` or `before-wdt-command` sections.
 
+#### Resource Template Files
+
+If provided, the file or files provided with `--resourceTemplates` will be overwritten. For known tokens, 
+the placeholders will be replaced with values according to the following table.  **Note:** Placeholders must follow
+the Mustache syntax, like `{{imageName}}` or `{{{imageName}}}`.
+
+| Token Name | Value Description | 
+| --- | --- |
+| `domainHome` | The value provided to the Image Tool with `--wdtDomainHome`. |
+| `domainHomeSourceType` | `PersistentVolume` (default), `FromModel` if `--wdtModelOnly`, or `Image` if the domain is created in the image with WDT. |
+| `imageName` | The value provided to the Image Tool with `--tag`. |
+| `modelHome` | The value provided to the Image Tool with `--wdtModelHome`. |
+
 #### Use an argument file
 
 You can save all arguments passed for the Image Tool in a file, then use the file as a parameter.
diff --git a/site/update-image.md b/site/update-image.md
@@ -39,6 +39,7 @@ Update WebLogic Docker image with selected patches
 | `--passwordFile` | Path to a file containing just the Oracle Support password, see `--user`.  |   |
 | `--patches` | Comma separated list of patch IDs. Example: `12345678,87654321`  |   |
 | `--pull` | Always attempt to pull a newer version of base images during the build.  |   |
+| `--resourceTemplates` | One or more files containing placeholders that need to be resolved by the Image Tool. See [Resource Template Files](#resource-template-files). |   |
 | `--strictPatchOrdering` |  Instruct OPatch to apply patches one at a time (uses `apply` instead of `napply`). |   |
 | `--tag` | (Required) Tag for the final build image. Example: `store/oracle/weblogic:12.2.1.3.0`  |   |
 | `--user` | Oracle support email ID.  |   |
@@ -109,6 +110,19 @@ The `latestPSU` option will continue to be supported for the CREATE option, but
 UPDATE option.  Because of the number of patches and their size, using `latestPSU` as an update to an existing image can 
 increase the size of the image significantly, and is not recommended. 
 
+#### Resource Template Files
+
+If provided, the file or files provided with `--resourceTemplates` will be overwritten. For known tokens, 
+the placeholders will be replaced with values according to the following table.  **Note:** Placeholders must follow
+the Mustache syntax, like `{{imageName}}` or `{{{imageName}}}`.
+
+| Token Name | Value Description | 
+| --- | --- |
+| `domainHome` | The value provided to the Image Tool with `--wdtDomainHome`. |
+| `domainHomeSourceType` | `PersistentVolume` (default), `FromModel` if `--wdtModelOnly`, or `Image` if the domain is created in the image with WDT. |
+| `imageName` | The value provided to the Image Tool with `--tag`. |
+| `modelHome` | The value provided to the Image Tool with `--wdtModelHome`. |
+
 #### Use an argument file
 
 You can save all arguments passed for the Image Tool in a file, then use the file as a parameter.
