Skip to content

Commit 4378bd2

Browse files
authored
[skip-ci] clarify documentation on additional build commands file (#210)
1 parent 015e9a3 commit 4378bd2

File tree

3 files changed

+44
-9
lines changed

3 files changed

+44
-9
lines changed

site/create-image.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,21 @@ Usage: imagetool create [OPTIONS]
5353
#### `--additionalBuildCommands`
5454

5555
This is an advanced option that let's you provide additional commands to the Docker build step.
56-
The input for this parameter is a simple text file that contains one or more of the valid sections: `before-jdk-install`, `after-jdk-install`, `before-fmw-install`, `after-fmw-install`, `before-wdt-command`, `after-wdt-command`, `final-build-commands`.
56+
The input for this parameter is a simple text file that contains one or more of the valid sections. Valid sections for create:
57+
58+
| Section | Build Stage | Timing |
59+
| --- | --- | --- |
60+
| `before-jdk-install` | Intermediate (JDK_BUILD) | Before the JDK is installed. |
61+
| `after-jdk-install` | Intermediate (JDK_BUILD) | After the JDK is installed. |
62+
| `before-fmw-install` | Intermediate (WLS_BUILD) | Before the Oracle Home is created. |
63+
| `after-fmw-install` | Intermediate (WLS_BUILD) | After all of the Oracle middleware installers are finished. |
64+
| `before-wdt-command` | Intermediate (WDT_BUILD) | Before WDT is installed. |
65+
| `after-wdt-command` | Intermediate (WDT_BUILD) | After WDT domain creation/update is complete. |
66+
| `final-build-commands` | Final image | After all Image Tool actions are complete, and just before the Docker image is finalized. |
67+
68+
NOTE: Changes made in intermediate stages may not be carried forward to the final image unless copied manually.
69+
The Image Tool will copy the Java Home, Oracle Home, domain home, and WDT home directories to the final image.
70+
Changes fully contained within these directories do not need an additional `COPY` command in the `final-build-commands` section.
5771

5872
Each section can contain one or more valid Dockerfile commands and would look like the following:
5973

site/rebase-image.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,19 @@ Usage: imagetool rebase [OPTIONS]
4444
#### `--additionalBuildCommands`
4545

4646
This is an advanced option that let's you provide additional commands to the Docker build step.
47-
The input for this parameter is a simple text file that contains one or more of the valid sections: `before-jdk-install`, `after-jdk-install`, `before-fmw-install`, `after-fmw-install`, `before-wdt-command`, `after-wdt-command`, `final-build-commands`.
47+
The input for this parameter is a simple text file that contains one or more of the valid sections. Valid sections for rebase:
4848

49+
| Section | Build Stage | Timing |
50+
| --- | --- | --- |
51+
| `before-jdk-install` | Intermediate (JDK_BUILD) | Before the JDK is installed. |
52+
| `after-jdk-install` | Intermediate (JDK_BUILD) | After the JDK is installed. |
53+
| `before-fmw-install` | Intermediate (WLS_BUILD) | Before the Oracle Home is created. |
54+
| `after-fmw-install` | Intermediate (WLS_BUILD) | After all of the Oracle middleware installers are finished. |
55+
| `final-build-commands` | Final image | After all Image Tool actions are complete, and just before the Docker image is finalized. |
56+
57+
NOTE: Changes made in intermediate stages may not be carried forward to the final image unless copied manually.
58+
The Image Tool will copy the Java Home and the Oracle Home directories to the final image.
59+
Changes fully contained within these directories do not need an additional `COPY` command in the `final-build-commands` section.
4960
Each section can contain one or more valid Dockerfile commands and would look like the following:
5061

5162
```dockerfile

site/update-image.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,20 +57,24 @@ Update WebLogic Docker image with selected patches
5757
| `--wdtVersion` | WDT tool version to use. | |
5858

5959
## Additional information
60-
This section provides additional information for command-line parameters requiring more details or clarification.
6160

6261
#### `--additionalBuildCommands`
6362

6463
This is an advanced option that let's you provide additional commands to the Docker build step.
65-
The input for this parameter is a simple text file that contains one or more of the valid sections: `before-jdk-install`, `after-jdk-install`, `before-fmw-install`, `after-fmw-install`, `before-wdt-command`, `after-wdt-command`, `final-build-commands`.
64+
The input for this parameter is a simple text file that contains one or more of the valid sections. Valid sections for update:
6665

67-
Each section can contain one or more valid Dockerfile commands and would look like the following:
66+
| Section | Build Stage | Timing |
67+
| --- | --- | --- |
68+
| `before-wdt-command` | Intermediate (WDT_BUILD) | Before WDT is installed. |
69+
| `after-wdt-command` | Intermediate (WDT_BUILD) | After WDT domain creation/update is complete. |
70+
| `final-build-commands` | Final image | After all Image Tool actions are complete, and just before the Docker image is finalized. |
6871

69-
#### `--latestPSU`
72+
NOTE: Changes made in intermediate stages may not be carried forward to the final image unless copied manually.
73+
The Image Tool will copy the domain home and the WDT home directories to the final image.
74+
Changes fully contained within these directories do not need an additional `COPY` command in the `final-build-commands` section.
7075

71-
The `latestPSU` option will continue to be supported for the CREATE option, but has been deprecated for use in the
72-
UPDATE option. Because of the number of patches and their size, using `latestPSU` as an update to an existing image can
73-
increase the size of the image significantly, and is not recommended.
76+
77+
Each section can contain one or more valid Dockerfile commands and would look like the following:
7478

7579
```dockerfile
7680
[after-fmw-install]
@@ -98,6 +102,12 @@ installation or domain creation steps, use the `final-build-commands` section so
98102
final stage of the image build. Or, if the file needs to change the Oracle Home prior to domain creation, use
99103
the `after-fmw-install` or `before-wdt-command` sections.
100104

105+
#### `--latestPSU`
106+
107+
The `latestPSU` option will continue to be supported for the CREATE option, but has been deprecated for use in the
108+
UPDATE option. Because of the number of patches and their size, using `latestPSU` as an update to an existing image can
109+
increase the size of the image significantly, and is not recommended.
110+
101111
#### Use an argument file
102112

103113
You can save all arguments passed for the Image Tool in a file, then use the file as a parameter.

0 commit comments

Comments
 (0)