Skip to content

Commit 0a000a8

Browse files
second pass
1 parent 37cada6 commit 0a000a8

File tree

14 files changed

+66
-62
lines changed

14 files changed

+66
-62
lines changed

documentation/1.9/content/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ With the Image Tool you can:
1313

1414
* Create a Docker image and install the requested Java and WebLogic software. And, you can create a
1515
WebLogic domain in the image, at the same time.
16-
* Create a new Docker image using an existing WebLogic domain from an existing image. The new Docker
16+
* Create a new Docker image using an existing WebLogic domain from an existing image. The Docker
1717
image can start from an existing image with a JDK and Oracle middleware installation, or can install
1818
the JDK and Oracle Home as part of moving the domain.
19-
* Create a new Docker image by applying WebLogic patches to an existing image. In addition, you can
20-
create a WebLogic domain if one did not exist previously, update an existing domain, or deploy an application.
19+
* Create a new Docker image by applying WebLogic patches to an existing image. In addition,
20+
if one did not exist previously, you can create a WebLogic domain, update an existing domain, or deploy an application.
2121

2222
For detailed information, see [Image Tool]({{< relref "/userguide/tools/_index.md" >}}).
2323

documentation/1.9/content/developer/build.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ weight: 1
88

99
The Image Tool installer is available for download on the [Releases](https://github.com/oracle/weblogic-image-tool/releases) page.
1010
If you want to build the installer from source instead of downloading it, follow these instructions:
11-
- Download and install JDK 8u261+
12-
- Download and install Maven 3.6.3+
13-
- Clone this repository to your local environment using one of the options under `Code` near the top of this page.
14-
- From inside the top-level directory of the cloned project, `weblogic-image-tool`, using Maven, execute one or
11+
1. Download and install JDK 8u261+
12+
1. Download and install Maven 3.6.3+
13+
1. Clone [this](https://github.com/oracle/weblogic-image-tool) repository to your local environment using one of the options under `Code` near the top of this page.
14+
1. From inside the top-level directory of the cloned project, `weblogic-image-tool`, using Maven, execute one or
1515
more of these phases:
1616
- `validate` - Validate the project is correct and all necessary information is available.
1717
- `compile` - Compile the source code.
1818
- `test` - Test the compiled source code using the JUnit5 framework.
1919
- `package` - Create the installer ZIP file, `imagetool.zip`.
20-
- `verify` - Run integration tests using the JUnit5 framework (Pre-requisite: Docker installed).
20+
- `verify` - Run integration tests using the JUnit5 framework (Prerequisite: Docker installed).
2121
- `clean` - Restore the source by removing any items created by `package` or another phase of the build.
2222

2323
**Note:** Maven executes build phases sequentially, `validate`, `compile`, `test`, `package`, `verify`, such that
24-
running `verify` will run all of these phases from `validate` through `package` before executing `verify`.
24+
running `verify` will run all of these phases from `validate` through `package` before running `verify`.
2525

2626
Because the `package` phase comes before the `verify` phase, it is not necessary to run the integration tests to create
2727
the Image Tool installer. If you are making changes and want to validate those changes in your environment, you will
@@ -32,22 +32,22 @@ and `STAGING_DIR`. The first two, Oracle Support user name and password, are us
3232
The third, `STAGING_DIR`, should be a local folder where WebLogic Server installers, JDK installers, and pre-downloaded
3333
patches can be found. The files required in the `STAGING_DIR` depend on which tests that you want to run.
3434

35-
Example: Run a set of integration tests (available groups are `cache`, `gate`, and `nightly`:
35+
**Example**: Run a set of integration tests (available groups are `cache`, `gate`, and `nightly`:
3636
```shell script
3737
mvn verify -Dtest.groups=cache
3838
```
3939

40-
Example: Run a single integration test:
40+
**Example**: Run a single integration test:
4141
```shell script
4242
mvn verify -Dtest.groups=gate,nightly -Dit.test=ITImagetool#createWlsImg
4343
```
4444

4545
Integration Test groups:
4646
- `cache` - Tests that build and manipulate the Image Tool cache.
4747
- `gate` - A basic set of integration tests that are used to validate merge requests, including building several
48-
Docker image (~20 minutes)
48+
Docker image (~20 minutes).
4949
- `nightly` - The full set of integration tests building various Docker images including JRF and WLS
50-
installations (~2 hours)
50+
installations (~2 hours).
5151

5252
**Note:** In order to run an integration test that builds an image like `createWlsImg`, you must run the `cache`
53-
group first in order to populate the cache with the WLS and JDK installers.
53+
group first to populate the cache with the WLS and JDK installers.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Release Notes
22

3-
The upcoming change to Oracle Support's recommended patches list will require
3+
* The upcoming change to Oracle Support's recommended patches list will require
44
WebLogic Image Tool 1.9.11 in order to use the `--recommendedPatches` or `--latestPSU` flags.

documentation/1.9/content/samples/create-image-no-internet.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,12 @@ weight: 2
77

88

99
In this use case, because there is no Internet access, you will need to download all the installers and
10-
patches, plus set up the cache. Also, you must provide a base operating system image that has the following packages installed.
10+
patches, plus set up the cache. Also, you must provide a base operating system image that has the following packages installed:
11+
12+
* `gzip`
13+
* `tar`
14+
* `unzip`
1115

12-
```bash
13-
gzip
14-
tar
15-
unzip
16-
```
1716

1817
### Steps
1918

@@ -38,17 +37,17 @@ and save them in a directory of your choice, for example, `/home/acmeuser/wls-in
3837

3938
For example, if you download patch number `27342434` for WebLogic Server version 12.2.1.3.0:
4039

41-
```bash
42-
imagetool cache addPatch --patchId 27342434_12.2.1.3.0 --path /home/acmeuser/cache/p27342434_122130_Generic.zip
43-
```
40+
```bash
41+
imagetool cache addPatch --patchId 27342434_12.2.1.3.0 --path /home/acmeuser/cache/p27342434_122130_Generic.zip
42+
```
4443

45-
**Note**: Refer to the [Cache](cache.md) commands for the format of ```patchId```.
44+
**Note**: Refer to the [Cache]({{< relref "/userguide/tools/cache.md" >}}) commands for the format of ```patchId```.
4645

4746
4. Then, run the command to create the image:
4847

49-
```bash
50-
imagetool create --fromImage myosimg:latest --tag wls:12.2.1.3.0 --patches 27342434 --version 12.2.1.3.0
51-
```
48+
```bash
49+
imagetool create --fromImage myosimg:latest --tag wls:12.2.1.3.0 --patches 27342434 --version 12.2.1.3.0
50+
```
5251

5352
5. Occasionally, a WebLogic Server patch will require patching the OPatch binaries before applying them. We recommend downloading the latest OPatch patch and setting up the cache.
5453

documentation/1.9/content/samples/create-image-wdt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Create an image with a WebLogic domain using WDT"
2+
title: "Create an image with a WLS domain using WDT"
33
date: 2019-02-23T17:19:24-05:00
44
draft: false
55
weight: 4

documentation/1.9/content/samples/create-image-with-internet.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ and save them in a directory of your choice, for example, `/home/acmeuser/wls-in
3535

3636
**Note**: The value of the version must be a valid WebLogic Server version number. This version number is used to verify and find the correct patch file to download from Oracle Support. The format of the version is a 5 digits tuple, separated by period. For example, ```12.2.1.3.0``` ```12.1.3.0.0```
3737

38-
3. Create the image using the [Create Tool](create-image.md) commands. For example:
38+
3. Create the image using the [Create Tool]({{< relref "/userguide/tools/create-image.md" >}}) commands. For example:
3939

4040
```bash
4141
imagetool create --tag wls:12.2.1.3.0 --latestPSU --version 12.2.1.3.0 --user username@mycompany.com --passwordEnv MYPWD
@@ -45,9 +45,9 @@ and save them in a directory of your choice, for example, `/home/acmeuser/wls-in
4545

4646
**NOTE**: You can provide the password in one of three ways:
4747

48-
* Read from STDIN --password
49-
* Environment variable --passwordEnv
50-
* File containing the password --passwordFile
48+
* Read from STDIN `--password`
49+
* Environment variable `--passwordEnv`
50+
* File containing the password `--passwordFile`
5151

5252

5353
You will see the Docker command output as the tool runs:

documentation/1.9/content/samples/patching-image.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ You can download patches using the Image Tool or by manually downloading them.
1616

1717
For example, to download patch number `27342434` for WebLogic Server version 12.2.1.3.0:
1818

19-
```bash
20-
imagetool cache addPatch --patchId 27342434_12.2.1.3.0 --path /home/acmeuser/cache/p27342434_122130_Generic.zip
21-
```
19+
```bash
20+
imagetool cache addPatch --patchId 27342434_12.2.1.3.0 --path /home/acmeuser/cache/p27342434_122130_Generic.zip
21+
```
2222

23-
**Note**: Refer to the [Cache](cache.md) commands for the format of ```patchId```.
23+
**Note**: Refer to the [Cache]({{< relref "/userguide/tools/cache.md" >}}) commands for the format of ```patchId```.
2424

2525
3. Use the [`imagetool update`]({{< relref "/userguide/tools/update-image.md" >}}) command to update the image:
2626

27-
```bash
28-
imagetool update --fromImage wls:12.2.1.3.0 --tag wls:12.2.1.3.4 --patches 27342434
29-
```
27+
```bash
28+
imagetool update --fromImage wls:12.2.1.3.0 --tag wls:12.2.1.3.4 --patches 27342434
29+
```

documentation/1.9/content/userguide/prerequisites.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ draft: false
55
weight: 1
66
---
77

8-
- Docker client and daemon on the build machine, with minimum Docker version 18.03.1.ce.
8+
- Docker client and daemon on the build machine, with a minimum Docker version 18.03.1.ce.
99
- OPTIONALLY: Podman 3.x may be used in place of Docker.
1010
- Installers for WebLogic Server and JDK from the [Oracle Software Delivery Cloud](https://edelivery.oracle.com).
1111
- When using any of the patching options, `--patches`, `--recommendedPatches`, or `--latestPSU`, you will need to provide [Oracle Support](https://www.oracle.com/technical-resources/) credentials.

documentation/1.9/content/userguide/setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ draft: false
55
weight: 2
66
---
77

8-
- Download and unzip the release ZIP file to a desired location.
8+
- Download and unzip the WIT release ZIP file to a desired location.
99
- OPTIONALLY: You may build the project (`mvn clean package`) to create the ZIP installer in `./imagetool/target`.
1010
- Set the JAVA_HOME environment variable to the location of the Java install (see [Prerequisites]({{< relref "/userguide/prerequisites.md" >}})).

documentation/1.9/content/userguide/tools/_index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,5 @@ weight = 3
55
pre = "<b> </b>"
66
+++
77

8-
- [Create Image]({{< relref "/userguide/tools/create-image.md" >}}): The `create` command creates a new Docker image and installs the requested Java and WebLogic software. In addition, you can create a WebLogic domain in the image at the same time.
9-
- [Rebase Image]({{< relref "/userguide/tools/rebase-image.md" >}}): The `rebase` command creates a new Docker image using an existing WebLogic domain from an existing image. The new Docker image can start from an existing image with a JDK and Oracle middleware installation, or can install the JDK and Oracle Home as part of moving the domain.
10-
- [Update Image]({{< relref "/userguide/tools/update-image.md" >}}): The `update` command creates a new Docker image by applying WebLogic patches to an existing image. In addition, you can create a WebLogic domain if one did not exist previously, update an existing domain, or deploy an application.
11-
- [Cache]({{< relref "/userguide/tools/cache.md" >}}): The Image Tool maintains metadata on the local file system for patches and installers. You can use the `cache` command to manipulate the local metadata.
8+
9+
{{% children style="h4" description="true" %}}

0 commit comments

Comments
 (0)