Support obiee 12.2.1.4 (oracle#1361)

* OracleBI: Support OBIEE 12.2.1.4.
* Oracle BI: Additions to README.md.

OracleBI/README.md

@@ -8,7 +8,7 @@ The certification of Oracle Business Intelligence on Docker does not require the
 
 For pre-built images containing Oracle software, please check the [Oracle Container Registry](https://container-registry.oracle.com).
 
-The instructions below can also be used to build and run Oracle Business Intelligence 12.2.1.2.0, based on FMW Infrastructure 12.2.1.2.0, by changing 12.2.1.3 to 12.2.1.2 as required.
+The instructions below can also be used to build and run Oracle Business Intelligence 12.2.1.2.0, based on FMW Infrastructure 12.2.1.2.0, by changing 12.2.1.3 to 12.2.1.2 as required. A docker image for Oracle Business Intelligence 12.2.1.4.0, on FMW Infrastructure 12.2.1.3.0, can be built and run by changing 12.2.1.3 to 12.2.1.4 in the commands that follow.
 
 ## Database prerequisite
 
@@ -109,6 +109,13 @@ The following example URLS provide access to the BI domain:
 * http://www.example.com:9502/va - Data Visualisation
 * http://www.example.com:9502/xmlpserver - BI Publisher
 
+If access to the OBI Server component is required, e.g. by the BI Administration Tool, then port 9514 must be exposed and the previous `docker run` command should be modified
+
+e.g.:
+
+        $ docker run -it -p 9500:9500 -p 9502:9502 -p 9514:9514 -e ADMIN_USERNAME=weblogic -e ADMIN_PASSWORD=<admin_password> -e DB_HOST=database -e DB_PORT=1521 -e DB_SERVICE=ORCLPDB1 -e DB_USERNAME=sys -e DB_PASSWORD=<db_password> -e SCHEMA_PREFIX=DEV -e SCHEMA_PASSWORD=<schema_password> oracle/biplatform:12.2.1.3
+
+
 ### Using a host directory for persistent data
 
 In the basic usage above, persistent data in DOMAIN_HOME, APPLICATIONS_DIR and SINGLETON_DATA_DIRECTORY is stored within the container.  If the container is deleted, the data is lost.

OracleBI/dockerfiles/12.2.1.4/Checksum.md5

@@ -0,0 +1,10 @@
+# Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved.
+#
+# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
+#
+# Download Oracle Business Intelligence Installer 12.2.1.4
+# 
+# - https://www.oracle.com/technetwork/middleware/bi-enterprise-edition/downloads/default-4441820.html
+#
+f1aa5f43db385d77529c6ddfe76e4970  fmw_12.2.1.4.0_bi_linux64_Disk1_1of2.zip
+19ceb0e813a4bb7a2ebfc1c2c6cf158a  fmw_12.2.1.4.0_bi_linux64_Disk1_2of2.zip

OracleBI/dockerfiles/12.2.1.4/Dockerfile

@@ -0,0 +1,68 @@
+# Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved.
+#
+# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
+#
+# ORACLE DOCKERFILES PROJECT
+# --------------------------
+# This is the Dockerfile for Oracle Business Intelligence 12.2.1.4.0
+# 
+# REQUIRED FILES TO BUILD THIS IMAGE
+# ----------------------------------
+# (1) fmw_12.2.1.4.0_bi_linux64_Disk1_1of2.zip 
+# (2) fmw_12.2.1.4.0_bi_linux64_Disk1_2of2.zip
+#     Download the two installer files from https://www.oracle.com/technetwork/middleware/bi-enterprise-edition/downloads/default-4441820.html
+#
+# HOW TO BUILD THIS IMAGE
+# -----------------------
+# Put all downloaded files in the same directory as this Dockerfile
+# Run: 
+#      $ docker build -t oracle/biplatform:12.2.1.4.0 . 
+#
+# Pull base image
+# ---------------
+FROM oracle/fmw-infrastructure:12.2.1.3
+
+# Maintainer
+# ----------
+MAINTAINER Steve Phillips <[email protected]>
+
+#Common ENV
+#-----------
+ENV ORACLE_HOME=/u01/oracle
+
+# Environment variables required for this build (do NOT change)
+# (DOMAIN_NAME/HOME are reset here, to avoid FMW Infra environment leaking through)
+# -------------------------------------------------------------
+ENV BI_DISTRO_ZIP1=fmw_12.2.1.4.0_bi_linux64_Disk1_1of2.zip \
+    BI_DISTRO_ZIP2=fmw_12.2.1.4.0_bi_linux64_Disk1_2of2.zip \
+    BI_INSTALLER1=bi_platform-12.2.1.4.0_linux64.bin \
+    BI_INSTALLER2=bi_platform-12.2.1.4.0_linux64-2.zip \
+    DOMAIN_NAME="${BI_DOMAIN_NAME:-bi}" \
+    DOMAINS_DIR=$ORACLE_HOME/user_projects/domains \
+    DOMAIN_HOME=$ORACLE_HOME/user_projects/domains/${BI_DOMAIN_NAME:-bi}
+
+# Copy packages
+# -------------
+COPY $BI_DISTRO_ZIP1 $BI_DISTRO_ZIP2 install.file oraInst.loc /u01/
+
+# Install
+#-------------------------------------------------------------
+USER root
+
+# tools for installing and running BI
+RUN yum -y install unzip hostname && rm -rf /var/cache/yum
+
+USER oracle
+RUN cd /u01 && unzip $BI_DISTRO_ZIP1 && unzip $BI_DISTRO_ZIP2 && cd - && \
+    /u01/$BI_INSTALLER1 -silent -responseFile /u01/install.file -invPtrLoc /u01/oraInst.loc -ignoreSysPrereqs -force -novalidation ORACLE_HOME=$ORACLE_HOME INSTALL_TYPE="BI Platform Distribution with Samples" && \
+    rm /u01/$BI_DISTRO_ZIP1 /u01/$BI_DISTRO_ZIP2 /u01/$BI_INSTALLER1 /u01/$BI_INSTALLER2 /u01/oraInst.loc /u01/install.file
+
+USER oracle
+WORKDIR $ORACLE_HOME 
+
+# Prepare for Config
+#-------------------------------------------------------------
+EXPOSE 9500-9999
+COPY createAndStartDomain.sh wait_for_db.sh /u01/
+
+CMD ["/u01/createAndStartDomain.sh"]

OracleBI/dockerfiles/12.2.1.4/createAndStartDomain.sh

@@ -0,0 +1,211 @@
+#!/bin/bash -e
+#
+# Copyright (c) 2017 Oracle and/or its affiliates. All rights reserved.
+#
+# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
+#
+# Script to create a BI domain if it does not exist and then start the stack.
+
+usage() {
+cat << EOF
+
+Usage: createAndStartDomain.sh
+Start a Oracle Business Intelligence domain, creating one if not yet available.
+
+The following variables are mandatory when creating the domain (i.e. when starting the container first time):
+  ORACLE_HOME - installation location (built into the image environment)
+  DOMAINS_DIR - directory containing DOMAIN_HOME (built into the image environment)
+  DOMAIN_NAME - Weblogic domain name (built into the image environment)
+  ADMIN_USERNAME - WebLogic admin username for the new domain
+  ADMIN_PASSWORD - Weblogic admin password
+  DB_HOST - Host name for database into which new schemas will be created
+  DB_PORT - Database listener port
+  DB_SERVICE - Database instance service name
+  DB_USERNAME - Database sysdba username
+  DB_PASSWORD - Database sysdba password
+  SCHEMA_PREFIX - Schema prefix for new schemas for the new domain
+  SCHEMA_PASSWORD - Password for all new schemas
+
+They can all be accepted as docker environment variables and/or Kubernetes secrets as environment variables.
+
+The following files can also be used, overriding any environment already set.
+
+For ADMIN_USERNAME/ADMIN_PASSWORD:
+ - /run/secrets/admin.txt, or 
+ - /run/secrets/admin/username and /run/secrets/admin/password
+For DB_USERNAME/DB_PASSWORD:
+ - /run/secrets/db.txt, or
+ - /run/secrets/db/username and /run/secrets/db/password
+For SCHEMA_PASSWORD:
+ - /run/secrets/schema.txt, or
+ - /run/secrets/schema/password
+For providing all keys:
+ - /run/secrets/config.txt 
+
+Each *.txt file must contain lines of key=value pairs. This is intended docker secrets or docker run /v.
+Each non-txt file must contain only the required value.  This is intended for Kubernetes secrets.
+
+The following variable is optional:
+  DB_WAIT_TIMEOUT - Wait for the given timeout (in seconds) for the database to be ready.  If not set, the database must already be ready.  If set, then DB_USERNAME/PASSWORD must be set (via any means) as this account is used to check the connection.  This setting is useful if the database is containerized and created at the same time as BI (e.g. via compose)
+
+EOF
+exit 0
+}
+
+_V=0
+while getopts "hv" optname; do
+  case "$optname" in
+    "h")
+      usage
+      ;;
+    "v")
+      _V=1 
+      ;;
+  esac
+done
+
+function log () {
+    if [[ $_V -eq 1 ]]; then
+        echo "$@"
+    fi
+}
+
+# Note that APPLICATIONS_DIR is always $ORACLE_HOME/user_projects/applications. Thus DOMAINS_DIR remains co-located.
+# Mounting in $ORACLE_HOME/user_projects from a host o/s directory will work (if its permissions are correctly set).
+# Mounting in $ORACLE_HOME/user_projects/domains/$DOMAIN_NAME will fail with ScriptExecutor configuration error.
+# Separately mounting in $ORACLE_HOME/user_projects/domains/$DOMAIN_NAME/bidata (SDD) will fail with $DOMAIN_HOME in use configuration error.
+DOMAIN_HOME=$DOMAINS_DIR/$DOMAIN_NAME
+
+# Use a touch file controlled by this script to ensure a container restart will know to start a successfully created domain.
+# But don't allow start for a failed configuration (we could delete DOMAIN_HOME and retry instead?)
+domainCheckFile=$DOMAIN_HOME/domainready.txt
+if [ ! -f $domainCheckFile -a -d $DOMAIN_HOME ]; then
+  echo "An attempt was made to start a container with an incomplete DOMAIN_HOME"
+  exit 2
+fi
+
+# Load parameters from various files, overriding any environment variables.
+# Note we take care to not export these, so they are not visible to child processes
+loadParametersFile() {
+  file=$1/$2
+  if [ -f $file ]; then
+    if [ "txt" == "${file##*.}" ]; then
+      parameters=$(cat $file | xargs) 
+      log "Loaded from $file: $parameters"
+      eval $(cat $file | sed -e "s/=\(.*\)/='\1'/g")
+    else
+      parameterKey=$(echo $2 | tr /a-z/ /A-Z/ | tr / _)
+      parameterValue=$(cat $file)
+      parameter="$parameterKey='$parameterValue'"
+      log "Loaded from $file: $parameter"
+      eval $parameter 
+    fi
+  fi  
+}
+
+parameterFileDir=/run/secrets
+parameterFiles=(config.txt admin.txt db.txt schema.txt admin/username admin/password db/username db/password schema/password)
+for parameterFile in "${parameterFiles[@]}"; do
+  loadParametersFile $parameterFileDir $parameterFile
+done
+
+# validate that all required parameters have been set somehow
+validateMandatoryParameter() {
+  key=$1
+  if [ -z "${!key}" ]; then
+    echo $key
+  fi
+}
+
+# TODO only ORACLE_HOME/DOMAIN_NAME/DOMAINS_DIR is mandatory once domain is configured
+mandatoryParameters=(ORACLE_HOME DOMAIN_NAME DOMAINS_DIR ADMIN_USERNAME ADMIN_PASSWORD DB_HOST DB_PORT DB_SERVICE DB_USERNAME DB_PASSWORD SCHEMA_PREFIX SCHEMA_PASSWORD)
+missingMandatoryParameters=()
+for mandatoryParameter in "${mandatoryParameters[@]}"; do
+  missingMandatoryParameters+=($(validateMandatoryParameter $mandatoryParameter))
+done
+
+if (( ${#missingMandatoryParameters[@]} != 0 )); then
+  missingParametersJoin=$(IFS="," ; echo "${missingMandatoryParameters[*]}")
+  echo "The following mandatory parameters are not set: $missingParametersJoin"
+  exit 1
+fi
+
+for parameter in "${mandatoryParameters[@]}"; do
+  log "Parameter: $parameter=${!parameter}"
+done
+
+# TODO - in the case where docker secrets are used, it should be possible to remove the secret once the domain is created.
+#  However, that leaves no creds available for the dbping. Options: fail if no creds and DB_WAIT_TIMEOUT is set (i.e. not
+#  our responsibility to handle this on restart, b) work if schema password only is set (and then wait_for_db needs the prefix
+#  and not use 'as sysdba', c) as per b, but use the Connections API to recover a schema password from the domain (this makes
+#  more sense than (b).
+
+# If a wait timeout is set, block until the DB is available or the timeout is reached.
+# This is useful when starting DB+BI via docker compose.
+DB_WAIT_TIMEOUT=${DB_WAIT_TIMEOUT:-0}
+if (( $DB_WAIT_TIMEOUT > 0 )); then
+ if [ -z DB_USERNAME -o -z DB_PASSWORD ]; then
+   echo "DB_USERNAME and DB_PASSWORD must be set if DB_WAIT_TIMEOUT is non-zero"
+   exit 3
+ fi
+ set +e
+ echo $DB_PASSWORD | timeout $DB_WAIT_TIMEOUT /u01/wait_for_db.sh $ORACLE_HOME $DB_USERNAME $DB_HOST $DB_PORT $DB_SERVICE
+ if [ ! $? -eq 0 ]; then
+    echo "Reached timeout waiting for DB to start - exiting"
+    exit 1
+ fi
+ set -e
+fi
+
+# Create Domain only if 1st execution
+if [ ! -f $domainCheckFile ]; then
+  masterResponseFile=$ORACLE_HOME/bi/modules/oracle.bi.configassistant/response.txt
+
+  tempDir=$(mktemp -dt "create_domain_XXXXXXXXXX")
+  trap 'rm -rf -- "$tempDir"; kill -TERM $PID' INT TERM
+
+  responseFile=$tempDir/response.txt
+  cp $masterResponseFile $responseFile
+
+  replacements="  -e \"s|@@DOMAIN_TYPE@@|DOMAIN_TYPE_EXPANDED|g\""
+  replacements+=" -e \"s|@@CONFIGURE_ESSBASE@@|true|g\""
+  replacements+=" -e \"s|@@CONFIGURE_BIEE@@|true|g\""
+  replacements+=" -e \"s|@@CONFIGURE_BIP@@|true|g\""
+  replacements+=" -e \"s|@@DOMAIN_NAME@@|$DOMAIN_NAME|g\""
+  replacements+=" -e \"s|@@DOMAINS_DIR@@|$DOMAINS_DIR|g\""
+  replacements+=" -e \"s|@@ADMIN_USER_NAME@@|$ADMIN_USERNAME|g\""
+  replacements+=" -e \"s|@@ADMIN_PASSWORD@@|$ADMIN_PASSWORD|g\""
+  replacements+=" -e \"s|@@SCHEMA_TYPE@@|SCHEMA_TYPE_NEW|g\""
+  replacements+=" -e \"s|@@DB_TYPE@@|ORACLE|g\""
+  replacements+=" -e \"s|@@DB_CONNECT_STRING@@|$DB_HOST:$DB_PORT:$DB_SERVICE|g\""
+  replacements+=" -e \"s|@@DB_ADMIN_USERNAME@@|$DB_USERNAME|g\""
+  replacements+=" -e \"s|@@DB_PASSWORD@@|$DB_PASSWORD|g\""
+  replacements+=" -e \"s|@@PREFIX@@|$SCHEMA_PREFIX|g\""
+  replacements+=" -e \"s|@@NEW_DB_SCHEMA_PASSWORD@@|$SCHEMA_PASSWORD|g\""
+  replacements+=" -e \"s|@@NEW_DB_SCHEMA_PASSWORD@@|$SCHEMA_PASSWORD|g\""
+  replacements+=" -e \"s|@@APPLICATION_TYPE@@|APPLICATION_TYPE_SAMPLE_APP_LITE|g\""
+  replacements+=" -e \"s|@@AUTO_DROP_SCHEMAS@@|false|g\""
+  replacements+=" -e \"s|@@DEFAULT_SI_KEY@@|ssi|g\""
+  replacements+=" -e \"s|@@PORT_RANGE_START@@|9500|g\""
+  replacements+=" -e \"s|@@PORT_RANGE_END@@|9999|g\""
+
+  eval sed -i $replacements $responseFile 
+
+  # TODO (minor as scale-out not supported) - for SDD setting, need to not start the stack, but mv sdd and mod the xml (and manually dump diag zip?)
+  # TODO (minor) - hostname can change after image update, could realign nodemanager settings.
+  # TODO (minor) - autoport is in use, but the container must expose fixed ports.  This works by chance.
+  $ORACLE_HOME/bi/bin/config.sh -ignoreSysPrereqs -silent -responseFile $responseFile &
+  PID=$!
+  wait $PID
+  rm -f $responseFile
+  trap - INT TERM
+
+  echo "Do not delete this file - it tells the container createAndStartDomain.sh script that the domain is ready to be started" > $domainCheckFile
+else
+  ${DOMAIN_HOME}/bitools/bin/start.sh
+fi
+
+trap '${DOMAIN_HOME}/bitools/bin/stop.sh; kill -TERM $PID' INT TERM
+tail -f ${DOMAIN_HOME}/servers/AdminServer/logs/${DOMAIN_NAME}.log &
+PID=$!
+wait $PID

OracleBI/dockerfiles/12.2.1.4/fmw_12.2.1.4.0_bi_linux64_Disk1_1of2.zip.download

@@ -0,0 +1,6 @@
+# Download Oracle Business Intelligence 12.2.1.4.0
+#
+# https://www.oracle.com/technetwork/middleware/bi-enterprise-edition/downloads/default-4441820.html
+#
+#
+f1aa5f43db385d77529c6ddfe76e4970  fmw_12.2.1.4.0_bi_linux64_Disk1_1of2.zip

OracleBI/dockerfiles/12.2.1.4/fmw_12.2.1.4.0_bi_linux64_Disk1_2of2.zip.download

@@ -0,0 +1,6 @@
+# Download Oracle Business Intelligence 12.2.1.4.0
+#
+# https://www.oracle.com/technetwork/middleware/bi-enterprise-edition/downloads/default-4441820.html
+#
+#
+19ceb0e813a4bb7a2ebfc1c2c6cf158a  fmw_12.2.1.4.0_bi_linux64_Disk1_2of2.zip

OracleBI/dockerfiles/12.2.1.4/install.file

@@ -0,0 +1,13 @@
+# Copyright (c) 2017 Oracle and/or its affiliates. All rights reserved.
+#
+# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
+#
+[ENGINE]
+
+#DO NOT CHANGE THIS.
+Response File Version=1.0.0.0.0
+
+[GENERIC]
+
+DECLINE_SECURITY_UPDATES=true
+SECURITY_UPDATES_VIA_MYORACLESUPPORT=false

OracleBI/dockerfiles/12.2.1.4/oraInst.loc

@@ -0,0 +1,2 @@
+inventory_loc=/u01/oracle/.inventory
+inst_group=oracle

OracleBI/dockerfiles/12.2.1.4/wait_for_db.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+# Copyright (c) 2017 Oracle and/or its affiliates. All rights reserved.
+#
+# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
+
+if [ $# -ne 5 ]; then
+  echo usage: wait_for_db.sh oracle_home username host port service
+  echo password is provided on stdin
+  exit 1
+fi
+
+ORACLE_HOME=$1
+DB_USERNAME=$2
+DB_HOST=$3
+DB_PORT=$4
+DB_SERVICE=$5
+DB_PASSWORD=$(cat)
+
+MW_HOME=$ORACLE_HOME
+. $ORACLE_HOME/oracle_common/common/bin/commEnv.sh
+
+echo "Waiting for DB"
+until java -cp $WEBLOGIC_CLASSPATH utils.dbping ORACLE_THIN "$DB_USERNAME as sysdba" $DB_PASSWORD $DB_HOST:$DB_PORT/$DB_SERVICE > /dev/null
+do
+  echo "Waiting for DB"
+  sleep 10
+done
+echo "DB is available"
+