11# Quick Start
22
3- The Image Tool supports creating WebLogic Docker image , applying WebLogic patches, and creating WebLogic domains. It
3+ The Image Tool supports creating WebLogic Docker images , applying WebLogic patches, and creating WebLogic domains. It
44can be used with or without Internet access.
55
6- Before you use the tool, you can customize the tool's cache store. The cache store is used to look up where the Java,
6+ Before you use the tool, you can customize the tool's cache store. The cache store is used to look up where the Java,
77WebLogic installers, and WebLogic patches reside in the local file system.
88
9- By default, it is stored in the user's ``` $HOME/cache ``` directory. Under this directory, the look up information is
9+ By default, it is stored in the user's ``` $HOME/cache ``` directory. Under this directory, the lookup information is
1010stored in the file ``` .metadata ``` . All automatically downloaded patches also reside in this directory.
1111
1212This default cache store location can be changed by running the ``` setCacheDir ``` command before using the cache store:
@@ -19,17 +19,17 @@ The high level steps for creating an image are:
1919
20201 . Download the Java and WebLogic installers from Oracle Software Delivery Cloud.
21212 . Add the installers to the cache store.
22- 3 . Optionally download any WebLogic patches and add them to the cache store.
22+ 3 . Optionally, download any WebLogic patches and add them to the cache store.
23234 . Run the ``` imagetool ``` command to create or update an image.
2424
25-
26- For example, you have saved the installers in /home/acmeuser/wls-installers as
25+
26+ For example, if you have saved the installers in /home/acmeuser/wls-installers as:
2727
2828fmw_12.2.1.3.0_wls_Disk1_1of1.zip\
2929jdk-8u202-linux-x64.tar.gz
30-
3130
32- Using the Cache Tool to add the installers:
31+
32+ Use the Cache Tool to add the installers:
3333
3434``` bash
3535imagetool cache addInstaller --type jdk --version 8u202 --path /home/acmeuser/wls-installers/jdk-8u202-linux-x64.tar.gz
@@ -41,7 +41,7 @@ imagetool cache addInstaller --type wls --version 12.2.1.3.0 --path /home/acmeus
4141
4242```
4343
44- ** Note** : The value of the version must be a valid WebLogic version number. This version number is used to verify and
44+ ** Note** : The value of the version must be a valid WebLogic version number. This version number is used to verify and
4545find the correct patch file to download from Oracle Support. The format of the version is a 5 digits tuple, separated
4646 by period. For example, ``` 12.2.1.3.0 ``` ``` 12.1.3.0.0 ```
4747
@@ -58,13 +58,13 @@ wls_12.2.1.3.0=/home/acmeuser/wls-installers/fmw_12.2.1.3.0_wls_Disk1_1of1.zip
5858
5959```
6060
61- During the image creation process, the tool creates a temporary directory prefixed by ``` wlsimgbuilder_temp ``` as
62- the context root for the ``` docker build ``` command. This temporary directory will be deleted upon successful
61+ During the image creation process, the tool creates a temporary directory prefixed by ``` wlsimgbuilder_temp ``` as
62+ the context root for the ``` docker build ``` command. This temporary directory will be deleted upon successful
6363completion.
64-
64+
6565By default, it is created under the user's home directory. If you do not want to create the temporary directory under
6666 the home directory, you can first set the environment variable by:
67-
67+
6868 ``` bash
6969export WLSIMG_BLDDIR=/path/to/dir
7070```
@@ -82,36 +82,36 @@ drwxr-xr-x 18 root root 4096 May 29 01:31 ..
8282```
8383
8484
85- ## Creating image with full Internet access
85+ ## Creating an image with full Internet access
8686
87- In this use case, the image tool will:
87+ In this use case, the Image Tool will:
8888
89- 1 . Start with a base level operating system image (oracle-linux:7-slim).
89+ 1 . Start with a base- level operating system image (oracle-linux:7-slim).
90902 . Automatically update the image with the necessary packages for installing WebLogic.
91913 . Install Java and WebLogic based on the provided installers.
92- 4 . Optionally automatically download and apply patches specified.
93- 5 . Optionally create a WebLogic domain with the WebLogic Deploy Tool.
92+ 4 . Optionally, automatically download and apply the patches specified.
93+ 5 . Optionally, create a WebLogic domain with the WebLogic Deploy Tool.
9494
9595
96- After you have downloaded the Java and WebLogic installers described before , you can create the image using the [ Create
96+ After you have downloaded the Java and WebLogic installers described previously , you can create the image using the [ Create
9797Tool commands] ( create-image.md ) . For example:
9898
9999``` bash
100100imagetool create --tag wls:12.2.1.3.0 --latestPSU --version 12.2.1.3.0 --user username@mycompany.com --passwordEnv MYPWD [--httpProxyUrl http://company-proxy:80 --httpsProxyUrl http://company-proxy:80]
101101```
102102
103- where ``` --user --passwordEnv ``` provides the credentials for the user who is entitled to download patches from Oracle
104- Support
103+ where ``` --user --passwordEnv ``` provides the credentials for the user who is entitled to download patches from Oracle
104+ Support.
105105
106106You will see the Docker command output as the tool runs:
107107
108108``` bash
109- [2019-05-28 10:37:02] [com.oracle.weblogic.imagetool.cli.menu.CreateImage] [INFO ] tmp directory used for build
110- context: /home/acmeuser/wlsimgbuilder_temp8791654163579491583
111- [2019-05-28 10:37:09] [com.oracle.weblogic.imagetool.cli.menu.CreateImage] [INFO ] docker cmd = docker build
112- --force-rm --rm=true --no-cache --tag wls:12.2.1.3.0 --build-arg http_proxy=http://company-proxy.com:80 --build-arg
113- https_proxy=http://company-proxy.com:80 --build-arg WLS_PKG=fmw_12.2.1.3.0_wls_Disk1_1of1.zip --build-arg
114- JAVA_PKG=jdk-8u201-linux-x64.tar.gz --build-arg PATCHDIR=patches /home/acmeuser/wlsimgbuilder_temp8791654163579491583
109+ [2019-05-28 10:37:02] [com.oracle.weblogic.imagetool.cli.menu.CreateImage] [INFO ] tmp directory used for build
110+ context: /home/acmeuser/wlsimgbuilder_temp8791654163579491583
111+ [2019-05-28 10:37:09] [com.oracle.weblogic.imagetool.cli.menu.CreateImage] [INFO ] docker cmd = docker build
112+ --force-rm --rm=true --no-cache --tag wls:12.2.1.3.0 --build-arg http_proxy=http://company-proxy.com:80 --build-arg
113+ https_proxy=http://company-proxy.com:80 --build-arg WLS_PKG=fmw_12.2.1.3.0_wls_Disk1_1of1.zip --build-arg
114+ JAVA_PKG=jdk-8u201-linux-x64.tar.gz --build-arg PATCHDIR=patches /home/acmeuser/wlsimgbuilder_temp8791654163579491583
115115Sending build context to Docker daemon 1.08GB
116116
117117Step 1/46 : ARG BASE_IMAGE=oraclelinux:7-slim
@@ -133,38 +133,38 @@ oraclelinux 7-slim f7512ac13c1b 6 weeks ago
133133
134134```
135135
136- ## Creating image with no Internet access
136+ ## Creating an image with no Internet access
137137
138138
139- In this use case, because there is no Internet access. You will be responsible for downloading all the installers and
140- patches, plus setting up the cache. You also have to provide a base operating system image that has the following packages
139+ In this use case, because there is no Internet access, you will be responsible for downloading all the installers and
140+ patches, plus setting up the cache. You also have to provide a base operating system image that has the following packages
141141installed.
142142
143143
144144``` bash
145- gzip
146- tar
145+ gzip
146+ tar
147147unzip
148148```
149149
150- For each WebLogic patch, you will need to download it from Oracle Support and set up the cache. For example, if you downloaded patch number
150+ For each WebLogic patch, you will need to download it from Oracle Support and set up the cache. For example, if you downloaded patch number
15115127342434 for WebLogic version 12.2.1.3.0:
152-
152+
153153``` bash
154154imagetool cache addPatch --patchId 27342434 --version 12.2.1.3.0 --path /home/acmeuser/cache/p27342434_122130_Generic .zip -user username@mycompany.com --passwordEnv MYPWD
155155```
156156
157- You need to provide the credentials in the command line. It verifies the MD5 on the file system against the meta data
158- on Oracle Support for this patch number
157+ You need to provide the credentials on the command line. It verifies the MD5 on the file system against the metadata
158+ on Oracle Support for this patch number.
159159
160160Then, you can run the command to create the image:
161161
162162``` bash
163163imagetool create --fromImage myosimg:latest --tag wls:12.2.1.3.0 --patches 27342434 --version 12.2.1.3.0 --useCache always
164164```
165165
166- Sometimes, a WebLogic patch may require patching the OPatch binaries before applying them. We recommend
167- downloading the latest OPatch patch and setup the cache. For example, the latest OPatch patch is 28186730, 13.9
166+ Sometimes, a WebLogic patch may require patching the OPatch binaries before applying them. We recommend
167+ downloading the latest OPatch patch and setting up the cache. For example, the latest OPatch patch is 28186730, 13.9
168168.4.0.0. You can use this command to set up the cache after downloading from Oracle Support.
169169
170170``` bash
@@ -173,57 +173,56 @@ imagetool cache addPatch --patchId 28186730 --version 13.9.4.0.0 --path /home/ac
173173
174174## Patching an existing image
175175
176- This use case allows you apply WebLogic patches to an existing image. It works similarly to previous use cases, you
177- have the option to automatically download using the tool or manual downloading the patches.
176+ This use case allows you to apply WebLogic patches to an existing image. It works similarly to previous use cases; you
177+ have the option to automatically download using the tool or manually downloading the patches.
178178
179- Once the cache is setup, you can use the following command to update an image:
179+ After the cache is setup, you can use the following command to update an image:
180180
181181``` bash
182182imagetool update --fromImage wls:12.2.1.3.0 --tag wls:12.2.1.3.4 --patches 27342434 --version 12.2.1.3.0 --useCache always
183183```
184184
185- ## Create an image with a WebLogic Domain using WebLogic Deploy Tool
185+ ## Create an image with a WebLogic domain using the WebLogic Deploy Tool
186186
187- The Image Tool allows creating a customized WebLogic domain in the image using [ WebLogic Deploy Tool] (https://github
188- .com/oracle/weblogic-deploy-tooling).
187+ The Image Tool allows creating a customized WebLogic domain in the image using the [ WebLogic Deploy Tool] ( https://github.com/oracle/weblogic-deploy-tooling ) .
189188
190189You can accomplish this by:
191190
192- Download the [ WebLogic Deploy Tool from ] ( https://github.com/oracle/weblogic-deploy-tooling/releases ) , then add it to the cache store
191+ Download the [ WebLogic Deploy Tool] ( https://github.com/oracle/weblogic-deploy-tooling/releases ) , and then add it to the cache store:
193192
194193``` bash
195194imagetool cache addInstaller --type wdt --version 2.2 --path /home/acmeuser/cache/weblogic-deploy.zip
196195```
197196
198- Provide the command line options for WebLogic Deploy Tool
197+ Provide the command- line options for the WebLogic Deploy Tool:
199198
200199``` bash
201200imagetool create --fromImage myosimg:latest --tag wls:12.2.1.3.0 --patches 27342434 --version 12.2.1.3.0 --useCache always --wdtVersion 2.2 --wdtArchive /home/acmeuser/wdt/domain1.zip --wdtDomainHome /u01/domains/simple_domain
202201```
203202
204- The parameters mapping between Image Tool and WebLogic Deploy Tool are:
203+ The parameters mapping between the Image Tool and the WebLogic Deploy Tool are:
205204
206205| Image Tool | WebLogic Deploy Tool |
207206| --------------------| -------------------------|
208- | --wdtArchive | -archive_file |
209- | --wdtModel | -model_file |
210- | --wdtVariables | -variable_file |
211- | --run_rcu | -run_rcu |
212- | --wdtDomainHome | -domain_home |
207+ | ` --wdtArchive ` | ` -archive_file ` |
208+ | ` --wdtModel ` | ` -model_file ` |
209+ | ` --wdtVariables ` | ` -variable_file ` |
210+ | ` --run_rcu ` | ` -run_rcu ` |
211+ | ` --wdtDomainHome ` | ` -domain_home ` |
213212
214213
215214The domain will be created under ``` /u01/domains/base_domain ``` if you do not specify ``` --wdtDomainHome ``` .
216215
217- ** Note** : If you are creating a JRF domain and want WebLogic Deploying Tool to create the RCU schemas for you, you can
218- specify the connection info in the model [ Specifying RCU
219- information in the model] ( https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/rcuinfo.md )
216+ ** Note** : If you are creating a JRF domain and want WebLogic Deploy Tool to create the RCU schemas for you, you can
217+ specify the connection information in the model, see [ Specifying RCU
218+ information in the model] ( https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/rcuinfo.md ) .
220219
221220
222221## Using an argument file
223222
224223All arguments passed for the Image Tool can be saved in a file and then you use the file as a parameter. For example:
225224
226- Create a file called build_args:
225+ Create a file called ` build_args ` :
227226
228227``` bash
229228create
@@ -237,7 +236,7 @@ create
237236
238237```
239238
240- and use it in the command line as:
239+ Use it on the command line as:
241240
242241``` bash
243242imagetool @/path/to/build_args
@@ -246,10 +245,10 @@ imagetool @/path/to/build_args
246245
247246## Cleanup
248247
249- As described in the beginning, the Image Tool creates a temporary directory prefixed by ``` wlsimgbuilder_temp ```
250- every time it runs. This directory will be deleted under normal circumstances, however if the process is aborted,
248+ As described in the beginning, the Image Tool creates a temporary directory prefixed by ``` wlsimgbuilder_temp ```
249+ every time it runs. This directory will be deleted under normal circumstances, however, if the process is aborted,
251250the directory needs to be deleted manually.
252-
251+
253252If you see dangling images after the build, you can use the following commands to remove them:
254253
255254``` bash
@@ -258,8 +257,8 @@ docker rmi $(docker images --filter "dangling=true" -q --no-trunc)
258257
259258## Logging
260259
261- In a rare circumstance , it may be helpful to turn on debugging to reveal more information. The tool uses the standard
262- logging.properties file under the tool's ``` bin ``` directory.
260+ In rare circumstances , it may be helpful to turn on debugging to reveal more information. The tool uses the standard
261+ ` logging.properties ` file under the tool's ``` bin ``` directory.
263262
264263
265264## Copyright
0 commit comments