Tutorial (#13)

jshum2479 · web-flow · commit 1dda8385dbad · 2019-05-31T07:27:51.000-05:00
* Fix cli fails without any message when invalid command is specified and add quick start guide

* minor edits

* minor edits

* minor edits

* minor edits

* Remove extraneous system out

* added some notes on setting up cache store first

* spelling

* add env variable for docker build to override working dir

* update and add wdt case

* format changes

* update wdt download links

* change sample cache directories

* Add notes for final image installation and owner

* add comment for loging.properties

* update wdt use case

* rename WebLogic Deploying Tool to WebLogic Deploy Tool

* add parameter file section

* There are various fixes on this commit:

1. Add wdtDomainHome as build argument passing from imagetool
2. Remove unnecessary variable DOMAIN_NAME
3. Remove all start*.sh inherited from wls docker-images project

* minor text edit

* change multi layer build

* change to use force rm only.  Actually it doesn't matter, there are couple of dangling images left over.  Added instruction in quickstart showing how to clean it up.

* update addPatch command

* update addPatch with comment

* update documentation

* cleanup main README

* first edit after review

* minor doc edit and fix non wdt docker build
diff --git a/README.md b/README.md
@@ -29,30 +29,12 @@ The Image Tool provides three functions within the main script:
 
 - Build the project (`mvn clean package`), to create the ZIP installer in ./imagetool/target.
 - Unzip the release ZIP file to a desired location.
-- If running an OS with bash, run `cd your_unzipped_location/bin` and `source setup.sh`.
-- On Windows, set up with `imagetool.cmd` or the `imagetool.bat` script:
-    ```cmd
-    @ECHO OFF
-    java -cp "your_unzipped_folder/lib" com.oracle.weblogic.imagetool.cli.CLIDriver %*
-    ```
-
-## Help Command
-- After completing the [Setup](#Setup) steps, execute `imagetool help` to show the help screen.
-- You can execute the JAR directly using the command `java -cp "your_unzipped_folder/lib" com.oracle.weblogic.imagetool.cli.CLIDriver help`.
-
-## Simple Example
-Let's give this a try!  
-- Get the installers from Oracle e-Delivery.
-- Add those installers to the Image Tool file cache.
-- Assuming Docker is installed, run `imagetool create`!
-```bash
-unzip imagetool-0.1.zip
-cd imagetool-0.1/bin
-source setup.sh
-imagetool cache addInstaller --type jdk --version 8u202 --path /tmp/jdk-8u202-linux-x64.tar.gz
-imagetool cache addInstaller --type wls --version 12.2.1.3.0 --path /tmp/fmw_12.2.1.3.0_wls_Disk1_1of1.zip
-imagetool create --tag sample:wls
-```
+- `cd your_unzipped_location/bin` and `source setup.sh`.
+- Run `imagetool help` to show the help screen.
+
+## Quick Start
+
+[Image Tool Quick Start Guide](site/quickstart.md)
 
 ## Copyright
 Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved.
diff --git a/imagetool/src/main/bin/logging.properties b/imagetool/src/main/bin/logging.properties
@@ -1,7 +1,20 @@
+#
+#  This is a standard java util logging.properties, documentation can be found in
+#  https://docs.oracle.com/javase/8/docs/technotes/guides/logging/overview.html#a1.8
+#
+
+#
+# Default handler is console only, to enable file logging, switch out the comments below or customize your own
+#
 handlers=java.util.logging.ConsoleHandler
 #handlers=java.util.logging.FileHandler, java.util.logging.ConsoleHandler
 
-# Enable as needed
+#
+# Default level for everything is INFO, you can override the level in each logger or raise the default level for all
+# loggers.  Note: if you set .LEVEL=ALL,  it will enable everything from every loggers used by the tool including other
+# any packages used by the tool.
+#
+
 com.oracle.weblogic.imagetool.level=INFO
 #com.oracle.weblogic.imagetool.cli.menu.CreateImage.level = FINEST
 #com.oracle.weblogic.imagetool.cli.menu.UpdateImage.level = FINEST
@@ -13,7 +26,8 @@ com.oracle.weblogic.imagetool.level=INFO
 #com.oracle.weblogic.imagetool.util.Utils.level = FINEST
 
 #
-# Change log file location and handlers logging level as needed
+# Change log file location and handlers logging level as needed. Note the default level for FileHandler is OFF
+# and ConsoleHandler is INFO
 #
 java.util.logging.FileHandler.pattern=tool.log
 java.util.logging.FileHandler.count=1
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/WLSCommandLine.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/WLSCommandLine.java
@@ -34,10 +34,13 @@ public static <C extends Callable<T>, T> T call(C callable, PrintStream out, Pri
         cmd.setToggleBooleanFlags(false);
         cmd.setUnmatchedArgumentsAllowed(false);
         //cmd.registerConverter(CacheStore.class, x -> new CacheStoreFactory().getCacheStore(x));
-
         List<Object> results = cmd.parseWithHandlers(new CommandLine.RunLast().useOut(out).useAnsi(ansi),
                 new CommandLine.DefaultExceptionHandler<List<Object>>().useErr(err).useAnsi(ansi), args);
         @SuppressWarnings("unchecked") T result = results == null || results.isEmpty() ? null : (T) results.get(0);
+        if (result == null) {
+            CommandLine.usage(callable, System.out);
+           // System.exit(-1);
+        }
         return result;
     }
 }
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java
@@ -65,9 +65,7 @@ public CommandResponse call() throws Exception {
             }
 
             List<String> cmdBuilder = getInitialBuildCmd();
-            // create a tmp directory for user.
-            // using user home as base to avoid running out of space in tmp
-            tmpDir = Files.createTempDirectory(Paths.get(System.getProperty("user.home")),
+            tmpDir = Files.createTempDirectory(Paths.get(Utils.getBuildWorkingDir()),
                 "wlsimgbuilder_temp", PosixFilePermissions.asFileAttribute(PosixFilePermissions.fromString("rwxr-xr-x")));
             String tmpDirPath = tmpDir.toAbsolutePath().toString();
             logger.info("tmp directory used for build context: " + tmpDirPath);
@@ -82,9 +80,9 @@ public CommandResponse call() throws Exception {
                 cmdBuilder.add(Constants.BUILD_ARG);
                 cmdBuilder.add("BASE_IMAGE=" + fromImage);
 
-                tmpDir2 = Files.createTempDirectory(Paths.get(System.getProperty("user.home")),
+                tmpDir2 = Files.createTempDirectory(Paths.get(Utils.getBuildWorkingDir()),
                     "wlsimgbuilder_temp", PosixFilePermissions.asFileAttribute(PosixFilePermissions.fromString("rwxr-xr-x")));
-                logger.info("tmp directory in user.home for docker run: " + tmpDir2);
+                logger.info("tmp directory for docker run: " + tmpDir2);
 
                 Utils.copyResourceAsFile("/probe-env/test-create-env.sh",
                         tmpDir2.toAbsolutePath().toString() + File.separator + "test-env.sh", true);
@@ -221,6 +219,12 @@ private List<String> handleWDTArgsIfRequired(Path tmpDir) throws IOException {
                     retVal.add("WDT_ARCHIVE=" + tmpDir.relativize(targetLink).toString());
                 }
 
+                if (wdtDomainHome != null) {
+                    retVal.add(Constants.BUILD_ARG);
+                    retVal.add("DOMAIN_HOME=" + wdtDomainHome);
+                }
+
+
                 if (wdtVariablesPath != null && Files.isRegularFile(wdtVariablesPath)) {
                     targetLink = Files.copy(wdtVariablesPath, Paths.get(tmpDirPath,
                         wdtVariablesPath.getFileName().toString())
@@ -396,4 +400,14 @@ private void copyResponseFilesToDir(String dirPath) throws IOException {
             description = "whether to run rcu to create the required database schemas"
     )
     private boolean rcu_run_flag = false;
+
+
+    @Option(
+        names = {"--wdtDomainHome"},
+        description = "pass to the -domain_home for wdt",
+        defaultValue = "/u01/domains/base_domain"
+    )
+    private Path wdtDomainHome;
+
+
 }
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/ImageOperation.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/ImageOperation.java
@@ -139,7 +139,7 @@ List<String> getInitialBuildCmd() {
 
         logger.finer("Entering ImageOperation.getInitialBuildCmd");
         List<String> cmdBuilder = Stream.of("docker", "build",
-                "--force-rm", "--rm=true", "--no-cache").collect(Collectors.toList());
+                "--force-rm=true", "--no-cache").collect(Collectors.toList());
 
         cmdBuilder.add("--tag");
         cmdBuilder.add(imageTag);
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/UpdateImage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/UpdateImage.java
@@ -70,9 +70,9 @@ public CommandResponse call() throws Exception {
                 cmdBuilder.add("BASE_IMAGE=" + fromImage);
             }
 
-            tmpDir2 = Files.createTempDirectory(Paths.get(System.getProperty("user.home")), "wlsimgbuilder_temp",
+            tmpDir2 = Files.createTempDirectory(Paths.get(Utils.getBuildWorkingDir()), "wlsimgbuilder_temp",
                     PosixFilePermissions.asFileAttribute(PosixFilePermissions.fromString("rwxr-xr-x")));
-            logger.info("tmp directory in user.home for docker run: " + tmpDir2);
+            logger.info("tmp directory in for docker run: " + tmpDir2);
             Utils.copyResourceAsFile("/probe-env/test-update-env.sh",
                     tmpDir2.toAbsolutePath().toString() + File.separator + "test-env.sh", true);
 
@@ -131,7 +131,7 @@ public CommandResponse call() throws Exception {
             }
 
             // create a tmp directory for user.
-            tmpDir = Files.createTempDirectory(Paths.get(System.getProperty("user.home")), "wlsimgbuilder_temp",
+            tmpDir = Files.createTempDirectory(Paths.get(Utils.getBuildWorkingDir()), "wlsimgbuilder_temp",
                     PosixFilePermissions.asFileAttribute(PosixFilePermissions.fromString("rwxr-xr-x")));
             String tmpDirPath = tmpDir.toAbsolutePath().toString();
             Path tmpPatchesDir = Files.createDirectory(Paths.get(tmpDirPath, "patches"));
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java
@@ -17,6 +17,7 @@
 import java.io.PrintWriter;
 import java.net.URL;
 import java.nio.file.Files;
+import java.nio.file.LinkOption;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.nio.file.StandardCopyOption;
@@ -536,4 +537,33 @@ public static String getPasswordFromInputs(String passwordStr, Path passwordFile
         }
         return null;
     }
+
+    /**
+     * returns the working dir for docker build
+     * @return working directory
+     */
+    public static String getBuildWorkingDir() throws IOException {
+        String workingDir = System.getenv("WLSIMG_BLDDIR");
+        if (workingDir == null ) {
+            workingDir = System.getProperty("user.home");
+        }
+        Path path = Paths.get(workingDir);
+
+        boolean pathExists =
+            Files.exists(path,
+                new LinkOption[]{ LinkOption.NOFOLLOW_LINKS});
+
+        if (!pathExists) {
+            throw new IOException("Working Directory does not exists " + workingDir);
+        } else {
+            if (!Files.isDirectory(path)) {
+                throw new IOException("Working Directory specified is not a directory " + workingDir);
+            }
+            if (!Files.isWritable(path)) {
+                throw new IOException("Working Directory specified is not writable " + workingDir);
+            }
+        }
+
+        return workingDir;
+    }
 }
diff --git a/imagetool/src/main/resources/docker-files/Dockerfile.create b/imagetool/src/main/resources/docker-files/Dockerfile.create
@@ -77,8 +77,8 @@ FROM ${BASE_IMAGE} as FINAL_BUILD
 
 ARG JAVA_HOME=/u01/jdk
 ARG ORACLE_HOME=/u01/oracle
-ARG DOMAIN_NAME
 ARG DOMAIN_PARENT
+ARG DOMAIN_HOME
 ARG ADMIN_NAME
 ARG ADMIN_HOST
 ARG ADMIN_PORT
@@ -93,14 +93,13 @@ ENV ORACLE_HOME=${ORACLE_HOME} \
     MANAGED_SERVER_PORT=${MANAGED_SERVER_PORT:-8001} \
     WLSDEPLOY_PROPERTIES="-Djava.security.egd=file:/dev/./urandom" \
     DOMAIN_PARENT=${DOMAIN_PARENT:-/u01/domains} \
-    DOMAIN_NAME=${DOMAIN_NAME:-base_domain} \
     LC_ALL=${DEFAULT_LOCALE:-en_US.UTF-8} \
     PROPERTIES_FILE_DIR=$ORACLE_HOME/properties
 
 # DO NOT COMBINE THESE BLOCKS. It won't work when formatting variables like DOMAIN_HOME
-ENV DOMAIN_HOME=${DOMAIN_PARENT}/${DOMAIN_NAME} \
+ENV DOMAIN_HOME=${DOMAIN_HOME:-/u01/domains/base_domain} \
     PROPERTIES_FILE_DIR=$ORACLE_HOME/properties \
-    PATH=$PATH:${JAVA_HOME}/bin:${ORACLE_HOME}/oracle_common/common/bin:${ORACLE_HOME}/wlserver/common/bin:${DOMAIN_PARENT}/${DOMAIN_NAME}:${DOMAIN_PARENT}/${DOMAIN_NAME}/bin:${ORACLE_HOME}
+    PATH=$PATH:${JAVA_HOME}/bin:${ORACLE_HOME}/oracle_common/common/bin:${ORACLE_HOME}/wlserver/common/bin:${DOMAIN_HOME}/bin:${ORACLE_HOME}
 
 ## Create oracle user
 RUN if [ -z "$(getent group oracle)" ]; then hash groupadd &> /dev/null && groupadd -g 1000 oracle || exit -1 ; fi \
@@ -110,6 +109,7 @@ RUN if [ -z "$(getent group oracle)" ]; then hash groupadd &> /dev/null && group
 
 COPY --from=JDK_BUILD --chown=oracle:oracle $JAVA_HOME $JAVA_HOME/
 COPY --from=WLS_BUILD --chown=oracle:oracle $ORACLE_HOME $ORACLE_HOME/
+
 # PLACEHOLDER FOR %%WDT_COPY_DOMAIN%% #
 
 USER oracle
diff --git a/imagetool/src/main/resources/docker-files/Dockerfile.ph b/imagetool/src/main/resources/docker-files/Dockerfile.ph
@@ -13,7 +13,6 @@ ARG ORACLE_HOME=/u01/oracle
 ARG WDT_PKG
 ARG WDT_MODEL
 ARG DOMAIN_TYPE
-ARG DOMAIN_NAME
 ARG DOMAIN_PARENT
 ARG DOMAIN_HOME
 ARG WDT_ARCHIVE
@@ -26,7 +25,7 @@ ARG SCRIPTS_DIR
 ARG WDT_HOME
 ARG RCU_RUN_FLAG
 
-RUN echo ${WLS_PKG} ${JAVA_PKG} ${WDT_MODEL}
+#RUN echo ${WLS_PKG} ${JAVA_PKG} ${WDT_MODEL} ${OTMPDIR}
 
 ENV WDT_PKG=${WDT_PKG:-weblogic-deploy.zip} \
     ADMIN_NAME=${ADMIN_NAME:-admin-server} \
@@ -38,29 +37,27 @@ ENV WDT_PKG=${WDT_PKG:-weblogic-deploy.zip} \
     WLSDEPLOY_PROPERTIES="-Djava.security.egd=file:/dev/./urandom" \
     DOMAIN_TYPE=${DOMAIN_TYPE:-WLS} \
     DOMAIN_PARENT=${DOMAIN_PARENT:-/u01/domains} \
-    DOMAIN_NAME=${DOMAIN_NAME:-base_domain} \
     WDT_ARCHIVE=${WDT_ARCHIVE:-} \
     WDT_VARIABLE=${WDT_VARIABLE:-} \
     LC_ALL=${DEFAULT_LOCALE:-en_US.UTF-8} \
     PROPERTIES_FILE_DIR=$ORACLE_HOME/properties \
     WDT_HOME=${WDT_HOME:-/u01/app/weblogic-deploy} \
     SCRIPTS_DIR=${SCRIPTS_DIR:-scripts} \
+    OTMPDIR=${OTMPDIR:-/tmp/delme} \
     RCU_RUN_FLAG=${RCU_RUN_FLAG:-}
 
 # DO NOT COMBINE THESE BLOCKS. It won't work when formatting variables like DOMAIN_HOME
-ENV DOMAIN_HOME=${DOMAIN_PARENT}/${DOMAIN_NAME} \
-    SCRIPT_HOME=${DOMAIN_PARENT}/${DOMAIN_NAME} \
-    PATH=$PATH:${JAVA_HOME}/bin:${ORACLE_HOME}/oracle_common/common/bin:${ORACLE_HOME}/wlserver/common/bin:${DOMAIN_PARENT}/${DOMAIN_NAME}:${DOMAIN_PARENT}/${DOMAIN_NAME}/bin:${ORACLE_HOME}
+ENV DOMAIN_HOME=${DOMAIN_HOME:-/u01/domains/base_domain} \
+    PATH=$PATH:${JAVA_HOME}/bin:${ORACLE_HOME}/oracle_common/common/bin:${ORACLE_HOME}/wlserver/common/bin:${DOMAIN_HOME}/bin:${ORACLE_HOME}
 
 COPY --from=JDK_BUILD --chown=oracle:oracle $JAVA_HOME $JAVA_HOME/
 COPY --from=WLS_BUILD --chown=oracle:oracle $ORACLE_HOME $ORACLE_HOME/
 COPY --chown=oracle:oracle ${WDT_PKG} ${WDT_MODEL} ${WDT_ARCHIVE} ${WDT_VARIABLE} ${OTMPDIR}/
-COPY --chown=oracle:oracle ${SCRIPTS_DIR}/*.sh ${SCRIPT_HOME}/
+#COPY --chown=oracle:oracle ${SCRIPTS_DIR}/*.sh ${SCRIPT_HOME}/
 
 USER oracle
 
 RUN unzip $OTMPDIR/$WDT_PKG -d $(dirname $WDT_HOME) \
- && chmod a+x $SCRIPT_HOME/*.sh \
  && mkdir -p $(dirname ${DOMAIN_HOME}) \
  && mkdir -p ${PROPERTIES_FILE_DIR} \
  && if [ -n "$WDT_MODEL" ]; then MODEL_OPT="-model_file ${OTMPDIR}/${WDT_MODEL##*/}"; fi \
@@ -77,15 +74,14 @@ RUN unzip $OTMPDIR/$WDT_PKG -d $(dirname $WDT_HOME) \
  $VARIABLE_OPT \
  $MODEL_OPT \
  $ARCHIVE_OPT \
- && chmod -R a+x ${DOMAIN_HOME}/bin/*.sh \
  && rm -rf ${JAVA_HOME} ${ORACLE_HOME} ${WDT_HOME} $OTMPDIR
 
 # END %%WDT_INSTALL%% #
 
 # START %%WDT_CMD%% #
 # Expose admin server, managed server port
 EXPOSE $ADMIN_PORT $MANAGED_SERVER_PORT
-CMD ["sh", "-c", "${DOMAIN_HOME}/startAdminServer.sh"]
+#CMD ["sh", "-c", "${DOMAIN_HOME}/startAdminServer.sh"]
 
 # END %%WDT_CMD%% #
 
diff --git a/site/quickstart.md b/site/quickstart.md
