Skip to content

Commit a2abe5d

Browse files
rosemarymaranorosemarymarano
committed
first pass at content reorg
1 parent 1faea10 commit a2abe5d

21 files changed

+318
-212
lines changed

‎documentation/1.9/content/_index.md‎

Lines changed: 49 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,109 +1,59 @@
11
# WebLogic Image Tool
22

3-
**NOTE: The upcoming change to Oracle Support's recommended patches list will require
4-
Image Tool 1.9.11 in order to use `--recommendedPatches` or `--latestPSU`.**
5-
63
Oracle is finding ways for organizations using WebLogic Server to run important workloads, to move those workloads into
74
the cloud, and to simplify and speed up the application deployment life cycle. By adopting industry standards, such as Docker
85
and Kubernetes, WebLogic now runs in a cloud neutral infrastructure. To help simplify and automate the creation of
9-
Docker images for WebLogic Server, we are providing this open source
10-
WebLogic Image Tool. This tool let's you create a new Linux based image, with installations of a JDK and WebLogic Server,
11-
and optionally, configure a WebLogic domain with your applications, apply WebLogic Server patches, or update an existing
12-
image.
13-
14-
## Features
15-
16-
The Image Tool provides three functions within the main script:
17-
- [Create Image]({{< relref "/create-image.md" >}}) - The `create` command creates a new Docker image and installs the requested
18-
Java and WebLogic software. Additionally, you can create a WebLogic domain in the image at the same time.
19-
- [Rebase Image]({{< relref "/rebase-image.md" >}}) - The `rebase` command creates a new Docker image using an existing WebLogic
20-
domain from an existing image. The new Docker image can start from an existing image with a JDK and Oracle
21-
middleware installation, or can install the JDK and Oracle Home as part of moving the domain.
22-
- [Update Image]({{< relref "/update-image.md" >}}) - The `update` command creates a new Docker image by applying WebLogic patches
23-
to an existing image. Additionally, you can create a WebLogic domain if one did not exist previously, update an
24-
an existing domain, or deploy an application.
25-
- [Cache]({{< relref "/cache.md" >}}) - The Image Tool maintains metadata on the local file system for patches and installers.
26-
The `cache` command can be used to manipulate the local metadata.
27-
28-
## Prerequisites
29-
30-
- Docker client and daemon on the build machine, with minimum Docker version 18.03.1.ce.
31-
- Installers for WebLogic Server and JDK from the [Oracle Software Delivery Cloud](https://edelivery.oracle.com).
32-
- For patches, [Oracle Support](https://www.oracle.com/technical-resources/) credentials.
33-
- Bash version 4.0 or later, to enable the `<tab>` command complete feature.
34-
35-
## Setup
36-
37-
- Build the project (`mvn clean package`) to create the ZIP installer in `./imagetool/target`.
38-
- Unzip the release ZIP file to a desired location.
39-
- For Linux environment, `cd your_unzipped_location/bin` and `source setup.sh`.
40-
- For Windows environment, `cd your_unzipped_location\bin` and `.\imagetool.cmd`.
41-
- Run `imagetool help` to show the help text.
42-
43-
## Quick Start
44-
45-
Use the [Quick Start]({{< relref "/quickstart.md" >}}) guide to create a Linux based WebLogic Docker image.
46-
47-
## Building From Source
48-
49-
The Image Tool installer is available for download on the [Releases](https://github.com/oracle/weblogic-image-tool/releases) page.
50-
If you want to build the installer from source instead of downloading it, follow these instructions:
51-
- Download and install JDK 8u261+
52-
- Download and install Maven 3.6.3+
53-
- Clone this repository to your local environment using one of the options under `Code` near the top of this page.
54-
- From inside the top-level directory of the cloned project, `weblogic-image-tool`, using Maven, execute one or
55-
more of these phases:
56-
- `validate` - Validate the project is correct and all necessary information is available.
57-
- `compile` - Compile the source code.
58-
- `test` - Test the compiled source code using the JUnit5 framework.
59-
- `package` - Create the installer ZIP file, `imagetool.zip`.
60-
- `verify` - Run integration tests using the JUnit5 framework (Pre-requisite: Docker installed).
61-
- `clean` - Restore the source by removing any items created by `package` or another phase of the build.
62-
63-
**Note:** Maven executes build phases sequentially, `validate`, `compile`, `test`, `package`, `verify`, such that
64-
running `verify` will run all of these phases from `validate` through `package` before executing `verify`.
65-
66-
Because the `package` phase comes before the `verify` phase, it is not necessary to run the integration tests to create
67-
the Image Tool installer. If you are making changes and want to validate those changes in your environment, you will
68-
need to do some additional setup before running the `verify` phase because several of the integration tests require
69-
access to the Oracle Technology Network. To run the integration tests in the
70-
`verify` phase, you must specify three environment variables, `ORACLE_SUPPORT_USERNAME`, `ORACLE_SUPPORT_PASSWORD`,
71-
and `STAGING_DIR`. The first two, Oracle Support user name and password, are used to connect to Oracle OTN for patches.
72-
The third, `STAGING_DIR`, should be a local folder where WebLogic Server installers, JDK installers, and pre-downloaded
73-
patches can be found. The files required in the `STAGING_DIR` depend on which tests that you want to run.
74-
75-
Example: Run a set of integration tests (available groups are `cache`, `gate`, and `nightly`:
76-
```shell script
77-
mvn verify -Dtest.groups=cache
78-
```
79-
80-
Example: Run a single integration test:
81-
```shell script
82-
mvn verify -Dtest.groups=gate,nightly -Dit.test=ITImagetool#createWlsImg
83-
```
84-
85-
Integration Test groups:
86-
- `cache` - Tests that build and manipulate the Image Tool cache.
87-
- `gate` - A basic set of integration tests that are used to validate merge requests, including building several
88-
Docker image (~20 minutes)
89-
- `nightly` - The full set of integration tests building various Docker images including JRF and WLS
90-
installations (~2 hours)
91-
92-
**Note:** In order to run an integration test that builds an image like `createWlsImg`, you must run the `cache`
93-
group first in order to populate the cache with the WLS and JDK installers.
94-
95-
## Samples
96-
97-
* [Create an image with full Internet access]({{< relref "/create-image-with-internet.md" >}})
98-
* [Create an image with no Internet access]({{< relref "/create-image-no-internet.md" >}})
99-
* [Patch an existing image]({{< relref "/patching-image.md" >}})
100-
* [Create an image with a WebLogic domain using the WebLogic Deploy Tool]({{< relref "/create-image-wdt.md" >}})
6+
container images for WebLogic Server, we are providing this open source WebLogic Image Tool (WIT).
7+
8+
WIT let's you create a new Linux based image, with installations of a JDK and WebLogic Server, and optionally,
9+
configure a WebLogic domain with your applications, apply WebLogic Server patches, or update an existing image.
10+
11+
12+
With the Image Tool you can:
13+
14+
* Create a Docker image and install the requested Java and WebLogic software. And, you can create a
15+
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
17+
image can start from an existing image with a JDK and Oracle middleware installation, or can install
18+
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.
21+
22+
For detailed information, see [Image Tool]({{< relref "/userguide/tools/_index.md" >}}).
23+
24+
***
25+
### Current production release
26+
27+
WebLogic Image Tool version and release information can be found [here](https://github.com/oracle/weblogic-image-tool/releases).
28+
29+
***
30+
### Recent changes and known issues
31+
32+
See the [Release Notes]({{< relref "/release-notes.md" >}}) for known issues and workarounds.
33+
34+
35+
### About this documentation
36+
37+
* Use the [Quick Start]({{< relref "/quickstart/quickstart.md" >}}) guide to create a Linux based WebLogic Docker image.
38+
* The [User Guide]({{< relref "/userguide/" >}}) contains installation prerequisites, setup information, command options, and detailed usage information.
39+
* The [Samples]({{< relref "/samples/" >}}) provide informative use case scenarios.
40+
* The [Developer Guide]({{< relref "/developer/" >}}) provides details for people who want to understand how WIT is built.
41+
42+
43+
### Related projects
44+
45+
* [WebLogic Kubernetes Operator](https://oracle.github.io/weblogic-kubernetes-operator/)
46+
* [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/)
47+
* [WebLogic Monitoring Exporter](https://github.com/oracle/weblogic-monitoring-exporter)
48+
* [WebLogic Logging Exporter](https://github.com/oracle/weblogic-logging-exporter)
49+
* [WebLogic Remote Console](https://github.com/oracle/weblogic-remote-console)
50+
51+
### Contributing
52+
Those who wish to contribute to the WebLogic Image Tool code will find useful information [here](https://github.com/oracle/weblogic-image-tool/blob/main/CONTRIBUTING.md).
53+
54+
10155

10256
## Additional tasks
10357

10458
* [Cleanup]({{< relref "/cleanup.md" >}})
10559
* [Logging]({{< relref "/logging.md" >}})
106-
107-
108-
## Copyright
109-
Copyright (c) 2019, 2021, Oracle and/or its affiliates.

‎documentation/1.9/content/developer/_index.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
+++
2+
title = "Developer Guide"
3+
date = 2019-02-22T15:27:54-05:00
4+
weight = 4
5+
chapter = true
6+
pre = "<b>4. </b>"
7+
+++
8+
9+
# Developer Guide
10+
11+
The Developer Guide provides information for developers who want to build the installer from source or contribute to the code.

‎documentation/1.9/content/developer/build.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: "Build From Source"
3+
date: 2019-02-23T17:19:24-05:00
4+
draft: false
5+
weight: 1
6+
---
7+
8+
9+
The Image Tool installer is available for download on the [Releases](https://github.com/oracle/weblogic-image-tool/releases) page.
10+
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
15+
more of these phases:
16+
- `validate` - Validate the project is correct and all necessary information is available.
17+
- `compile` - Compile the source code.
18+
- `test` - Test the compiled source code using the JUnit5 framework.
19+
- `package` - Create the installer ZIP file, `imagetool.zip`.
20+
- `verify` - Run integration tests using the JUnit5 framework (Pre-requisite: Docker installed).
21+
- `clean` - Restore the source by removing any items created by `package` or another phase of the build.
22+
23+
**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`.
25+
26+
Because the `package` phase comes before the `verify` phase, it is not necessary to run the integration tests to create
27+
the Image Tool installer. If you are making changes and want to validate those changes in your environment, you will
28+
need to do some additional setup before running the `verify` phase because several of the integration tests require
29+
access to the Oracle Technology Network. To run the integration tests in the
30+
`verify` phase, you must specify three environment variables, `ORACLE_SUPPORT_USERNAME`, `ORACLE_SUPPORT_PASSWORD`,
31+
and `STAGING_DIR`. The first two, Oracle Support user name and password, are used to connect to Oracle OTN for patches.
32+
The third, `STAGING_DIR`, should be a local folder where WebLogic Server installers, JDK installers, and pre-downloaded
33+
patches can be found. The files required in the `STAGING_DIR` depend on which tests that you want to run.
34+
35+
Example: Run a set of integration tests (available groups are `cache`, `gate`, and `nightly`:
36+
```shell script
37+
mvn verify -Dtest.groups=cache
38+
```
39+
40+
Example: Run a single integration test:
41+
```shell script
42+
mvn verify -Dtest.groups=gate,nightly -Dit.test=ITImagetool#createWlsImg
43+
```
44+
45+
Integration Test groups:
46+
- `cache` - Tests that build and manipulate the Image Tool cache.
47+
- `gate` - A basic set of integration tests that are used to validate merge requests, including building several
48+
Docker image (~20 minutes)
49+
- `nightly` - The full set of integration tests building various Docker images including JRF and WLS
50+
installations (~2 hours)
51+
52+
**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.

‎documentation/1.9/content/quickstart/_index.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
+++
2+
title = "Quick Start"
3+
date = 2019-02-22T15:27:54-05:00
4+
weight = 1
5+
chapter = true
6+
pre = "<b>1. </b>"
7+
+++
8+
9+
# Quick Start Guide
10+
11+
Use this Quick Start guide to create a Linux based WebLogic Docker image.

‎documentation/1.9/content/quickstart.md‎ renamed to ‎documentation/1.9/content/quickstart/quickstart.md‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
1-
# Quick Start
1+
---
2+
title: "Steps"
3+
date: 2019-02-23T17:19:24-05:00
4+
draft: false
5+
weight: 1
6+
---
27

3-
Use this Quick Start guide to create a Linux based WebLogic Docker image.
48

5-
## Before you begin
9+
#### Before you begin
610

7-
Make sure that you have fulfilled the [Prerequisites]({{< relref "/_index.md#prerequisites" >}}) and [Setup]({{< relref "/_index.md#setup" >}}) requirements listed for the [Image Tool]({{< relref "/_index.md" >}}).
11+
Make sure that you have fulfilled the [Prerequisites]({{< relref "/userguide/prerequisites.md" >}}) and [Setup]({{< relref "/userguide/setup.md" >}}) requirements.
812

9-
## Overview
13+
#### Overview
1014

1115
The high level steps for creating an image are:
1216

1317
1. Download the Java and WebLogic installers from the [Oracle Software Delivery Cloud](https://edelivery.oracle.com).
1418
2. Add the installers to the cache store.
1519
3. Run the ```imagetool``` command to create the image.
1620

17-
## Steps
21+
#### Do this
1822

1923
1. Download these Java and WebLogic installers from the [Oracle Software Delivery Cloud](https://edelivery.oracle.com)
2024
and save them in a directory of your choice, for example, `/home/acmeuser/wls-installers`:
@@ -23,7 +27,7 @@ and save them in a directory of your choice, for example, `/home/acmeuser/wls-in
2327
`jdk-8u202-linux-x64.tar.gz`
2428

2529

26-
2. Use the [Cache Tool](cache.md) to add the installers:
30+
2. Use the [Cache Tool]({{< relref "/userguide/tools/cache.md" >}}) to add the installers:
2731

2832
```bash
2933
imagetool cache addInstaller --type jdk --version 8u202 --path /home/acmeuser/wls-installers/jdk-8u202-linux-x64.tar.gz
@@ -61,8 +65,3 @@ drwxr-xr-x 11 oracle oracle 4096 May 28 23:40 oracle
6165
drwxr-xr-x 5 oracle oracle 4096 May 28 23:40 .
6266
drwxr-xr-x 18 root root 4096 May 29 01:31 ..
6367
```
64-
65-
66-
67-
## Copyright
68-
Copyright (c) 2019, 2021, Oracle and/or its affiliates.

‎documentation/1.9/content/release-notes.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Release Notes
2+
3+
The upcoming change to Oracle Support's recommended patches list will require
4+
WebLogic Image Tool 1.9.11 in order to use the `--recommendedPatches` or `--latestPSU` flags.

‎documentation/1.9/content/samples/_index.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
+++
2+
title = "Samples"
3+
date = 2019-02-22T15:27:54-05:00
4+
weight = 3
5+
chapter = true
6+
pre = "<b>3. </b>"
7+
+++
8+
9+
# Samples

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
# Create an image without Internet access
1+
---
2+
title: "Create an image without Internet access"
3+
date: 2019-02-23T17:19:24-05:00
4+
draft: false
5+
weight: 2
6+
---
27

38

49
In this use case, because there is no Internet access, you will need to download all the installers and
@@ -10,7 +15,7 @@ tar
1015
unzip
1116
```
1217

13-
## Steps
18+
### Steps
1419

1520
1. Download these Java and WebLogic installers from the [Oracle Software Delivery Cloud](https://edelivery.oracle.com)
1621
and save them in a directory of your choice, for example, `/home/acmeuser/wls-installers`:
@@ -19,7 +24,7 @@ and save them in a directory of your choice, for example, `/home/acmeuser/wls-in
1924
`jdk-8u202-linux-x64.tar.gz`
2025

2126

22-
2. Use the [Cache Tool](cache.md) to add the installers:
27+
2. Use the [Cache Tool]({{< relref "/userguide/tools/cache.md" >}}) to add the installers:
2328

2429
```bash
2530
imagetool cache addInstaller --type jdk --version 8u202 --path /home/acmeuser/wls-installers/jdk-8u202-linux-x64.tar.gz
@@ -52,6 +57,3 @@ and save them in a directory of your choice, for example, `/home/acmeuser/wls-in
5257
```bash
5358
imagetool cache addPatch --patchId 28186730_13.9.4.0.0 --path /home/acmeuser/cache/p28186730_139400_Generic.zip
5459
```
55-
56-
## Copyright
57-
Copyright (c) 2019, 2021, Oracle and/or its affiliates.

‎documentation/1.9/content/create-image-wdt.md‎ renamed to ‎documentation/1.9/content/samples/create-image-wdt.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1-
# Create an image with a WebLogic domain using the WebLogic Deploy Tool
1+
---
2+
title: "Create an image with a WebLogic domain using WDT"
3+
date: 2019-02-23T17:19:24-05:00
4+
draft: false
5+
weight: 4
6+
---
27

3-
The Image Tool lets you create a customized WebLogic domain in the image using the [WebLogic Deploy Tool](https://github.com/oracle/weblogic-deploy-tooling).
8+
The Image Tool lets you create a customized WebLogic domain in the image using the [WebLogic Deploy Tool](https://oracle.github.io/weblogic-deploy-tooling/).
49

5-
## Steps
10+
### Steps
611

7-
1. Create the image, as directed in the [Quick Start](quickstart.md) guide.
12+
1. Create the image, as directed in the [Quick Start]({{< relref "/quickstart/quickstart.md" >}}) guide.
813

914
2. Download the [WebLogic Deploy Tool](https://github.com/oracle/weblogic-deploy-tooling/releases), and then add it to the cache store:
1015

@@ -35,6 +40,3 @@ The parameter mappings between the Image Tool and the WebLogic Deploy Tool are:
3540
**Note**: If you are creating a JRF domain and want WebLogic Deploy Tool to create the RCU schemas for you, you can
3641
specify the connection information in the model. See [Specifying RCU
3742
information in the model](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/rcuinfo.md).
38-
39-
## Copyright
40-
Copyright (c) 2019, 2021, Oracle and/or its affiliates.

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

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Create an image with full Internet access
1+
---
2+
title: "Create an image with full Internet access"
3+
date: 2019-02-23T17:19:24-05:00
4+
draft: false
5+
weight: 1
6+
---
7+
28

39
The Image Tool supports creating Linux based WebLogic Docker images, applying WebLogic patches, and creating WebLogic domains. It can be used with or without Internet access.
410

@@ -8,7 +14,7 @@ In this use case, the Image Tool will:
814
2. Update the image with the necessary packages for installing WebLogic Server.
915
3. Install Java and WebLogic Server.
1016

11-
## Steps
17+
### Steps
1218

1319
1. Download these Java and WebLogic installers from the [Oracle Software Delivery Cloud](https://edelivery.oracle.com)
1420
and save them in a directory of your choice, for example, `/home/acmeuser/wls-installers`:
@@ -17,7 +23,7 @@ and save them in a directory of your choice, for example, `/home/acmeuser/wls-in
1723
`jdk-8u202-linux-x64.tar.gz`
1824

1925

20-
2. Use the [Cache Tool](cache.md) to add the installers:
26+
2. Use the [Cache Tool]({{< relref "/userguide/tools/cache.md" >}}) to add the installers:
2127

2228
```bash
2329
imagetool cache addInstaller --type jdk --version 8u202 --path /home/acmeuser/wls-installers/jdk-8u202-linux-x64.tar.gz
@@ -73,5 +79,3 @@ wls 12.2.1.3.0 18d366fc3da4 About a mi
7379
ghcr.io/oracle/oraclelinux 7-slim f7512ac13c1b 6 weeks ago 118MB
7480
7581
```
76-
## Copyright
77-
Copyright (c) 2019, 2021, Oracle and/or its affiliates.

0 commit comments

Comments
 (0)