The create
command helps build a WebLogic container image from a given base OS image.
There are a number of optional parameters for this feature. The required option for the command is marked.
NOTE: The WebLogic Image Tool does not support a Stack Patch Bundle (SPB; see Doc ID 2764636.1), because an SPB is not a patch but a mechanism for applying all PSU and recommended CPU and SPU patches to a WebLogic Server installation, similar to invoking the Image Tool create
command with the --recommendedPatches
option.
Usage: imagetool create [OPTIONS]
Parameter | Definition | Default |
---|---|---|
--tag |
(Required) Tag for the final build image. Example: store/oracle/weblogic:12.2.1.3.0 |
|
--additionalBuildCommands |
Path to a file with additional build commands. For more details, see Additional information. | |
--additionalBuildFiles |
Additional files that are required by your additionalBuildCommands . A comma separated list of files that should be copied to the build context. See Additional information. |
|
--builder , -b |
Executable to process the Dockerfile. Use the full path of the executable if not on your path. | Defaults to docker , or, when set, to the value in environment variable WLSIMG_BUILDER . |
--buildNetwork |
Networking mode for the RUN instructions during the image build. See --network for Docker build . |
|
--chown |
userid:groupid to be used for creating files within the image, such as the JDK, the FMW/WLS installs, etc. If the user or group does not exist in the image, they will be added with useradd/groupadd. |
oracle:oracle |
--docker |
(DEPRECATED) Path to the Docker executable. Use --builder instead. |
docker |
--dryRun |
Skip Docker build execution and print the Dockerfile to stdout. | |
--fromImage |
Container image to use as a base image when creating a new image. | ghcr.io/oracle/oraclelinux:8-slim |
--httpProxyUrl |
Proxy for the HTTP protocol. Example: http://myproxy:80 or http:user:passwd@myproxy:8080 |
|
--httpsProxyUrl |
Proxy for the HTTPS protocol. Example: https://myproxy:80 or https:user:passwd@myproxy:8080 |
|
--installerResponseFile |
One or more custom response files. A comma separated list of paths to installer response files. Overrides the default responses for the Oracle silent installer. | |
--inventoryPointerFile |
Path to custom inventory pointer file. | |
--inventoryPointerInstallLoc |
Target location for the inventory pointer file. | |
--jdkVersion |
Version of the server JDK to install. | 8u202 |
--latestPSU |
Find and apply the latest PatchSet Update. | |
--opatchBugNumber |
The patch number for OPatch (patching OPatch). | 28186730 |
--packageManager |
Override the default package manager for the base image’s operating system. Supported values: APK , APTGET , NONE , OS_DEFAULT , YUM , ZYPPER |
OS_DEFAULT |
--password |
Request password for the Oracle Support --user on STDIN, see --user . |
|
--passwordEnv |
Environment variable containing the Oracle Support password, see --user . |
|
--passwordFile |
Path to a file containing just the Oracle Support password, see --user . |
|
--patches |
Comma separated list of patch IDs. Example: 12345678,87654321 |
|
--platform |
Set the target platform to build. Supported values: linux/amd64 or linux/arm64 . |
|
--pull |
Always attempt to pull a newer version of base images during the build. | |
--recommendedPatches |
Find and apply the latest PatchSet Update and recommended patches. This takes precedence over --latestPSU . |
|
--resourceTemplates |
One or more files containing placeholders that need to be resolved by the Image Tool. See Resource Template Files. | |
--skipcleanup |
Do not delete the build context folder, intermediate images, and failed build containers. For debugging purposes. | |
--strictPatchOrdering |
Instruct OPatch to apply patches one at a time (uses apply instead of napply ). |
|
--target |
Select the target environment in which the created image will be used. Supported values: Default (Docker/Kubernetes), OpenShift . See Additional information. |
Default |
--type |
Installer type. Supported values: WLS , WLSDEV , WLSSLIM , FMW , IDM , OSB , OUD_WLS , SOA_OSB , SOA_OSB_B2B , MFT , WCP , OAM , OIG , OUD , OID , ODI , SOA , WCC , WCS , WCP |
WLS |
--user |
Oracle support email ID. When supplying user , you must supply the password either as an environment variable using --passwordEnv , or as a file using --passwordFile , or interactively, on the command line with --password . |
|
--version |
Installer version. | 12.2.1.3.0 |
--wdtArchive |
A WDT archive ZIP file or comma-separated list of files. | |
--wdtDomainHome |
Path to the -domain_home for WDT. |
/u01/domains/base_domain |
--wdtDomainType |
WDT domain type. Supported values: WLS , JRF , RestrictedJRF |
WLS |
--wdtEncryptionKey |
Passphrase for WDT -use_encryption that will be requested on STDIN. |
|
--wdtEncryptionKeyEnv |
Passphrase for WDT -use_encryption that is provided as an environment variable. |
|
--wdtEncryptionKeyFile |
Passphrase for WDT -use_encryption that is provided as a file. |
|
--wdtHome |
The target folder in the image for the WDT install and models. | /u01/wdt |
--wdtJavaOptions |
Java command-line options for WDT. | |
--wdtModel |
A WDT model file or a comma-separated list of files. | |
--wdtModelHome |
The target location in the image to copy WDT model, variable, and archive files. | {wdtHome}/models |
--wdtModelOnly |
Install WDT and copy the models to the image, but do not create the domain. | false |
--wdtRunRCU |
Instruct WDT to run RCU when creating the domain. | |
--wdtStrictValidation |
Use strict validation for the WDT validation method. Only applies when using model only. | false |
--wdtVariables |
A WDT variables file or comma-separated list of files. | |
--wdtVersion |
WDT version to use. | latest |
--additionalBuildCommands
This is an advanced option that let’s you provide additional commands to the Docker build step.
The input for this parameter is a simple text file that contains one or more of the valid sections.
Valid sections for create are:
Section | Available Variables | Build Stage | Timing |
---|---|---|---|
initial-build-commands |
None | All | As root, and before any Image Tool actions. |
package-manager-packages |
None | All | A list of OS packages, such as ftp gzip , separated by line or space. |
before-jdk-install |
JAVA_HOME |
Intermediate (JDK_BUILD) | Before the JDK is installed. |
after-jdk-install |
JAVA_HOME |
Intermediate (JDK_BUILD) | After the JDK is installed. |
before-fmw-install |
JAVA_HOME ORACLE_HOME |
Intermediate (WLS_BUILD) | Before the Oracle Home is created. |
after-fmw-install |
JAVA_HOME ORACLE_HOME |
Intermediate (WLS_BUILD) | After all of the Oracle middleware installers are finished. |
before-wdt-command |
DOMAIN_HOME |
Intermediate (WDT_BUILD) | Before WDT is installed. |
after-wdt-command |
DOMAIN_HOME |
Intermediate (WDT_BUILD) | After WDT domain creation/update is complete. |
final-build-commands |
JAVA_HOME ORACLE_HOME DOMAIN_HOME |
Final image | After all Image Tool actions are complete, and just before the container image is finalized. DOMAIN_HOME is only available if WDT was used during the build. |
NOTE: Changes made in intermediate stages may not be carried forward to the final image unless copied manually.
The Image Tool will copy the Java Home, Oracle Home, domain home, and WDT home directories to the final image.
Changes fully contained within these directories do not need an additional COPY
command in the final-build-commands
section.
Each section can contain one or more valid Dockerfile commands and would look like the following:
[after-fmw-install]
RUN rm /some/dir/unnecessary-file
COPY --chown=oracle:oracle files/my_additional_file.txt /u01
[final-build-commands]
LABEL owner="middleware team"
--additionalBuildFiles
This option provides a way to supply additional files to the image build command.
All provided files and directories are copied directly under the files
subfolder of the build context.
To get those files into the image, additional build commands must be provided using the additionalBuildCommands
options.
Access to these files using a build command, such as COPY
or ADD
, should use the original filename
with the folder prefix, files/
. For example, if the
original file was provided as --additionalBuildFiles /scratch/test1/convenience.sh
, the Docker build command COPY
provided in --additionalBuildCommands
should look like
COPY --chown=oracle:oracle files/convenience.sh /my/internal/image/location
.
Because Image Tool uses multi-stage
builds, it is important to place the build command (like COPY
) in the appropriate section of the Dockerfile
based
on when the build needs access to the file. For example, if the file is needed in the final image and not for
installation or domain creation steps, use the final-build-commands
section so that the COPY
command occurs in the
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.
--target
By default, the generated WLS domain in your image will use the best practices defined by Oracle WebLogic Server.
The target
option allows you to toggle the defaults so that the generated domain is easier to use in the target
environment. For example, the --target OpenShift
option will change the file permissions in the domain directory
so that the group permissions match the user permissions.
Target | Default File Permissions | Default File Ownership |
---|---|---|
Default |
rwxr-x--- |
oracle:oracle |
OpenShift |
rwxrwx--- |
oracle:root |
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 . |
You can save all arguments passed for the Image Tool in a file, then use the file as a parameter.
For example, create a file called build_args
:
create
--type wls
--version 12.2.1.3.0
--tag wls:122130
--user acmeuser@mycompany.com
--httpProxyUrl http://mycompany-proxy:80
--httpsProxyUrl http://mycompany-proxy:80
--passwordEnv MYPWD
Use it on the command line, as follows:
$ imagetool @/path/to/build_args
Note: Use --passwordEnv
or --passwordFile
instead of --password
.
The following commands assume that all the required JDK, WLS, or FMW (WebLogic infrastructure) installers have been downloaded to the cache directory. Use the cache command to set it up.
Create an image named sample:wls
with the WebLogic installer 12.2.1.3.0, server JDK 8u202, and latest PSU applied.
$ imagetool create --tag sample:wls --latestPSU --user testuser@xyz.com --password hello
Create an image named sample:wdt
with the same options as above and create a domain with WebLogic Deploy Tooling.
$ imagetool create --tag sample:wdt --latestPSU --user testuser@xyz.com --password hello --wdtModel /path/to/model.json --wdtVariables /path/to/variables.json --wdtVersion 0.16
If wdtVersion
is not provided, the tool uses the latest release.
Create an image named sample:patch
with the selected patches applied.
$ imagetool create --tag sample:patch --user testuser@xyz.com --password hello --patches 12345678,p87654321
The patch numbers may or may not start with ‘p
’.