Enhancement : OHS Docker Solution with Docker Data Volume (#175)

Now user can provide custom Oracle Weblogic Proxy Plugin file containing directives as per their weblogic environments .
This file will need to be placed in docker data volume , which in turn will be mounted during OHS container creation.
In this way, the same OHS docker solution can be used to route applications running on either  Weblogic Admin Server or Weblogic cluster or set of individual Managed Servers .

Author: Hemastuti

OracleHTTPServer/README.md

@@ -13,13 +13,15 @@ Before you can build these WebLogic images, you must download the Oracle Server
 ## How to Build and Run
 This project offers sample Dockerfiles for Oracle HTTP Server 12cR2 (12.2.1) in standalone mode. To assist in building the images, you can use the buildDockerImage.sh script. See below for instructions and usage
 
-The **buildDockerImage.sh** script is just a utility shell script that performs MD5 checks and is an easy way for beginners to get started. Expert users are welcome to directly call docker build with their prefered set of parameters.
+The **buildDockerImage.sh** script is just a utility shell script that performs MD5 checks and is an easy way for beginners to get started. Expert users are welcome to directly call docker build with their preferred set of parameters.
 
 ### Building OHS Docker Install Images
 IMPORTANT: You have to download the binaries of OHS and Oracle JDK and put them in place (see .download files inside dockerfiles/).
 
 Download the required packages (see .download files) and drop them in the folder of your distribution version of choice. Then go into the **dockerfiles** folder and run the **buildDockerImage.sh** script as root.
 
+    $ sh buildDockerImage.sh -v 12.2.1
+
 IMPORTANT: the resulting images will NOT have a domain pre-configured.
 You must extend the image with your own Dockerfile, and create your domain using WLST. You might take a look at the use case samples as well below.
 
@@ -42,11 +44,11 @@ The best way to create your own, or extend domains is by using WebLogic Scriptin
 ## Building a sample Docker Image of a OHS Domain
 To try a sample of a OHS standalone image with a domain configured, follow the steps below:
 
-Make sure you have oracle/ohs:12.2.1-sa image built. If not go into **dockerfiles/12.2.1** and call:
+Make sure you have **oracle/ohs:12.2.1-sa** image built. If not go into **dockerfiles/12.2.1** and call:
 
         $ sh buildDockerImage.sh -v 12.2.1
 
-### How to Build Image
+### How to Build OHS domain Image
 Go to folder **samples/1221-OHS-domain**
 
 Run the following command:
@@ -58,36 +60,46 @@ Verify you now have this image in place with
         $ docker images
 
 ### How to run container
-1. Edit the env.list file with relevant data from Weblogic container like Admin Server host, port, cluster info etc.
+1. As prerequisite run the below command to create a docker data volume.
+
+       Eg:$ docker volume create --name volume
 
-        For example:
+_This volume will be created in "/var/lib/docker" directory or the location where "/var/lib/docker" points to._
 
-        WEBLOGIC_HOST=myhost
-        WEBLOGIC_PORT=7001
-        WEBLOGIC_CLUSTER=myhost:9001,myhost:9002
 
+2. Depending on your weblogic environment , create a **custom_mod_wl_ohs.conf** file by referring to container-scripts/mod_wl_ohs.conf.sample and section 2.4 @ [OHS 12c Documentation](http://docs.oracle.com/middleware/1221/webtier/develop-plugin/oracle.htm#PLGWL553)
 
-The values of WEBLOGIC_HOST, WEBLOGIC_PORT and WEBLOGIC_CLUSTER must be valid, existing containers running WebLogic servers.
+3. Place the custom_mod_wl_ohs.conf file in docker data volume directory . e.g /var/lib/docker/volume
 
-2. Run this image by calling
+4. To start the OHS Container with above sampleohs:12.2.1 image , run command from docker voume directory
 
-        $ docker run -d --env-file ./env.list -p 7777:7777  sampleohs:12.2.1 configureWLSProxyPlugin.sh
+       For e.g.
+       $ cd /var/lib/docker/volume
+       $ docker run -v `pwd`:/volume -w /volume -d --name ohs -p 7777:7777  sampleohs:12.2.1 configureWLSProxyPlugin.sh
 
 
    The **configureWLSProxyPlugin.sh** script will be the first script to be run inside the OHS container .
    This script will perform the following actions:
-   - Starts the Node Manager and OHS server
-   - Edits the mod_wl_ohs.conf.sample with values passed via env.list
-   - Copies the mod_wl_ohs.conf file under INSTANCE home
-   - Restarts OHS server
+   - Start the Node Manager and OHS server
+   - Fetch the custom_mod_wl_ohs.conf file from mounted shared data volume
+   - Place the custom_mod_wl_ohs.conf file under OHS INSTANCE home
+   - Restart OHS server
+
+_NOTE: If custom_mod_wl_ohs.conf is not provided or not found under mounted shared data volume, then configureWLSProxyPlugin.sh will still start OHS server which will be accessible @ http://localhost:7777/index.html._
+
+_Later you can login to running container and configure Weblogic Server proxy plugin file and run restartOHS script._
 
-3. Sanity URLs check for OHS server
+
+5. Sanity URLs check for OHS server
    - Now you can access the OHS index page @ http://localhost:7777/index.html
    - Static html page @ URL http://localhost:7777/helloWorld.html
 
-4. Weblogic Cluster : Now you will be able to access all URLS via the OHS Listen Port 7777
-    - Weblogic Console : http://myhost:7777/console
-    - Applications deployed on Weblogic Cluster : http://myhost:7777/$application_url_endpoint
+6. All applications should now be routed via the OHS port 7777.
+
+
+## Support
+Currently Oracle HTTP Server on Docker is NOT supported by Oracle. Use these files at your own discretion.
+
 
 ## License
 To download and run Oracle HTTP Server 12c Distribution regardless of inside or outside a Docker container, and regardless of the distribution, you must download the binaries from Oracle website and accept the license indicated at that page.

OracleHTTPServer/samples/1221-ohs-domain/README.md

@@ -1,28 +1,46 @@
 Example of Oracle HTTP Server with Weblogic Proxy Plugin
 ===============
-This Dockerfile extends the Oracle HTTP Install image by creating a sample OHSdomain and configures Oracle WebLogic Server Proxy Plug-In  in order to load balance a WebLogic cluster, from inside a container in the same network as the Weblogic Cluster.
+This Dockerfile extends the Oracle HTTP Install image by creating a sample OHSdomain .
+During OHS container creation Oracle WebLogic Server Proxy Plug-In can be configured in order to load balance applications deployed onto either the Weblogic Admin Server, the Managed Servers or the  WebLogic cluster running on docker containers within the same network.
 
 ## How to build image and run container
 First make sure you have the Oracle HTTP install image (oracle/ohs:12.2.1-sa) ready by running following command as root user
 $ docker images
 
-1.To build the domain image using this sample Dockerfile, run command:
+1.To build the OHS domain image using this sample Dockerfile, run command:
 
-    $ docker build --force-rm=true --no-cache=true --rm=true -t sampleohs:12.2.1 --build-arg NM_PASSWORD=welcome1 .
+      $ docker build --force-rm=true --no-cache=true --rm=true -t sampleohs:12.2.1 --build-arg NM_PASSWORD=welcome1 .
 
-2.To start the Container with above image , run command :
+2. Run the below command to create a docker data volume.
 
-    $ docker run -d --env-file ./env.list -p 7777:7777  sampleohs:12.2.1 configureWLSProxyPlugin.sh
+       Eg:$ docker volume create --name volume
+
+_This data volume will be created in "/var/lib/docker" directory or the location where "/var/lib/docker" points to._
+
+3. Depending on your Weblogic environment , create a **custom_mod_wl_ohs.conf** file by referring to container-scripts/mod_wl_ohs.conf.sample and section 2.4 @ [OHS 12c Documentation](http://docs.oracle.com/middleware/1221/webtier/develop-plugin/oracle.htm#PLGWL553)
+
+4. Place the custom_mod_wl_ohs.conf file in docker data volume directory . e.g /var/lib/docker/volume
+
+4. To start the OHS Container with above sampleohs:12.2.1 image , run command  from data volume directory:
+
+       $ cd /var/lib/docker/volume
+       $ docker run -v `pwd`:/volume -w /volume -d --name ohs -p 7777:7777  sampleohs:12.2.1 configureWLSProxyPlugin.sh
+
+5. All applications will now be accessible via the OHS port 7777.
+
+######NOTE: If custom_mod_wl_ohs.conf is not provided, then configureWLSProxyPlugin.sh will just start OHS which will be accessible @ http://localhost:7777/index.html. Later you can login to running container and configure Weblogic Server proxy plugin file and run restartOHS script.
 
- ######Note : env.list file should have valid values of WEBLOGIC_HOST, WEBLOGIC_PORT and WEBLOGIC_CLUSTER from existing containers running WebLogic servers.
 
 ## Configuring the Oracle WebLogic Server Proxy Plug-In with Oracle HTTP Server
+
 Oracle WebLogic Server Proxy Plug-In (mod_wl_ohs)is used for proxying requests from Oracle HTTP Server to Oracle WebLogic Server.
-The Oracle WebLogic Server Proxy Plug-In is included in the Oracle HTTP Server 12c (12.2.1) installation.
-Refer https://docs.oracle.com/middleware/1221/webtier/develop-plugin/oracle.htm#PLGWL553
+The Oracle WebLogic Server Proxy Plug-In is included in the Oracle HTTP Server 12c (12.2.1) installation by default.
+
+A sample WebLogic Server Proxy Plug-In file has been provided @ **samples/1221-ohs-domain/container-scripts/mod_wl_ohs.conf.sample**
+Refer [OHS 12c Documentation](http://docs.oracle.com/middleware/1221/webtier/develop-plugin/oracle.htm#PLGWL553) for more details and examples
+
+Depending on the nature of your applications create your own "custom_mod_wl_ohs.conf" file.
 
-To configure OHS server with WLS Proxy Plugin, a sample file mod_wl_ohs.conf.sample has been provided under **samples/1221-ohs-domain/container-scripts** folder.
-The values for WEBLOGIC_HOST, WEBLOGIC_PORT and WEBLOGIC_CLUSTER will be used from values provided by user during docker run via the env.list
 
 ### Example with WLS Docker Container
 
@@ -32,32 +50,58 @@ The values for WEBLOGIC_HOST, WEBLOGIC_PORT and WEBLOGIC_CLUSTER will be used fr
    - http://myhost:7001/console
 
 2. Two WLS Containers with Managed Servers running on 9001 and 9002 ports (inside same weblogic cluster).
-   Assume some sample application is deployed on the each managed server and are accessible via URLs
-   - http://myhost:9001/sample1
-   - http://myhost:9002/sample2
+   Assume some "sample" application is deployed on the weblogic cluster and are accessible via URLs
+   - http://myhost:9001/sample
+   - http://myhost:9002/sample
 
 ##### To configure Oracle WebLogic Server Proxy Plug-In inside OHS container
 
-1.Edit the env.list file and provide values
-
-        WEBLOGIC_HOST=myhost
-        WEBLOGIC_PORT=7001
-        WEBLOGIC_CLUSTER=myhost:9001,myhost:9002
-
-2. As part of docker run command provide the env.file
-
-        $ docker run -d --env-file ./env.list -p 7777:7777  sampleohs:12.2.1 configureWLSProxyPlugin.sh
-
-   The **configureWLSProxyPlugin.sh** script will
+1. Create the custom_mod_wl_ohs.conf file by referring to container-scripts/mod_wl_ohs.conf.sample
+
+       For e.g
+       LoadModule weblogic_module   "/u01/oracle/ohssa/ohs/modules/mod_wl_ohs.so"
+       <IfModule mod_weblogic.c>
+       WebLogicHost myhost
+       WebLogicPort 7001
+       </IfModule>
+       #
+       # Directive for weblogic admin console deployed on Admin Server
+       <Location /console>
+       WLSRequest On
+       WebLogicHost myhost
+       WeblogicPort 7001
+       </Location>
+       #
+       # Directive for all application deployed on weblogic cluster with prepath /weblogic
+       <Location /weblogic>
+       WLSRequest On
+       WebLogicCluster myhost:9001,myhost:9002
+       PathTrim /weblogic
+       </Location>
+
+
+2. Place it in docker data volume directory say /var/lib/docker/volume
+
+3. From docker data volume directory run following docker run command
+
+        For e.g
+        $ cd /var/lib/docker/volume
+        $ docker run -v `pwd`:/volume -w /volume -d --name ohs -p 7777:7777  sampleohs:12.2.1 configureWLSProxyPlugin.sh
+
+   The **configureWLSProxyPlugin.sh** script will be the first script to be run inside the OHS container .
+   This script will perform the following actions:
    - Start the Node Manager and OHS server
-   - Edit the mod_wl_ohs.conf.sample with right directives (based on values passed via env.list)
-   - Copy the mod_wl_ohs.conf file under INSTANCE home
+   - Fetch the custom_mod_wl_ohs.conf file from mounted shared data volume
+   - Place the custom_mod_wl_ohs.conf file under OHS INSTANCE home
    - Restart OHS server
 
-3. Now you will be able to access all the URLS via the OHS Listen Port 7777
-    - http://myhost:7777/console
-    - http://myhost:7777/sample1
-    - http://myhost:7777/sample2
+4. Now you will be able to access all the URLS via the OHS Listen Port 7777
+    - http://localhost:7777/console
+    - http://localhost:7777/weblogic/sample
+
+ _NOTE: If custom_mod_wl_ohs.conf is not provided or not found under mounted shared data volume, then configureWLSProxyPlugin.sh will still start OHS server which will be accessible @ http://localhost:7777/index.html._
+ _Later you can login to running container and configure Weblogic Server proxy plugin file and run restartOHS script._
+
 
 # Copyright
 Copyright (c) 2016-2017 Oracle and/or its affiliates. All rights reserved.

OracleHTTPServer/samples/1221-ohs-domain/container-scripts/configureWLSProxyPlugin-WLSMultihost.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+# Author: hemastuti.baruah@oracle.com
+#
+# Copyright (c) 2016-2017 Oracle and/or its affiliates. All rights reserved.
+#
+#*************************************************************************
+#This script will configure Oracle WebLogic Server Proxy Plug-In (mod_wl_ohs),
+#in order to enable the Oracle HTTP Server instances to route applications
+#deployed on the Oracle WebLogic Server Multi Host
+#Refer to Section 2.4 @ http://docs.oracle.com/middleware/1221/webtier/develop-plugin/oracle.htm#PLGWL553
+#
+#Prerequisite: Setup environment for Weblogic MultiHost by referring to samples in
+# https://github.com/oracle/docker-images/tree/master/OracleWebLogic/samples/1221-multihost
+#
+#MW_HOME    - The root directory of your OHS standalone install
+#DOMAIN_NAME - Env Value set by Dockerfile , default is "ohsDOmain"
+#OHS_COMPONENT_NAME - Env Value set by Dockerfile , default is "ohs_sa1"
+#WEBLOGIC_HOST, WEBLOGIC_PORT, WEBLOGIC_CLUSTER - Env values passed from env.list
+#*************************************************************************
+echo "MW_HOME=${MW_HOME:?"Please set MW_HOME"}"
+echo "DOMAIN_NAME=${DOMAIN_NAME:?"Please set DOMAIN_NAME"}"
+echo "OHS_COMPONENT_NAME=${OHS_COMPONENT_NAME:?"Please set OHS_COMPONENT_NAME"}"
+echo "WEBLOGIC_HOST=${WEBLOGIC_HOST:?"Please provide Weblogic Admin Server hostname"}"
+echo "WEBLOGIC_PORT=${WEBLOGIC_PORT:?"Please provide Weblogic Admin Server Port"}"
+echo "WEBLOGIC_CLUSTER=${WEBLOGIC_CLUSTER:?"Please provide the Weblogic Cluster details"}"
+
+DOMAIN_HOME=${MW_HOME}/user_projects/domains/${DOMAIN_NAME}
+INSTANCE_CONFIG_HOME=$DOMAIN_HOME/config/fmwconfig/components/OHS/${OHS_COMPONENT_NAME}
+export INSTANCE_CONFIG_HOME
+echo "INSTANCE_CONFIG_DIR=${INSTANCE_CONFIG_HOME}"
+
+#Start NodeManager and OHS server
+echo "Starting Node Manager and OHS server"
+/u01/oracle/container-scripts/startNMandOHS.sh
+
+
+#Modify the variables in the mod_wl_ohs.conf.sample file with values provided in the env.file
+cp /u01/oracle/container-scripts/mod_wl_ohs.conf.sample /u01/oracle/container-scripts/mod_wl_ohs.conf.sample.WLSMultiHost
+sed -i -e "s/WEBLOGIC_HOST/$WEBLOGIC_HOST/g" -e "s/WEBLOGIC_PORT/$WEBLOGIC_PORT/g" -e "s/WEBLOGIC_CLUSTER/$WEBLOGIC_CLUSTER/g" mod_wl_ohs.conf.sample.WLSMultiHost
+
+# Rename the original file and copy the sample file to instance config location
+echo "Configuring Oracle WebLogic Server Proxy Plug-In for WLS MultiHost sample"
+cd ${INSTANCE_CONFIG_HOME}
+mv mod_wl_ohs.conf mod_wl_ohs.conf.ORIGINAL
+echo "Copying plugin file to INSTANCE_CONFIG_DIR=${INSTANCE_CONFIG_HOME}"
+cp /u01/oracle/container-scripts/mod_wl_ohs.conf.sample.WLSMultiHost ${INSTANCE_CONFIG_HOME}/mod_wl_ohs.conf
+
+# Restart ohs server
+echo "Restarting OHS server "
+/u01/oracle/container-scripts/restartOHS.sh
+
+#Tail all server logs
+tail -f ${DOMAIN_HOME}/nodemanager/nodemanager.log ${DOMAIN_HOME}/servers/*/logs/*.out

OracleHTTPServer/samples/1221-ohs-domain/container-scripts/configureWLSProxyPlugin.sh

@@ -5,11 +5,19 @@
 #
 #*************************************************************************
 #This script will configure Oracle WebLogic Server Proxy Plug-In (mod_wl_ohs),
-#in order to enable the Oracle HTTP Server instances to route to applications
-#deployed on the Oracle WebLogic Server clusters
+#in order to enable the Oracle HTTP Server instances to route applications
+#deployed on the Admin Server, Single Managed Server or the Oracle WebLogic Server clusters
 #Refer to Section 2.4 @ http://docs.oracle.com/middleware/1221/webtier/develop-plugin/oracle.htm#PLGWL553
 #
-#Prerequisite: Provide WLS Host, Port and Cluster info in the env.list during docker run
+#Prerequisite:
+#1.Create docker volume e.g docker volume create --name volume
+#2.Create "custom_mod_wl_ohs.conf"  as per your environment by referring to mod_wl_ohs.conf sample file and OHS document above
+#3.Place the "custom_mod_wl_ohs.conf" inside the docker volume
+#4.During OHS container creation mount the docker volume which contains the "custom_mod_wl_ohs.conf"
+#
+# Note :
+# If custom_mod_wl_ohs.conf is not provided, WebLogic Server Proxy Plug-In will not be configured. But OHS server will be still running.
+# User may login to OHS container and manually configure the WebLogic Server Proxy Plug-In later
 #
 #MW_HOME    - The root directory of your OHS standalone install
 #DOMAIN_NAME - Env Value set by Dockerfile , default is "ohsDOmain"
@@ -19,31 +27,34 @@
 echo "MW_HOME=${MW_HOME:?"Please set MW_HOME"}"
 echo "DOMAIN_NAME=${DOMAIN_NAME:?"Please set DOMAIN_NAME"}"
 echo "OHS_COMPONENT_NAME=${OHS_COMPONENT_NAME:?"Please set OHS_COMPONENT_NAME"}"
-echo "WEBLOGIC_HOST=${WEBLOGIC_HOST:?"Please provide Weblogic Admin Server hostname in the env.list file"}"
-echo "WEBLOGIC_PORT=${WEBLOGIC_PORT:?"Please provide Weblogic Admin Server Port in the env.list file"}"
-echo "WEBLOGIC_CLUSTER=${WEBLOGIC_CLUSTER:?"Please provide the Weblogic Cluster details in the env.list file"}"
 
 DOMAIN_HOME=${MW_HOME}/user_projects/domains/${DOMAIN_NAME}
 INSTANCE_CONFIG_HOME=$DOMAIN_HOME/config/fmwconfig/components/OHS/${OHS_COMPONENT_NAME}
 export INSTANCE_CONFIG_HOME
 echo "INSTANCE_CONFIG_DIR=${INSTANCE_CONFIG_HOME}"
 
 #Start NodeManager and OHS server
+echo "Starting Node Manager and OHS server"
 /u01/oracle/container-scripts/startNMandOHS.sh
 
 
-#Modify the variables in the mod_wl_ohs.conf.sample file with values provided in the env.file
-cp /u01/oracle/container-scripts/mod_wl_ohs.conf.sample /u01/oracle/container-scripts/mod_wl_ohs.conf.sample.without_substitution
-sed -i -e "s/WEBLOGIC_HOST/$WEBLOGIC_HOST/g" -e "s/WEBLOGIC_PORT/$WEBLOGIC_PORT/g" -e "s/WEBLOGIC_CLUSTER/$WEBLOGIC_CLUSTER/g" mod_wl_ohs.conf.sample
+#Search for the customized mod_wl_ohs.conf file
+modwlsconfigfile=`find / -name 'custom_mod_wl_ohs.conf' 2>&1 | grep -v 'Permission denied'`
+export modwlsconfigfile
 
-# Rename the original file and copy the sample file to instance config lcoation
+# Check and copy custom_mod_wl_ohs.conf to OHS Instance Home
+if [[ -n "${modwlsconfigfile/[ ]*\n/}" ]]; then
 cd ${INSTANCE_CONFIG_HOME}
 mv mod_wl_ohs.conf mod_wl_ohs.conf.ORIGINAL
-echo "Copying plugin file to INSTANCE_CONFIG_DIR=${INSTANCE_CONFIG_HOME}"
-cp /u01/oracle/container-scripts/mod_wl_ohs.conf.sample ${INSTANCE_CONFIG_HOME}/mod_wl_ohs.conf
-
-# Restart ohs server
+echo "Copying ${modwlsconfigfile} to ${INSTANCE_CONFIG_HOME} and restarting OHS server"
+cp ${modwlsconfigfile} ${INSTANCE_CONFIG_HOME}/mod_wl_ohs.conf
+echo "Restarting OHS server after successful configuration of WebLogic Server Proxy Plug-In "
 /u01/oracle/container-scripts/restartOHS.sh
+echo "You may now access the the application deployed to the DockerCluster @ http://myhost:7777/weblogic/application_end_url"
+else
+echo "Customized mod_wl_ohs.conf file not found in mounted volume!!! WebLogic Server Proxy Plug-In has not been configured, but OHS is running  "
+echo "You may now access OHS @ http://myhost:7777/index.html"
+fi
 
-#Tail all servr logs
+#Tail all server logs
 tail -f ${DOMAIN_HOME}/nodemanager/nodemanager.log ${DOMAIN_HOME}/servers/*/logs/*.out