- Introduction
- Prerequisites
- Setup WebLogic Image Tool
- Download the required packages/installers
- Required build files
- Additional build commands
- Steps to Create Oracle Unified Directory image
- Generate Sample dockerfile with imagetool
This README describes the steps involved in building an Oracle Unified Directory image with the WebLogic Image Tool.
The following prerequisites are necessary before building Oracle Unified Directory container images with Image Tool:
- A working installation of Docker 18.03.1 or later
- Bash version 4.0 or later (commands should be run in a
bashshell) JAVA_HOMEenvironment variable set to the location of your JDK e.g:/scratch/export/oracle/product/jdk
- Download the latest version of WebLogic Image Tool.
- Extract the release archive (zip, tar.gz) content into a desired <work directory>.
$ unzip imagetool.zip
Archive: imagetool.zip
creating: imagetool/
creating: imagetool/bin/
inflating: imagetool/bin/setup.sh
inflating: imagetool/bin/logging.properties
inflating: imagetool/bin/imagetool.cmd
inflating: imagetool/bin/imagetool.sh
inflating: imagetool/LICENSE.txt
creating: imagetool/lib/
inflating: imagetool/lib/imagetool_completion.sh
inflating: imagetool/lib/imagetool.jar
inflating: imagetool/VERSION.txt
inflating: imagetool/lib/fluent-hc-4.5.12.jar
inflating: imagetool/lib/httpclient-4.5.12.jar
inflating: imagetool/lib/httpcore-4.4.13.jar
inflating: imagetool/lib/commons-logging-1.2.jar
inflating: imagetool/lib/commons-codec-1.11.jar
inflating: imagetool/lib/httpmime-4.5.12.jar
inflating: imagetool/lib/picocli-4.3.2.jar
inflating: imagetool/lib/json-20200518.jar
inflating: imagetool/lib/compiler-0.9.6.jar
$
- Run the following commands to setup imagetool
$ cd <work directory>/imagetool/bin
$ source setup.sh
- Execute the following to validate the WebLogic Image Tool:
$ ./imagetool.sh --version
imagetool:1.9.3
$
The Image Tool creates a temporary Docker context directory, prefixed by wlsimgbuilder_temp, every time the tool runs. Under normal circumstances, this context directory will be deleted. However, if the process is aborted or the tool is unable to remove the directory, it is safe for you to delete it manually. By default, the Image Tool creates the Docker context directory under the user's home directory. If you prefer to use a different directory for the temporary context, set the environment variable WLSIMG_BLDDIR.
$ export WLSIMG_BLDDIR="/path/to/dir"
The Image Tool maintains a local file cache store. This store is used to look up where the Java, WebLogic Server installers, and WebLogic Server patches reside in the local file system. By default, the cache store is located in the user's $HOME/cache directory. Under this directory, the lookup information is stored in the .metadata file. All automatically downloaded patches also reside in this directory. You can change the default cache store location by setting the environment variable WLSIMG_CACHEDIR.
$ export WLSIMG_CACHEDIR="/path/to/cachedir"
Download the required installers from the Oracle Software Delivery Cloud and save them in a directory of your choice e.g: <work directory>/stage:
- Oracle Unified Directory 12.2.1.4.0
- Oracle JDK
Note: If the image is required to have patched included, download patches from My Oracle Support and copy to <work directory>/stage.
The Oracle Unified Directory image requires additional files for creating and starting the Oracle Unified Directory instance in the container. Download the required files from the docker-images repository. For example:
$ cd <work directory>
$ git clone https://github.com/oracle/docker-images
This will create the required directories and files under <work directory>/docker-images.
The files required for creation of the Oracle Unified Directory image can be located in the <work directory>/docker-images/OracleUnifiedDirectory/dockerfiles/12.2.1.4.0/container-scripts directory:
Oracle Unified Directory image requires additional build commands to set the required environment variables, install os packages and copy the additional build files to the image being built.
A sample additional build commands input file can be found at <work directory>/docker-images/OracleUnifiedDirectory/imagetool/12.2.1.4.0/additionalBuildCmds.txt, containing the following additional build commands:
[before-jdk-install]
# Instructions/Commands to be executed Before JDK install
[after-jdk-install]
# Instructions/Commands to be executed After JDK install
[final-build-commands]
ENV BASE_DIR=/u01 \
ORACLE_HOME=/u01/oracle \
SCRIPT_DIR=/u01/oracle/container-scripts \
USER_PROJECTS_DIR=/u01/oracle/user_projects \
OUD_INSTANCE_NAME=${OUD_INSTANCE_NAME:-asinst_1} \
PATH=$PATH:${JAVA_HOME}/bin:/u01/oracle/oracle_common/common/bin:/u01/oracle/wlserver/common/bin:/u01/oracle/container-scripts
USER root
RUN mkdir -p ${USER_PROJECTS_DIR} && \
chown -R oracle:oracle ${USER_PROJECTS_DIR} && chmod -R 770 ${USER_PROJECTS_DIR} && \
mkdir -p ${SCRIPT_DIR} && chown oracle:oracle ${SCRIPT_DIR} && \
yum install -y libaio hostname vi && \
rm -rf /var/cache/yum
COPY --chown=oracle:oracle files/container-scripts/ ${SCRIPT_DIR}/
RUN chmod a+xr ${SCRIPT_DIR}/* && \
chown -R oracle:oracle ${SCRIPT_DIR}
USER oracle
# Disabling Enpoint Identification for selected CLIs to allow connecting to OUD Instance with any hostname \
RUN echo "" >> ${ORACLE_HOME}/oud/config/java.properties && \
echo "dsconfig.java-args=-client -Dcom.sun.jndi.ldap.object.disableEndpointIdentification=true" >> ${ORACLE_HOME}/oud/config/java.properties && \
echo "dsreplication.java-args=-client -Dcom.sun.jndi.ldap.object.disableEndpointIdentification=true" >> ${ORACLE_HOME}/oud/config/java.properties && \
echo "uninstall.java-args=-client -Dcom.sun.jndi.ldap.object.disableEndpointIdentification=true" >> ${ORACLE_HOME}/oud/config/java.properties && \
echo "status.java-args=-client -Dcom.sun.jndi.ldap.object.disableEndpointIdentification=true" >> ${ORACLE_HOME}/oud/config/java.properties && \
echo "import-ldif.online.java-args=-client -Dcom.sun.jndi.ldap.object.disableEndpointIdentification=true" >> ${ORACLE_HOME}/oud/config/java.properties && \
echo "manage-suffix.java-args=-client -Dcom.sun.jndi.ldap.object.disableEndpointIdentification=true" >> ${ORACLE_HOME}/oud/config/java.properties && \
echo "ldapmodify.java-args=-client -Dcom.sun.jndi.ldap.object.disableEndpointIdentification=true" >> ${ORACLE_HOME}/oud/config/java.properties && \
echo "ldapsearch.java-args=-client -Dcom.sun.jndi.ldap.object.disableEndpointIdentification=true" >> ${ORACLE_HOME}/oud/config/java.properties && \
echo "start-ds.java-args=-server -Xms256m -Dcom.sun.jndi.ldap.object.disableEndpointIdentification=true" >> ${ORACLE_HOME}/oud/config/java.properties && \
${ORACLE_HOME}/oud/bin/dsjavaproperties
# run container health check
HEALTHCHECK --interval=1m --start-period=5m \
CMD "${SCRIPT_DIR}/checkOUDInstance.sh" > /dev/null || exit 1
# Create and Start OUD Instance
# ENTRYPOINT ["sh", "-c", "${SCRIPT_DIR}/createAndStartOUDInstance.sh"]
CMD ["sh", "-c", "${SCRIPT_DIR}/createAndStartOUDInstance.sh"]
Add the required installers, packages & patches to the imagetool cache.
Navigate to the imagetool/bin directory and run the following commands. In the below examples substitute <work directory>/stage for the directory where the appropriate files reside.
$ ./imagetool.sh cache addInstaller --type jdk --version 8u261 --path <work directory>/stage/jdk-8u261-linux-x64.tar.gzFor example:
$ ./imagetool.sh cache addInstaller --type jdk --version 8u261 --path /scratch/OUDDockerK8S/stage/jdk-8u261-linux-x64.tar.gz
[INFO ] Successfully added to cache. jdk_8u261=/scratch/OUDDockerK8S/stage/jdk-8u261-linux-x64.tar.gz
$
$ ./imagetool.sh cache addInstaller --type oud --version 12.2.1.4.0 --path <work directory>/stage/fmw_12.2.1.4.0_oud.jar
For example:
$ ./imagetool.sh cache addInstaller --type oud --version 12.2.1.4.0 --path /scratch/OUDDockerK8S/stage/fmw_12.2.1.4.0_oud.jar
[INFO ] Successfully added to cache. oud_12.2.1.4.0=/scratch/OUDDockerK8S/stage/fmw_12.2.1.4.0_oud.jar
$
In case, patches are required to be included in image, downloaded patches should be added to Imagetool cache.
$ ./imagetool.sh cache addEntry --key 28186730_13.9.4.2.2 --value <work directory>/stage/p28186730_139422_Generic.zip
$ ./imagetool.sh cache addEntry --key 31400392_12.2.1.4.0 --value <work directory>/stage/p31400392_122140_Generic.zipFor example:
$ ./imagetool.sh cache addEntry --key 28186730_13.9.4.2.2 --value /scratch/OUDDockerK8S/stage/p28186730_139422_Generic.zip
[INFO ] Added entry 28186730_13.9.4.2.2=/scratch/OUDDockerK8S/stage/p28186730_139422_Generic.zip
$ ./imagetool.sh cache addEntry --key 31400392_12.2.1.4.0 --value /scratch/OUDDockerK8S/stage/p31400392_122140_Generic.zip
[INFO ] Added entry 31400392_12.2.1.4.0=/scratch/OUDDockerK8S/stage/p31400392_122140_Generic.zip
$
Execute the imagetool create command to create the Oracle Unified Directory image.
The following parameters are provided as input to the create command,
- jdkVersion - JDK version to be used in the image.
- type - type of image to be built.
- version - version of the image.
- tag - tag name for the image.
- additionalBuildCommands - additional build commands provided as a text file.
- addtionalBuildFiles - path of additional build files as comma separated list.
Below a sample command used to build Oracle Unified Directory image,
$ ./imagetool.sh create --jdkVersion=8u261 --type oud --version=12.2.1.4.0 \
--tag=oracle/oud:12.2.1.4.0 \
--additionalBuildCommands <work directory>/docker-images/OracleUnifiedDirectory/imagetool/12.2.1.4.0/additionalBuildCmds.txt \
--additionalBuildFiles <work directory>/docker-images/OracleUnifiedDirectory/dockerfiles/12.2.1.4.0/container-scripts \
--patches <patch_a>,<patch_b>,...
--patches option is required only when image is required to be generated with patches
For example:
$ ./imagetool.sh create --jdkVersion=8u261 --type oud --version=12.2.1.4.0 \
--tag=oracle/oud:12.2.1.4.0 \
--additionalBuildCommands /scratch/OUDDockerK8S/docker-images/OracleUnifiedDirectory/imagetool/12.2.1.4.0/additionalBuildCmds.txt \
--additionalBuildFiles /scratch/OUDDockerK8S/docker-images/OracleUnifiedDirectory/dockerfiles/12.2.1.4.0/container-scripts \
--patches 28186730,31400392
--patches option is required only when image is required to be generated with patches
Run the docker images command to ensure the new Oracle Unified Directory image is loaded into the repository:
$ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
oracle/oud 12.2.1.4.0 8a937042bef3 9 minutes ago 992MB
...
If you want to review a sample dockerfile created with the imagetool issue the imagetool command with the --dryRun option:
./imagetool.sh @<work directory>/docker-images/OracleUnifiedDirectory/imagetool/12.2.1.4.0/additionalBuildCmds.txt --dryRun
To download and run Oracle Fusion Middleware products, regardless whether inside or outside a container, you must download the binaries from the Oracle website and accept the license indicated at that page.
All scripts and files hosted in this project and GitHub docker-images/OracleUnifiedDirectory repository required to build the images are, unless otherwise noted, released under UPL 1.0 license.
Copyright (c) 2020 Oracle and/or its affiliates. Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl