Skip to content

Commit e690dae

Browse files
authoredApr 7, 2022
edits per Derek, plus some (#355)
1 parent 33908c8 commit e690dae

File tree

5 files changed

+37
-36
lines changed

5 files changed

+37
-36
lines changed
 

‎documentation/1.11/content/userguide/tools/create-aux-image.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ description: "The createAuxImage command creates a new container image with WDT
77
---
88

99

10-
The `createAuxImage` command helps build a container image from a given base OS image.
11-
Auxiliary images are very small images providing the WDT install files with WDT models, archives, and variables
10+
The `createAuxImage` command helps build a container image from a given base OS image.
11+
Auxiliary images are very small images providing the WDT install files with WDT models, archives, and variables
1212
for [WebLogic Kubernetes Operator - Auxiliary Images](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/model-in-image/auxiliary-images/).
13-
These images are an alternative approach for including Model-in-Image model files, application archive files, WebLogic Deploying Tooling installation files, or other types of files,
13+
These images are an alternative approach for including Model-in-Image model files, application archive files, WebLogic Deploying Tooling installation files, or other types of files,
1414
in your WebLogic Server Kubernetes Operator environment.
1515

1616
There are a number of optional parameters for this feature. The required option for the command is marked.
@@ -22,8 +22,8 @@ Usage: imagetool createAuxImage [OPTIONS]
2222
| Parameter | Definition | Default |
2323
| --- | --- | --- |
2424
| `--tag` | (Required) Tag for the final build image. Example: `store/oracle/mydomain:1` | |
25-
| `--additionalBuildCommands` | Path to a file with additional build commands. For more details, see [Additional information](#additional-information). |
26-
| `--additionalBuildFiles` | Additional files that are required by your `additionalBuildCommands`. A comma separated list of files that should be copied to the build context. |
25+
| `--additionalBuildCommands` | Path to a file with additional build commands. For more details, see [Additional information](#--additionalbuildcommands). |
26+
| `--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](#--additionalbuildfiles). |
2727
| `--builder`, `-b` | Executable to process the Dockerfile. Use the full path of the executable if not on your path. | `docker` |
2828
| `--buildNetwork` | Networking mode for the RUN instructions during the image build. See `--network` for Docker `build`. | |
2929
| `--chown` | `userid:groupid` for JDK/Middleware installs and patches. | `oracle:oracle` |
@@ -34,13 +34,13 @@ Usage: imagetool createAuxImage [OPTIONS]
3434
| `--packageManager` | Override the default package manager for the base image's operating system. Supported values: `APK`, `APTGET`, `NONE`, `YUM`, `ZYPPER` | |
3535
| `--pull` | Always attempt to pull a newer version of base images during the build. | |
3636
| `--skipcleanup` | Do not delete the build context folder, intermediate images, and failed build containers. For debugging purposes. | |
37-
| `--target` | Select the target environment in which the created image will be used. Supported values: `Default` (Docker/Kubernetes), `OpenShift` | `Default` |
37+
| `--target` | Select the target environment in which the created image will be used. Supported values: `Default` (Docker/Kubernetes), `OpenShift`. See [Additional information](#--target). | `Default` |
3838
| `--wdtArchive` | A WDT archive ZIP file or comma-separated list of files. | |
3939
| `--wdtHome` | The target folder in the image for the WDT install and models. | `/auxiliary` |
4040
| `--wdtModel` | A WDT model file or a comma-separated list of files. | |
4141
| `--wdtModelHome` | The target location in the image to copy WDT model, variable, and archive files. | `{wdtHome}/models` |
4242
| `--wdtVariables` | A WDT variables file or comma-separated list of files. | |
43-
| `--wdtVersion` | WDT version to be installed in the container image in {wdtHome}/weblogic-deploy. For more details, see [Additional information](#additional-information). | `latest` |
43+
| `--wdtVersion` | WDT version to be installed in the container image in `{wdtHome}/weblogic-deploy`. For more details, see [Additional information](#--wdtversion). | `latest` |
4444

4545
### Additional information
4646

@@ -93,7 +93,7 @@ Use the same value for `--target` when creating images with `create` and `create
9393
#### `--wdtVersion`
9494

9595
As of version 1.11.0, you may opt to install WDT and the model files in separate images. By default, the cached `wdt_latest`
96-
version of WDT is installed in the Auxiliary image with the selected models, archives, and variable files. If you use
96+
version of WDT is installed in the Auxiliary image with the selected models, archives, and variable files. If you use
9797
`--wdtVersion=none` (case insensitive), the auxiliary image will be created without installing WDT.
9898

9999
#### Use an argument file

‎documentation/1.11/content/userguide/tools/create-image.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Usage: imagetool create [OPTIONS]
1919
| Parameter | Definition | Default |
2020
| --- | --- | --- |
2121
| `--tag` | (Required) Tag for the final build image. Example: `store/oracle/weblogic:12.2.1.3.0` | |
22-
| `--additionalBuildCommands` | Path to a file with additional build commands. For more details, see [Additional information](#additional-information). |
23-
| `--additionalBuildFiles` | Additional files that are required by your `additionalBuildCommands`. A comma separated list of files that should be copied to the build context. |
22+
| `--additionalBuildCommands` | Path to a file with additional build commands. For more details, see [Additional information](#--additionalbuildcommands). |
23+
| `--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](#--additionalbuildfiles). |
2424
| `--builder`, `-b` | Executable to process the Dockerfile. Use the full path of the executable if not on your path. | `docker` |
2525
| `--buildNetwork` | Networking mode for the RUN instructions during the image build. See `--network` for Docker `build`. | |
2626
| `--chown` | `userid:groupid` for JDK/Middleware installs and patches. | `oracle:oracle` |
@@ -34,20 +34,20 @@ Usage: imagetool create [OPTIONS]
3434
| `--inventoryPointerInstallLoc` | Target location for the inventory pointer file. | |
3535
| `--jdkVersion` | Version of the server JDK to install. | `8u202` |
3636
| `--latestPSU` | Find and apply the latest PatchSet Update. | |
37-
| `--recommendedPatches` | Find and apply the latest PatchSet Update and recommended patches. This takes precedence over --latestPSU | |
3837
| `--opatchBugNumber` | The patch number for OPatch (patching OPatch). | `28186730` |
3938
| `--packageManager` | Override the default package manager for the base image's operating system. Supported values: `APK`, `APTGET`, `NONE`, `OS_DEFAULT`, `YUM`, `ZYPPER` | `OS_DEFAULT` |
4039
| `--password` | Request password for the Oracle Support `--user` on STDIN, see `--user`. | |
4140
| `--passwordEnv` | Environment variable containing the Oracle Support password, see `--user`. | |
4241
| `--passwordFile` | Path to a file containing just the Oracle Support password, see `--user`. | |
4342
| `--patches` | Comma separated list of patch IDs. Example: `12345678,87654321` | |
4443
| `--pull` | Always attempt to pull a newer version of base images during the build. | |
44+
| `--recommendedPatches` | Find and apply the latest PatchSet Update and recommended patches. This takes precedence over `--latestPSU`. | |
4545
| `--resourceTemplates` | One or more files containing placeholders that need to be resolved by the Image Tool. See [Resource Template Files](#resource-template-files). | |
4646
| `--skipcleanup` | Do not delete the build context folder, intermediate images, and failed build containers. For debugging purposes. | |
4747
| `--strictPatchOrdering` | Instruct OPatch to apply patches one at a time (uses `apply` instead of `napply`). | |
48-
| `--target` | Select the target environment in which the created image will be used. Supported values: `Default` (Docker/Kubernetes), `OpenShift` | `Default` |
48+
| `--target` | Select the target environment in which the created image will be used. Supported values: `Default` (Docker/Kubernetes), `OpenShift`. See [Additional information](#--target). | `Default` |
4949
| `--type` | Installer type. Supported values: `WLS`, `WLSDEV`, `WLSSLIM`, `FMW`, `IDM`, `OSB`, `OUD_WLS`, `SOA_OSB`, `SOA_OSB_B2B`, `MFT`, `WCP`, `OAM`, `OIG`, `OUD`, `OID`, `SOA`, `WCC`, `WCS`, `WCP` | `WLS` |
50-
| `--user` | Oracle support email ID. | |
50+
| `--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`. | |
5151
| `--version` | Installer version. | `12.2.1.3.0` |
5252
| `--wdtArchive` | A WDT archive ZIP file or comma-separated list of files. | |
5353
| `--wdtDomainHome` | Path to the `-domain_home` for WDT. | `/u01/domains/base_domain` |

‎documentation/1.11/content/userguide/tools/inspect-image.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 10
66
description: "The inspect command reports on the contents of a container image."
77
---
88

9-
The `inspect` command reports on the contents of a container image providing version and location information for Java
9+
The `inspect` command reports on the contents of a container image providing version and location information for Java
1010
and WebLogic installations.
1111

1212
```
@@ -17,7 +17,7 @@ Usage: imagetool inspect [OPTIONS]
1717
| --- | --- | --- |
1818
| `--image`, `-i` | (Required) The image ID or image name to be inspected. | |
1919
| `--builder`, `-b` | Executable to process the Dockerfile. Use the full path of the executable if not on your path. | `docker` |
20-
| `--format` | The output format. Supported values: JSON | `JSON` |
20+
| `--format` | The output format. Supported values: `JSON` | `JSON` |
2121
| `--patches` | Include OPatch information in the output, including a list of WebLogic patches that are applied. | |
2222

2323
#### Use an argument file
@@ -81,4 +81,4 @@ $ imagetool @/path/to/build_args
8181
"packageManager" : "YUM",
8282
"wlsVersion" : "12.2.1.4.0"
8383
}
84-
```
84+
```

‎documentation/1.11/content/userguide/tools/rebase-image.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Usage: imagetool rebase [OPTIONS]
1919
| --- | --- | --- |
2020
| `--sourceImage` | (Required) Source Image containing the WebLogic domain. | |
2121
| `--tag` | (Required) Tag for the final build image. Example: `store/oracle/weblogic:12.2.1.3.0` | |
22-
| `--additionalBuildCommands` | Path to a file with additional build commands. For more details, see [Additional information](#additional-information). |
23-
| `--additionalBuildFiles` | Additional files that are required by your `additionalBuildCommands`. A comma separated list of files that should be copied to the build context. |
22+
| `--additionalBuildCommands` | Path to a file with additional build commands. For more details, see [Additional information](#--additionalbuildcommands). |
23+
| `--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](#--additionalbuildfiles). |
2424
| `--builder`, `-b` | Executable to process the Dockerfile. Use the full path of the executable if not on your path. | `docker` |
2525
| `--buildNetwork` | Networking mode for the RUN instructions during the image build. See `--network` for Docker `build`. | |
2626
| `--chown` | `userid:groupid` for JDK/Middleware installs and patches. | `oracle:oracle` |
@@ -33,20 +33,20 @@ Usage: imagetool rebase [OPTIONS]
3333
| `--inventoryPointerInstallLoc` | Target location for the inventory pointer file. | |
3434
| `--jdkVersion` | Version of the server JDK to install. | `8u202` |
3535
| `--latestPSU` | Find and apply the latest PatchSet Update. | |
36-
| `--recommendedPatches` | Find and apply the latest PatchSet Update and recommended patches. This takes precedence over --latestPSU | |
3736
| `--opatchBugNumber` | The patch number for OPatch (patching OPatch). | `28186730` |
3837
| `--packageManager` | Override the default package manager for the base image's operating system. Supported values: `APK`, `APTGET`, `NONE`, `OS_DEFAULT`, `YUM`, `ZYPPER` | `OS_DEFAULT` |
3938
| `--password` | Request password for the Oracle Support `--user` on STDIN, see `--user`. | |
4039
| `--passwordEnv` | Environment variable containing the Oracle Support password, see `--user`. | |
4140
| `--passwordFile` | Path to a file containing just the Oracle Support password, see `--user`. | |
4241
| `--patches` | Comma separated list of patch IDs. Example: `12345678,87654321` | |
4342
| `--pull` | Always attempt to pull a newer version of base images during the build. | |
43+
| `--recommendedPatches` | Find and apply the latest PatchSet Update and recommended patches. This takes precedence over `--latestPSU`. | |
4444
| `--skipcleanup` | Do not delete the build context folder, intermediate images, and failed build containers. For debugging purposes. | |
4545
| `--strictPatchOrdering` | Instruct OPatch to apply patches one at a time (uses `apply` instead of `napply`). | |
46-
| `--target` | Select the target environment in which the created image will be used. Supported values: `Default` (Docker/Kubernetes), `OpenShift` | `Default` |
46+
| `--target` | Select the target environment in which the created image will be used. Supported values: `Default` (Docker/Kubernetes), `OpenShift`. See [Additional information](#--target). | `Default` |
4747
| `--targetImage` | Container image to extend for the domain's new image. | |
4848
| `--type` | Installer type. Supported values: `WLS`, `WLSDEV`, `WLSSLIM`, `FMW`, `IDM`, `OSB`, `OUD_WLS`, `SOA_OSB`, `SOA_OSB_B2B`, `MFT`, `WCP`, `OAM`, `OIG`, `OUD`, `OID`, `SOA`, `WCC`, `WCS`, `WCP` | `WLS` |
49-
| `--user` | Your Oracle support email ID. | |
49+
| `--user` | Your 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`. | |
5050
| `--version` | Installer version. | `12.2.1.3.0` |
5151

5252
### Additional information

‎documentation/1.11/content/userguide/tools/update-image.md

+16-15
Original file line numberDiff line numberDiff line change
@@ -14,45 +14,40 @@ command to update the existing container images created with the Image Tool. Fo
1414
* Deploy a new application to an existing domain
1515
* Modify the domain configuration (add a data source, change a port number, and such)
1616

17-
**NOTE**: The WebLogic Image Tool does not support a Stack Patch Bundle (SPB; see Doc ID [2764636.1](https://support.oracle.com/rs?type=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 `update` command with the `--recommendedPatches` option.
17+
**NOTE**: The WebLogic Image Tool does not support a Stack Patch Bundle (SPB; see Doc ID [2764636.1](https://support.oracle.com/rs?type=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.
1818

1919
The required options for the `update` command are marked.
2020

21-
**NOTE**: You can provide the password in one of the three ways:
22-
23-
* Plain text
24-
* Environment variable
25-
* File containing the password
26-
2721
```
2822
Usage: imagetool update [OPTIONS]
2923
Update WebLogic Docker image with selected patches
3024
3125
```
3226
| Parameter | Definition | Default |
3327
| --- | --- | --- |
34-
| `--fromImage` | (Required) Container image to be updated. The `fromImage` option serves as a starting point for the new image to be created. | `weblogic:12.2.1.3.0` |
28+
| `--fromImage` | (Required) Container image to be updated. The `fromImage` option serves as a starting point for the new image to be created. | |
3529
| `--tag` | (Required) Tag for the final build image. Example: `store/oracle/weblogic:12.2.1.3.0` | |
36-
| `--additionalBuildCommands` | Path to a file with additional build commands. For more details, see [Additional information](#additional-information). |
37-
| `--additionalBuildFiles` | Additional files that are required by your `additionalBuildCommands`. A comma separated list of files that should be copied to the build context. |
30+
| `--additionalBuildCommands` | Path to a file with additional build commands. For more details, see [Additional information](#--additionalbuildcommands). |
31+
| `--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](#--additionalbuildfiles). |
3832
| `--builder`, `-b` | Executable to process the Dockerfile. Use the full path of the executable if not on your path. | `docker` |
3933
| `--buildNetwork` | Networking mode for the RUN instructions during the image build. See `--network` for Docker `build`. | |
4034
| `--chown` | `userid:groupid` for JDK/Middleware installs and patches. | `oracle:oracle` |
4135
| `--dryRun` | Skip Docker build execution and print the Dockerfile to stdout. | |
4236
| `--httpProxyUrl` | Proxy for the HTTP protocol. Example: `http://myproxy:80` or `http:user:passwd@myproxy:8080` | |
4337
| `--httpsProxyUrl` | Proxy for the HTTPS protocol. Example: `https://myproxy:80` or `https:user:passwd@myproxy:8080` | |
44-
| `--latestPSU` | (DEPRECATED) Find and apply the latest PatchSet Update, see [Additional information](#additional-information). | |
38+
| `--latestPSU` | (DEPRECATED) Find and apply the latest PatchSet Update, see [Additional information](#--latestpsu). | |
4539
| `--opatchBugNumber` | The patch number for OPatch (patching OPatch). | `28186730` |
4640
| `--password` | Request password for the Oracle Support `--user` on STDIN, see `--user`. | |
4741
| `--passwordEnv` | Environment variable containing the Oracle Support password, see `--user`. | |
4842
| `--passwordFile` | Path to a file containing just the Oracle Support password, see `--user`. | |
4943
| `--patches` | Comma separated list of patch IDs. Example: `12345678,87654321` | |
5044
| `--pull` | Always attempt to pull a newer version of base images during the build. | |
45+
| `--recommendedPatches` | (DEPRECATED) Find and apply the latest PatchSet Update and recommended patches. This takes precedence over `--latestPSU`. See [Additional information](#--recommendedpatches). | |
5146
| `--resourceTemplates` | One or more files containing placeholders that need to be resolved by the Image Tool. See [Resource Template Files](#resource-template-files). | |
5247
| `--skipcleanup` | Do not delete the build context folder, intermediate images, and failed build containers. For debugging purposes. | |
5348
| `--strictPatchOrdering` | Instruct OPatch to apply patches one at a time (uses `apply` instead of `napply`). | |
54-
| `--target` | Select the target environment in which the created image will be used. Supported values: `Default` (Docker/Kubernetes), `OpenShift` | `Default` |
55-
| `--user` | Oracle support email ID. | |
49+
| `--target` | Select the target environment in which the created image will be used. Supported values: `Default` (Docker/Kubernetes), `OpenShift`. See [Additional information](#--target). | `Default` |
50+
| `--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`.   | |
5651
| `--wdtArchive` | A WDT archive ZIP file or comma-separated list of files. | |
5752
| `--wdtDomainHome` | Path to the `-domain_home` for WDT. | `/u01/domains/base_domain` |
5853
| `--wdtDomainType` | WDT domain type. Supported values: `WLS`, `JRF`, `RestrictedJRF` | `WLS` |
@@ -118,9 +113,15 @@ the `after-fmw-install` or `before-wdt-command` sections.
118113

119114
#### `--latestPSU`
120115

121-
The `latestPSU` option will continue to be supported for the CREATE option, but has been deprecated for use in the
116+
The `latestPSU` option will continue to be supported for the CREATE and REBASE option, but has been deprecated for use in the
122117
UPDATE option. Because of the number of patches and their size, using `latestPSU` as an update to an existing image can
123-
increase the size of the image significantly, and is not recommended.
118+
increase the size of the image _significantly_, and is not recommended.
119+
120+
#### `--recommendedPatches`
121+
122+
The `recommendedPatches` option will continue to be supported for the CREATE and REBASE option, but has been deprecated for use in the
123+
UPDATE option. Because of the number of patches and their size, using `recommendedPatches` as an update to an existing image can
124+
increase the size of the image _significantly_, and is not recommended.
124125

125126
#### `--target`
126127

0 commit comments

Comments
 (0)
Please sign in to comment.