Skip to content

Commit e690dae

Browse files
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

Lines changed: 8 additions & 8 deletions
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

Lines changed: 5 additions & 5 deletions
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

Lines changed: 3 additions & 3 deletions
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

Lines changed: 5 additions & 5 deletions
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

0 commit comments

Comments
 (0)